diff --git a/.gitignore b/.gitignore index 7b703cdee..cd8403277 100644 --- a/.gitignore +++ b/.gitignore @@ -6,6 +6,7 @@ .history .idea .editorconfig +.cursor # npm yarn node_modules diff --git a/.nvmrc b/.nvmrc index 59ea99ee6..fc9099892 100644 --- a/.nvmrc +++ b/.nvmrc @@ -1 +1 @@ -16.20 +20.19.5 diff --git a/package.json b/package.json index 78e3eace9..1e09be210 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "url": "https://github.com/AdobeDocs/commerce-webapi" }, "dependencies": { - "@adobe/gatsby-theme-aio": "4.15.3", + "@adobe/gatsby-theme-aio": "4.15.5", "gatsby": "4.22.0", "react": "^17.0.2", "react-dom": "^17.0.2" @@ -17,8 +17,8 @@ "remark-frontmatter": "^5.0.0", "remark-heading-id": "^1.0.1", "remark-lint-frontmatter-schema": "^3.15.4", - "remark-validate-links": "^13.0.1", - "spectaql": "^3.0.2" + "remark-validate-links": "13.0.1", + "spectaql": "^3.0.6" }, "scripts": { "start": "NODE_OPTIONS='--max-old-space-size=8192' gatsby build && gatsby serve", @@ -33,6 +33,7 @@ "build:spectaql:2.4.6": "spectaql --target-file index.html --config spectaql/config_2.4.6.yml", "build:spectaql:2.4.7": "spectaql --target-file index.html --config spectaql/config_2.4.7.yml", "build:spectaql:saas": "spectaql --target-file index.html --config spectaql/config_saas.yml", + "build:spectaql:beta": "spectaql --target-file index.html --config spectaql/config_2.4.9-beta-1.yml", "dev:spectaql": "spectaql --development-mode-live --config spectaql/config.yml" }, "packageManager": "yarn@3.2.4" diff --git a/spectaql/comdox-theme/views/partials/layout/content/introduction/welcome.hbs b/spectaql/comdox-theme/views/partials/layout/content/introduction/welcome.hbs new file mode 100644 index 000000000..3627899fe --- /dev/null +++ b/spectaql/comdox-theme/views/partials/layout/content/introduction/welcome.hbs @@ -0,0 +1,65 @@ +
+
+ {{md info.description}} +
+
+ {{#if info.contact}} +
+
Contact
+ {{#if info.contact.name}} +

{{info.contact.name}}

+ {{/if}} + {{#if info.contact.email}} +

{{info.contact.email}}

+ {{/if}} + {{#if info.contact.url}} +

{{info.contact.url}}

+ {{/if}} +
+ {{/if}} + + {{#if info.license}} +
+
License
+ {{#if info.license.name}} +

{{info.license.name}}

+ {{/if}} + {{#if info.license.url}} +

{{info.license.url}}

+ {{/if}} +
+ {{/if}} + + {{#if info.termsOfService}} +
+
Terms of Service
+

{{info.termsOfService}}

+
+ {{/if}} + + {{#if (or url server servers)}} +
+
API Endpoint
+ 
{{generateApiEndpoints}}
+
+ {{/if}} + + {{#if (and servers servers.[0].headers)}} +
+
Headers
+ {{#each servers.[0].headers}} + {{#if comment}} +
{{{comment}}}
+ {{/if}} + {{/each}} +
+ {{/if}} + + {{#if info.version}} +
+
Version
+

{{info.version}}

+
+ {{/if}} +
+
\ No newline at end of file diff --git a/spectaql/config.yml b/spectaql/config.yml index 574933a23..ee951f20f 100644 --- a/spectaql/config.yml +++ b/spectaql/config.yml @@ -391,7 +391,7 @@ servers: headers: - name: Authorization example: Bearer - comment: Your API token from the dashboard. Must be included in all API calls. + comment: For header information, refer to GraphQL headers. info: # Tries to adhere to OpenAPI Specification https://swagger.io/specification/#info-object @@ -409,7 +409,7 @@ info: x-hideWelcome: false # Set to true to not render your intro items # Default: false - x-hideIntroItems: false + x-hideIntroItems: true # Set to true to not render the deprecated label # Default: false @@ -439,8 +439,8 @@ info: # A non-standard array of items to display in your Introduction Area x-introItems: # Can be a Title (for the Nav panel) + URL to simply add a link to somewhere - - title: Back to the GraphQL guide - url: https://developer.adobe.com/commerce/webapi/graphql/reference/ + - title: GraphQL guide + url: https://developer.adobe.com/commerce/webapi/graphql # Can be a Title (for the Nav panel) + description (for the Content panel) # - title: Important thing 1 # description: Some important stuff we wanted you to know. Supports `markdown` diff --git a/spectaql/config_2.4.9-beta-1.yml b/spectaql/config_2.4.9-beta-1.yml new file mode 100644 index 000000000..bd02d3e17 --- /dev/null +++ b/spectaql/config_2.4.9-beta-1.yml @@ -0,0 +1,457 @@ + +# This config will not run "as-is" and will need to be modified. You can see a minimal working +# config in /examples/config.yml +# +# Environment variable substitution will be performed by SpectaQL on all strings encountered + +spectaql: + # Optional Boolean indicating whether to omit the HTML and generate the documentation content only + # Default: false + embeddable: false + + # Optional Boolean indicating whether to embed all resources (CSS and JS) into the same file + # Default: false + oneFile: false + + # Optional path to the target build directory. + # Set to null to not write the output to the filesystem, making it only available via the API (default: public) + # + # Default: public + targetDir: static/graphql-api/2.4.9-beta-1 + + # Optional path to an image to use as the logo in the top-left of the output + # logoFile: path/to/logo.png + # Optional boolean indicating whether to encode the local logoFile and embed the image as Base64 + # into the resulting HTML. Only applicable if providing the logoFile. + # + # Default: false + embedLogo: false + # Optional boolean indicating whether to preserve the filename of the logo provided. + # If false, the logo name will default to "logo" + # preserveLogoName: false + # Optional URL to an image to use in your logo. This string will be provided as-is + # to the HTML output. Should not be used with logoFile and its related options as + # this will take precedence over the logoFile. + # logoUrl: https://yoursite.com/images/logo.png + # Control the height of your logo here. Can be useful if your logo is SVG or an + # inappropriate size. + # + # Default: None; No "height" property will be set on the logo + # logoHeightPx: 18 + + # Optional path to an image to use as a favicon for the site when it's not embedded + # faviconFile: path/to/favicon.png + # Optional boolean indicating whether to encode the local favicon and embed the image as Base64 + # into the resulting HTML. Only applicable if providing the faviconFile. + # + # Default: false + embedFavicon: false + # Optional boolean indicating whether to preserve the filename of the faviconFile provided. + # If false, the favicon name will default to "favicon" + # preserveFaviconName: false + # Optional URL to an image to use in your favicon. This string will be provided as-is + # to the HTML output. Should not be used with faviconFile and its related options as + # this will take precedence over the faviconFile. + # faviconUrl: https://yoursite.com/images/favicon.png + + # Optional string specifying a path to a theme directory to use for your build. + # + # Themes rely on a directory structure convention that overlays your customizations and enhancements + # on top of the default theme provided by SpectaQL. See /examples/themes for more. + # + # Also, a few built-in themes can be used by specifying them by name: + # "default": Our default theme + # "basic": Outputs the same HTML structure as the "default" theme, but with minimal CSS styling + # "spectaql": Outputs the same HTML structure as the "default" theme, but with some CSS enhancements + # + # Default: "default" + # themeDir: path/to/theme + + # If you're embedding SpectaQL's output, and you've got something like a Nav Bar that + # gets in the way, you can use this value to adjust the scroll offset + # + # Default: None; No "scroll-padding-top" style will be applied. + scrollPaddingTopPx: 0 + + # If an interpolated reference is not found, should SpectaQL throw an error? Otherwise, a warning + # will be logged. + # + # Default: true + errorOnInterpolationReferenceNotFound: true + + # Would you like to display all the servers listed in the servers area of your config? Otherwise, + # it will try to display just the one marked "production: true". + # + # Default: false + displayAllServers: false + + # Would you like the "run" function to resolve with an object containing the output as a string? + # Useful if you are using SpectaQL as a dependency (as opposed to running the binary executable) + # + # Default: true + resolveWithOutput: true + +introspection: + ############################################## + # These options specify where/how to get the information required to generate your + # documentation. + # + # Each of these have corresponding CLI options where they can be expressed instead of here. + # The CLI options will take precedence over what is in your config file + # + # 1 and only 1 of the following options must be provided: + # + + # File containing a GraphQL Schema Definition written in SDL. + # Can also pass an array of paths (or glob supported by @graphql-tools/load-files) + # like so: + # schemaFile: + # - path/to/schema/part1.gql + # - path/to/schema/part2.gql + # schemaFile: path/to/schema.gql + + # File containing Introspection Query response in JS module export, or JSON format + introspectionFile: spectaql/schema_2.4.9-beta-1.json + + # URL of the GraphQL endpoint to hit if you want to generate the documentation based on live Introspection Query results + # NOTE: If not using introspection.url OR servers[], you need to provide x-url below + # url: https://yoursite.com/graphql + + # + # + ############################################## + + # If using the "url" option above, any headers (such as Authorization) can be added here. This + # can also be added via the CLI options + # headers: + # Authorization: Bearer s3cretT0k2n + + # Some helpful options for those who are an "SDL-first" shop and/or want to get your metadata into + # SpectaQL during the SDL ingestion. + spectaqlDirective: + # Boolean indicating whether to enable and process the @spectaql directive + # + # Default: true + enable: true + + # String indicating the name to use for the SpectaQL directive, e.g. "@spectaql" + # This should be inconsequential in the end since it should be removed + # from your resulting Schema by SpectaQL + # + # Default: 'spectaql' + directiveName: 'spectaql' + + # String indicating the name to use for the Type used in the "options" array that can be passed + # to the SpectaQL directive. + # This should be inconsequential in the end since it should be removed + # from your resulting Schema by SpectaQL + # + # Default: 'SpectaQLOption' + optionsTypeName: 'SpectaQLOption' + + # + # + ############################################## + + ############################################## + # These options are for random display or augmentation related things that didn't + # really fit anywhere else. + # + + # Whether you would like to strip any trailing commas from the descriptions to keep + # things fresh and clean. + # + # Default: false + removeTrailingPeriodFromDescriptions: false + + # What manipulation of the query/mutation/subscription name would you like to perform to determine + # the name in query examples? Possible values: + # + # - none: will use same exact name as query) + # - capitalizeFirst: will capitalize the first letter and leave the rest. + # - capitalize: will capitalize the first letter and convert the rest to lower case. + # - camelCase + # - snakeCase + # - upperCase: all letters to upper case. + # - lowerCase: all letters to lower case. + queryNameStrategy: none + + # When generating a Query or Mutation example, to what maximum depth should any nested fields + # be represented before a fragment placeholder is rendered? + # + # Default: 1 + fieldExpansionDepth: 1 + + # Include support for @deprecated field on InputType fields. + # NOTE: Be careful, it appears that if you mark an InputType field as deprecated but do NOT set + # this option to `true`, the field will be removed from the schema completely. + # + # Default: false + inputValueDeprecation: false + + # + # + ############################################## + + + ############################################## + # These options specify how, where and if any "metadata" information is to be added to your Introspection + # Query results IF it is not already present. If you are not dealing with metadata, or you have already + # baked it into your Introspection Query results somehow (on the server-side, for example) then you + # can ignore these options completely. + # + + # File that contains your metadata data in JS module export, or JSON format + # metadataFile: path/to/metadata.js[on] + + # The path to a key from which to read the documentation-related metadata at each level of your metadata file. + # Defaults to 'documentation', but in case you use a different name, or have a complex/nested metadata structure, you can + # specify it here. + # + # Default: documentation + # metadatasReadPath: documentation + + # The metadata that was just read from the above key path will be woven into your Introspection Query results. + # This option specifies the key path where that data will be written at each level. + # + # *** + # In order to ensure that the metadata you've written can be found later on down the line, this value + # should be set the same as the "metadatasPath" option below + # *** + # + # Defaults to 'documentation', but in case you have a complex/nested metadata structure, you can + # specify it here. + # + # Default: documentation + # metadatasWritePath: documentation + + # + # + ############################################## + + ############################################## + # These options specify how, where and if any "metadata" information is to be found, or + # used/ignored when processing your documentation. + # + + # The key path in your Introspection Query results where metadata supported by this library can + # be found. + # Defaults to 'documentation', but in case you have a complex/nested metadata structure, you can + # specify it here. + # + # Default: documentation + # metadatasPath: documentation + + # Whether or not to look for and use metadata in your data. If turned off, metadata will be ignored + # even if it's there + # + # Default: true + # metadatas: true + + # + # + ############################################## + + + # This allows you to specify a custom path to a JS module to handle the generation of + # example values for your schema. + # Default: none + # dynamicExamplesProcessingModule: path/to/examples.js + + ############################################## + # These options specify what the default behavior should be + # (regarding documented vs non-documented) in the absence of + # metadata directives on a given item + + # Whether to document any Queries at all, in the absence of a metadata directive + # Default: true + queriesDocumentedDefault: true + # Whether to document an individual Query, in the absence of a metadata directive + # Default: true + queryDocumentedDefault: true + # Whether to document a Query Argument, in the absence of a metadata directive + # Default: true + queryArgDocumentedDefault: true + # Hide any Queries with undocumented return types so as not to reference something + # that seemingly does not exist. + # Default: true + hideQueriesWithUndocumentedReturnType: true + + # Whether to document any Mutations at all, in the absence of a metadata directive + # Default: true + mutationsDocumentedDefault: true + # Whether to document an individual Mutation, in the absence of a metadata directive + # Default: true + mutationDocumentedDefault: true + # Whether to document a Mutation Argument, in the absence of a metadata directive + # Default: true + mutationArgDocumentedDefault: true + # Hide any Mutations with undocumented return types so as not to reference something + # that seemingly does not exist. + # Default: true + hideMutationsWithUndocumentedReturnType: true + + # Whether to document any Subscriptions at all + # Default: true + subscriptionsDocumentedDefault: true + # Whether to document an individual Subscription, in the absence of a metadata directive + # Default: true + subscriptionDocumentedDefault: true + # Whether to document a Subscription Argument, in the absence of a metadata directive + # Default: true + subscriptionArgDocumentedDefault: true + # Hide any Subscriptions with undocumented return types so as not to reference something + # that seemingly does not exist. + # Default: true + hideSubscriptionsWithUndocumentedReturnType: true + + # Hide any Types that are not used anywhere in your schema after other things have been hidden. + # Default: true + hideUnusedTypes: true + + # Whether to document any Types at all + # Default: true + objectsDocumentedDefault: true + # Whether to document an individual Type, in the absence of a metadata directive + # Default: true + objectDocumentedDefault: true + + # Whether to document any Input Object types at all + # Default: true + inputsDocumentedDefault: true + # Whether to document an individual Input Object, in the absence of a metadata directive + # Default: true + inputDocumentedDefault: true + + # Whether to document any Enums at all + # Default: true + enumsDocumentedDefault: true + # Whether to document an individual Enum, in the absence of a metadata directive + # Default: true + enumDocumentedDefault: true + + # Whether to document any Unions at all + # Default: true + unionsDocumentedDefault: true + # Whether to document an individual Union, in the absence of a metadata directive + # Default: true + unionDocumentedDefault: true + # Hide Union possibleTypes that are not documented so as not to reference something + # that seemingly does not exist. + # Default: true + hideUnionTypesOfUndocumentedType: true + + # Whether to document an individual Field, in the absence of a metadata directive + # Default: true + fieldDocumentedDefault: true + # Hide any fields of undocumented types so as not to reference something + # that seemingly does not exist. + # Default: true + hideFieldsOfUndocumentedType: true + + # Whether to document an individual Input Field, in the absence of a metadata directive + # Default: true + inputFieldDocumentedDefault: true + # Hide any inputFields of undocumented types so as not to reference something + # that seemingly does not exist. + # Default: true + hideInputFieldsOfUndocumentedType: true + + # Whether to document an individual Argument, in the absence of a metadata directive + # Default: true + argDocumentedDefault: true + # Hide any args of undocumented types so as not to reference something + # that seemingly does not exist. + # Default: true + hideArgsOfUndocumentedType: true + + # + # + ############################################## + +extensions: + # Utilize the 'graphql-scalars' library when generating examples for scalars it supports that + # do not have an example already set via some other method. Usually this is a good + # thing to have on, but it is possible to turn it off. + # Default: true + graphqlScalarExamples: true + +servers: + # NOTE: If not using introspection.url OR servers[], you need to provide x-url + + # same format as for OpenAPI Specification https://swagger.io/specification/#server-object + + - url: https:///graphql + description: Production Server + # Indicates to use this server's URL as the typical GraphQL request base in the documentation + # If no server entries have this indicator, the first server's URL will be used. + # If no server entries are defined at all, the Introspection URL will be used. + production: true + # A place to list any Headers for your GraphQL API calls + # headers: + # - name: Authorization + # example: Bearer + # comment: Your API token from the dashboard. Must be included in all API calls. + +info: + # Tries to adhere to OpenAPI Specification https://swagger.io/specification/#info-object + # Will be used to populate the Welcome section of the output + + ############################################## + # Introduction area flags + # + + # Set to true to do no Introduction area rendering at all. Supersedes the below options + # Default: false + x-hideIntroduction: false + # Set to true to not render a friendly Welcome section based on the description in this area + # Default: false + x-hideWelcome: false + # Set to true to not render your intro items + # Default: false + x-hideIntroItems: true + + # Set to true to not render the deprecated label + # Default: false + x-hideIsDeprecated: false + # Set to true to not render the deprecation reason + # Default: false + x-hideDeprecationReason: false + + # + ############################################## + + description: The Adobe Commerce GraphQL API allows you to quickly and efficiently transfer information between your Commerce store and your storefront. The schema documented here is autogenerated from an instance of Adobe Commerce with B2B. You can find examples of each query and mutation in the main GraphQL documentation. + version: 2.4.9-beta-1 + title: Adobe Commerce GraphQL API (2.4.9-beta-1) + # This is non-standard and optional. If omitted, will use "title". Also only relevant + # when building non-embedded. + x-htmlTitle: GraphQL API + # termsOfService: 'https://yoursite.com/terms' + # contact: + # name: YourSite Support + # email: support@yoursite.com + # url: https://yoursite.com/support + # license: + # name: Apache 2.0 + # url: 'https://www.apache.org/licenses/LICENSE-2.0.html' + + # A non-standard array of items to display in your Introduction Area + x-introItems: + # Can be a Title (for the Nav panel) + URL to simply add a link to somewhere + - title: WebAPI guide + url: https://developer.adobe.com/commerce/webapi/ + # Can be a Title (for the Nav panel) + description (for the Content panel) + # - title: Important thing 1 + # description: Some important stuff we wanted you to know. Supports `markdown` + # Can be a Title (for the Nav panel) + file that gets loaded (for the Content panel) + # - title: Content from file that supports markdown + # file: ./examples/data/intro-items-markdown.md + + # If you really want to hide the "Documentation by" at the bottom of your output, you can do so here + # Default: false + x-hidePoweredBy: false + + # If not using introspection.url OR servers[], you need to provide x-url + # x-url: https://yoursite.com/graphql + \ No newline at end of file diff --git a/spectaql/config_saas.yml b/spectaql/config_saas.yml index ceaff09b2..54d02925d 100644 --- a/spectaql/config_saas.yml +++ b/spectaql/config_saas.yml @@ -388,10 +388,10 @@ servers: # If no server entries are defined at all, the Introspection URL will be used. # production: true # A place to list any Headers for your GraphQL API calls - # headers: - # - name: Authorization - # example: Bearer - # comment: Your API token from the dashboard. Must be included in all API calls. + headers: + - name: Authorization + example: Bearer + comment: For header information, refer to GraphQL headers. info: # Tries to adhere to OpenAPI Specification https://swagger.io/specification/#info-object @@ -409,7 +409,7 @@ info: x-hideWelcome: false # Set to true to not render your intro items # Default: false - x-hideIntroItems: false + x-hideIntroItems: true # Set to true to not render the deprecated label # Default: false @@ -421,7 +421,7 @@ info: # ############################################## - description: The Adobe Commerce as a Cloud Service GraphQL API allows you to quickly and efficiently transfer information between your Commerce store and your storefront. The schema documented here is autogenerated from a production instance of Adobe Commerce as a Cloud Service. This schema removes all deprecated queries, mutations, and fields from the core schema. It also replaces the core products and categories queries with identically-named queries defined in Catalog Service. If you are migrating to Adobe Commerce as a Cloud Service, you must update your applications to use these queries. + description: The Adobe Commerce as a Cloud Service GraphQL API allows you to quickly and efficiently transfer information between your Commerce store and your storefront. The schema documented here is autogenerated from a production instance of Adobe Commerce as a Cloud Service. This schema removes all deprecated queries, mutations, and fields from the core schema. It also replaces the core products and categories queries with identically-named queries defined in Catalog Service. If you are migrating to Adobe Commerce as a Cloud Service, you must update your applications to use these queries. For more information, refer to the GraphQL documentation. version: SaaS title: Adobe Commerce as a Cloud Service GraphQL API # This is non-standard and optional. If omitted, will use "title". Also, only relevant @@ -439,8 +439,8 @@ info: # A non-standard array of items to display in your Introduction Area x-introItems: # Can be a Title (for the Nav panel) + URL to simply add a link to somewhere - - title: Back to the GraphQL guide - url: https://developer.adobe.com/commerce/webapi/graphql/reference/ + - title: GraphQL guide + url: /commerce/webapi/graphql # Can be a Title (for the Nav panel) + description (for the Content panel) # - title: Important thing 1 # description: Some important stuff we wanted you to know. Supports `markdown` diff --git a/spectaql/schema_2.4.9-beta-1.json b/spectaql/schema_2.4.9-beta-1.json new file mode 100644 index 000000000..092d791f1 --- /dev/null +++ b/spectaql/schema_2.4.9-beta-1.json @@ -0,0 +1,79143 @@ +{ + "__schema": { + "queryType": { + "name": "Query" + }, + "mutationType": { + "name": "Mutation" + }, + "subscriptionType": null, + "types": [ + { + "kind": "OBJECT", + "name": "Query", + "description": "", + "fields": [ + { + "name": "attributesForm", + "description": "Retrieve EAV attributes associated to a frontend form. Use countries query provided by DirectoryGraphQl module to retrieve region_id and country_id attribute options.", + "args": [ + { + "name": "formCode", + "description": "Form code.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AttributesFormOutput", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attributesList", + "description": "Returns a list of attributes metadata for a given entity type.", + "args": [ + { + "name": "entityType", + "description": "Entity type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AttributeEntityTypeEnum", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "filters", + "description": "Identifies which filter inputs to search for and return.", + "type": { + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AttributesMetadataOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "availableStores", + "description": "Get a list of available store views and their config information.", + "args": [ + { + "name": "useCurrentGroup", + "description": "Filter store views by the current store group.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StoreConfig", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cart", + "description": "Return information about the specified shopping cart.", + "args": [ + { + "name": "cart_id", + "description": "The unique ID of the cart to query.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "categories", + "description": "Return a list of categories that match the specified filter.", + "args": [ + { + "name": "filters", + "description": "Identifies which Category filter inputs to search for and return.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CategoryFilterInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pageSize", + "description": "Specifies the maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "Specifies which page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "OBJECT", + "name": "CategoryResult", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "category", + "description": "Search for categories that match the criteria specified in the `search` and `filter` attributes.", + "args": [ + { + "name": "id", + "description": "The category ID to use as the root of the search.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CategoryTree", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `categories` instead." + }, + { + "name": "categoryList", + "description": "Return an array of categories based on the specified filters.", + "args": [ + { + "name": "filters", + "description": "Identifies which Category filter inputs to search for and return.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CategoryFilterInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pageSize", + "description": "Specifies the maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "Specifies which page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CategoryTree", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `categories` instead." + }, + { + "name": "checkoutAgreements", + "description": "Return Terms and Conditions configuration information.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutAgreement", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cmsBlocks", + "description": "Return information about CMS blocks.", + "args": [ + { + "name": "identifiers", + "description": "An array of CMS block IDs.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CmsBlocks", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cmsPage", + "description": "Return details about a CMS page.", + "args": [ + { + "name": "id", + "description": "The ID of the CMS page.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "identifier", + "description": "The identifier of the CMS page.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CmsPage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company", + "description": "Return detailed information about the customer's company within the current company context.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Company", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "compareList", + "description": "Return products that have been added to the specified compare list.", + "args": [ + { + "name": "uid", + "description": "The unique ID of the compare list to be queried.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompareList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "countries", + "description": "The countries query provides information for all countries.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Country", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "The countries query provides information for a single country.", + "args": [ + { + "name": "id", + "description": "", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Country", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currency", + "description": "Return information about the store's currency.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Currency", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customAttributeMetadata", + "description": "Return the attribute type, given an attribute code and entity type.", + "args": [ + { + "name": "attributes", + "description": "An input object that specifies the attribute code and entity type to search.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomAttributeMetadata", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `customAttributeMetadataV2` query instead." + }, + { + "name": "customAttributeMetadataV2", + "description": "Retrieve EAV attributes metadata.", + "args": [ + { + "name": "attributes", + "description": "", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AttributesMetadataOutput", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer", + "description": "Return detailed information about a customer account.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerCart", + "description": "Return information about the customer's shopping cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerDownloadableProducts", + "description": "Return a list of downloadable products the customer has purchased.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerDownloadableProducts", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerGroup", + "description": "Provides Customer Group assigned to the Customer or Guest.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerGroupStorefront", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerOrders", + "description": null, + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerOrders", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `customer` query instead." + }, + { + "name": "customerPaymentTokens", + "description": "Return a list of customer payment tokens stored in the vault.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentTokens", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerSegments", + "description": "Customer segments associated with the current customer or guest/visitor.", + "args": [ + { + "name": "cartId", + "description": "The unique ID of the cart to query.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerSegmentStorefront", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "dynamicBlocks", + "description": "Return a list of dynamic blocks filtered by type, location, or UIDs.", + "args": [ + { + "name": "input", + "description": "Defines the filter for returning matching dynamic blocks.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DynamicBlocksFilterInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DynamicBlocks", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "getHostedProUrl", + "description": "Retrieve the secure PayPal URL for a Payments Pro Hosted Solution transaction.", + "args": [ + { + "name": "input", + "description": "An input object that specifies the cart ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "HostedProUrlInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "HostedProUrl", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "getPayflowLinkToken", + "description": "Retrieve payment credentials for a transaction. Use this query for Payflow Link and Payments Advanced payment methods.", + "args": [ + { + "name": "input", + "description": "An input object that defines the requirements to receive a payment token.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PayflowLinkTokenInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PayflowLinkToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "getPaymentConfig", + "description": "Retrieves the payment configuration for a given location", + "args": [ + { + "name": "location", + "description": "Defines the origin location for that payment request", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PaymentLocation", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PaymentConfigOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "getPaymentOrder", + "description": "Retrieves the payment details for the order", + "args": [ + { + "name": "cartId", + "description": "The customer cart ID", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "id", + "description": "PayPal order ID", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PaymentOrderOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "getPaymentSDK", + "description": "Gets the payment SDK urls and values", + "args": [ + { + "name": "location", + "description": "Defines the origin location for that payment request", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PaymentLocation", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "GetPaymentSDKOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "getVaultConfig", + "description": "Retrieves the vault configuration", + "args": [], + "type": { + "kind": "OBJECT", + "name": "VaultConfigOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftCardAccount", + "description": "Return details about a specific gift card.", + "args": [ + { + "name": "input", + "description": "An input object that specifies the gift card code.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "GiftCardAccountInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "GiftCardAccount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftRegistry", + "description": "Return the specified gift registry. Some details will not be available to guests.", + "args": [ + { + "name": "giftRegistryUid", + "description": "The unique ID of the registry to search for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "GiftRegistry", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftRegistryEmailSearch", + "description": "Search for gift registries by specifying a registrant email address.", + "args": [ + { + "name": "email", + "description": "The registrant's email.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftRegistrySearchResult", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftRegistryIdSearch", + "description": "Search for gift registries by specifying a registry URL key.", + "args": [ + { + "name": "giftRegistryUid", + "description": "The unique ID of the gift registry.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftRegistrySearchResult", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftRegistryTypeSearch", + "description": "Search for gift registries by specifying the registrant name and registry type ID.", + "args": [ + { + "name": "firstName", + "description": "The first name of the registrant.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lastName", + "description": "The last name of the registrant.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "giftRegistryTypeUid", + "description": "The type UID of the registry.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftRegistrySearchResult", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftRegistryTypes", + "description": "Get a list of available gift registry types.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftRegistryType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "guestOrder", + "description": "Retrieve guest order details based on number, email and billing last name.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "GuestOrderInformationInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerOrder", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "guestOrderByToken", + "description": "Retrieve guest order details based on token.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "OrderTokenInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerOrder", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isCompanyAdminEmailAvailable", + "description": "Check whether the specified email can be used to register a company admin.", + "args": [ + { + "name": "email", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "IsCompanyAdminEmailAvailableOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isCompanyEmailAvailable", + "description": "Check whether the specified email can be used to register a new company.", + "args": [ + { + "name": "email", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "IsCompanyEmailAvailableOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isCompanyRoleNameAvailable", + "description": "Check whether the specified role name is valid for the company.", + "args": [ + { + "name": "name", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "IsCompanyRoleNameAvailableOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isCompanyUserEmailAvailable", + "description": "Check whether the specified email can be used to register a company user.", + "args": [ + { + "name": "email", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "IsCompanyUserEmailAvailableOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isEmailAvailable", + "description": "Check whether the specified email has already been used to create a customer account.", + "args": [ + { + "name": "email", + "description": "The email address to check.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "IsEmailAvailableOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "negotiableQuote", + "description": "Retrieve the specified negotiable quote.", + "args": [ + { + "name": "uid", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuote", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "negotiableQuoteTemplate", + "description": "Retrieve the specified negotiable quote template.", + "args": [ + { + "name": "templateId", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplate", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "negotiableQuoteTemplates", + "description": "Return a list of negotiable quote templates that can be viewed by the logged-in customer.", + "args": [ + { + "name": "filter", + "description": "The filter to use to determine which negotiable quote templates to return.", + "type": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteTemplateFilterInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "sort", + "description": "The field to use for sorting results.", + "type": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteTemplateSortInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplatesOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "negotiableQuotes", + "description": "Return a list of negotiable quotes that can be viewed by the logged-in customer.", + "args": [ + { + "name": "filter", + "description": "The filter to use to determine which negotiable quotes to return.", + "type": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteFilterInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "sort", + "description": "The field to use for sorting results.", + "type": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteSortInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuotesOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pickupLocations", + "description": "The pickup locations query searches for locations that match the search request requirements.", + "args": [ + { + "name": "area", + "description": "Perform search by location using radius and search term.", + "type": { + "kind": "INPUT_OBJECT", + "name": "AreaInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "filters", + "description": "Apply filters by attributes.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PickupLocationFilterInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sort", + "description": "Specifies which attribute to sort on, and whether to return the results in ascending or descending order.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PickupLocationSortInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pageSize", + "description": "The maximum number of pickup locations to return at once. The attribute is optional.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "Specifies which page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "productsInfo", + "description": "Information about products which should be delivered.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductInfoInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PickupLocations", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productReviewRatingsMetadata", + "description": "Return the active ratings attributes and the values each rating can have.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviewRatingsMetadata", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "Search for products that match the criteria specified in the `search` and `filter` attributes.", + "args": [ + { + "name": "search", + "description": "One or more keywords to use in a full-text search.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "filter", + "description": "The product attributes to search for and return.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ProductAttributeFilterInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "sort", + "description": "Specifies which attributes to sort on, and whether to return the results in ascending or descending order.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ProductAttributeSortInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Products", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "recaptchaFormConfig", + "description": null, + "args": [ + { + "name": "formType", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ReCaptchaFormEnum", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ReCaptchaConfigOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "recaptchaV3Config", + "description": "Returns details about Google reCAPTCHA V3-Invisible configuration.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ReCaptchaConfigurationV3", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "route", + "description": "Return the full details for a specified product, category, or CMS page.", + "args": [ + { + "name": "url", + "description": "A `url_key` appended by the `url_suffix, if one exists.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "INTERFACE", + "name": "RoutableInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "storeConfig", + "description": "Return details about the store's configuration.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "StoreConfig", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlResolver", + "description": "Return the relative URL for a specified product, category or CMS page.", + "args": [ + { + "name": "url", + "description": "A `url_key` appended by the `url_suffix, if one exists.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "EntityUrl", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `route` query instead." + }, + { + "name": "wishlist", + "description": "Return the contents of a customer's wish list.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "WishlistOutput", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Moved under `Customer.wishlist`." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "String", + "description": "The `String` scalar type represents textual data, represented as UTF-8\ncharacter sequences. The String type is most often used by GraphQL to\nrepresent free-form human-readable text.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "ID", + "description": "The `ID` scalar type represents a unique identifier, often used to\nrefetch an object or as key for a cache. The ID type appears in a JSON\nresponse as a String; however, it is not intended to be human-readable.\nWhen expected as an input type, any string (such as `\"4\"`) or integer\n(such as `4`) input value will be accepted as an ID.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Boolean", + "description": "The `Boolean` scalar type represents `true` or `false`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Int", + "description": "The `Int` scalar type represents non-fractional signed whole numeric\nvalues. Int can represent values between -(2^31) and 2^31 - 1. ", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Float", + "description": "The `Float` scalar type represents signed double-precision fractional\nvalues as specified by\n[IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point). ", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Mutation", + "description": "", + "fields": [ + { + "name": "acceptCompanyInvitation", + "description": "Accept invitation to the company.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyInvitationInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyInvitationOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "acceptNegotiableQuoteTemplate", + "description": "Update an existing negotiable quote template.", + "args": [ + { + "name": "input", + "description": "An input object that contains the data to update a negotiable quote template.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AcceptNegotiableQuoteTemplateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplate", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addBundleProductsToCart", + "description": "Add one or more bundle products to the specified cart. We recommend using `addProductsToCart` instead.", + "args": [ + { + "name": "input", + "description": "An input object that defines which bundle products to add to the cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "AddBundleProductsToCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddBundleProductsToCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addConfigurableProductsToCart", + "description": "Add one or more configurable products to the specified cart. We recommend using `addProductsToCart` instead.", + "args": [ + { + "name": "input", + "description": "An input object that defines which configurable products to add to the cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "AddConfigurableProductsToCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddConfigurableProductsToCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addDownloadableProductsToCart", + "description": "Add one or more downloadable products to the specified cart. We recommend using `addProductsToCart` instead.", + "args": [ + { + "name": "input", + "description": "An input object that defines which downloadable products to add to the cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "AddDownloadableProductsToCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddDownloadableProductsToCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addGiftRegistryRegistrants", + "description": "Add registrants to the specified gift registry.", + "args": [ + { + "name": "giftRegistryUid", + "description": "The unique ID of the gift registry.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "registrants", + "description": "An array registrants to add.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AddGiftRegistryRegistrantInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddGiftRegistryRegistrantsOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addProductsToCart", + "description": "Add any type of product to the cart.", + "args": [ + { + "name": "cartId", + "description": "The cart ID of the shopper.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "cartItems", + "description": "An array that defines the products to add to the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartItemInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddProductsToCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addProductsToCompareList", + "description": "Add products to the specified compare list.", + "args": [ + { + "name": "input", + "description": "An input object that defines which products to add to an existing compare list.", + "type": { + "kind": "INPUT_OBJECT", + "name": "AddProductsToCompareListInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompareList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addProductsToNewCart", + "description": "Creates a new cart and add any type of product to it", + "args": [ + { + "name": "cartItems", + "description": "An array that defines the products to add to the new cart", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartItemInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddProductsToNewCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addProductsToRequisitionList", + "description": "Add items to the specified requisition list.", + "args": [ + { + "name": "requisitionListUid", + "description": "The unique ID of the requisition list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "requisitionListItems", + "description": "An array of products to be added to the requisition list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RequisitionListItemsInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddProductsToRequisitionListOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addProductsToWishlist", + "description": "Add one or more products to the specified wish list. This mutation supports all product types.", + "args": [ + { + "name": "wishlistId", + "description": "The ID of a wish list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "wishlistItems", + "description": "An array of products to add to the wish list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "WishlistItemInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddProductsToWishlistOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addPurchaseOrderComment", + "description": "Add a comment to an existing purchase order.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AddPurchaseOrderCommentInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddPurchaseOrderCommentOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addPurchaseOrderItemsToCart", + "description": "Add purchase order items to the shopping cart.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AddPurchaseOrderItemsToCartInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddProductsToCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addRequisitionListItemsToCart", + "description": "Add items in the requisition list to the customer's cart.", + "args": [ + { + "name": "requisitionListUid", + "description": "The unique ID of the requisition list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "requisitionListItemUids", + "description": "An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddRequisitionListItemsToCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addReturnComment", + "description": "Add a comment to an existing return.", + "args": [ + { + "name": "input", + "description": "An input object that defines a return comment.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AddReturnCommentInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddReturnCommentOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addReturnTracking", + "description": "Add tracking information to the return.", + "args": [ + { + "name": "input", + "description": "An input object that defines tracking information.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AddReturnTrackingInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddReturnTrackingOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addSimpleProductsToCart", + "description": "Add one or more simple products to the specified cart. We recommend using `addProductsToCart` instead.", + "args": [ + { + "name": "input", + "description": "An input object that defines which simple products to add to the cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "AddSimpleProductsToCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddSimpleProductsToCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addVirtualProductsToCart", + "description": "Add one or more virtual products to the specified cart. We recommend using `addProductsToCart` instead.", + "args": [ + { + "name": "input", + "description": "An input object that defines which virtual products to add to the cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "AddVirtualProductsToCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddVirtualProductsToCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addWishlistItemsToCart", + "description": "Add items in the specified wishlist to the customer's cart.", + "args": [ + { + "name": "wishlistId", + "description": "The unique ID of the wish list", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "wishlistItemIds", + "description": "An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddWishlistItemsToCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "applyCouponToCart", + "description": "Apply a pre-defined coupon code to the specified cart.", + "args": [ + { + "name": "input", + "description": "An input object that defines the coupon code to apply to the cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ApplyCouponToCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ApplyCouponToCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "applyCouponsToCart", + "description": "Apply a pre-defined coupon code to the specified cart.", + "args": [ + { + "name": "input", + "description": "An input object that defines the coupon code to apply to the cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ApplyCouponsToCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ApplyCouponToCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "applyGiftCardToCart", + "description": "Apply a pre-defined gift card code to the specified cart.", + "args": [ + { + "name": "input", + "description": "An input object that specifies the gift card code and cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ApplyGiftCardToCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ApplyGiftCardToCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "applyRewardPointsToCart", + "description": "Apply all available points, up to the cart total. Partial redemption is not available.", + "args": [ + { + "name": "cartId", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ApplyRewardPointsToCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "applyStoreCreditToCart", + "description": "Apply store credit to the specified cart.", + "args": [ + { + "name": "input", + "description": "An input object that specifies the cart ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ApplyStoreCreditToCartInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ApplyStoreCreditToCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "approvePurchaseOrders", + "description": "Approve purchase orders.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PurchaseOrdersActionInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PurchaseOrdersActionOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "assignCompareListToCustomer", + "description": "Assign the specified compare list to the logged in customer.", + "args": [ + { + "name": "uid", + "description": "The unique ID of the compare list to be assigned.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AssignCompareListToCustomerOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "assignCustomerToGuestCart", + "description": "Assign a logged-in customer to the specified guest shopping cart.", + "args": [ + { + "name": "cart_id", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cancelNegotiableQuoteTemplate", + "description": "Cancel a negotiable quote template", + "args": [ + { + "name": "input", + "description": "An input object that cancels a negotiable quote template.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CancelNegotiableQuoteTemplateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplate", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cancelOrder", + "description": "Cancel the specified customer order.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CancelOrderInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CancelOrderOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cancelPurchaseOrders", + "description": "Cancel purchase orders.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PurchaseOrdersActionInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PurchaseOrdersActionOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "changeCustomerPassword", + "description": "Change the password for the logged-in customer.", + "args": [ + { + "name": "currentPassword", + "description": "The customer's original password.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "newPassword", + "description": "The customer's updated password.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "clearCart", + "description": "Remove all items from the specified cart.", + "args": [ + { + "name": "input", + "description": "An input object that defines cart ID of the shopper.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ClearCartInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ClearCartOutput", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "clearCustomerCart", + "description": "Remove all items from the specified cart.", + "args": [ + { + "name": "cartUid", + "description": "The masked ID of the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ClearCustomerCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "clearWishlist", + "description": "Remove all the products from the specified wish list.", + "args": [ + { + "name": "wishlistId", + "description": "The ID of a wish list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RemoveProductsFromWishlistOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "closeNegotiableQuotes", + "description": "Mark a negotiable quote as closed. The negotiable quote is still visible on the storefront.", + "args": [ + { + "name": "input", + "description": "An input object that closes a negotiable quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CloseNegotiableQuotesInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CloseNegotiableQuotesOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "completeOrder", + "description": "Synchronizes order details and place the order", + "args": [ + { + "name": "input", + "description": "Describes the variables needed to complete or place the order", + "type": { + "kind": "INPUT_OBJECT", + "name": "CompleteOrderInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PlaceOrderOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "confirmCancelOrder", + "description": "Cancel the specified guest customer order.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ConfirmCancelOrderInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CancelOrderOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "confirmEmail", + "description": "Confirms the email address for a customer.", + "args": [ + { + "name": "input", + "description": "An input object to identify the customer to confirm the email.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ConfirmEmailInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "confirmReturn", + "description": "Confirm the return.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ConfirmReturnInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RequestReturnOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "contactUs", + "description": "Send a 'Contact Us' email to the merchant.", + "args": [ + { + "name": "input", + "description": "An input object that defines shopper information.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ContactUsInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ContactUsOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "copyItemsBetweenRequisitionLists", + "description": "Copy items from one requisition list to another.", + "args": [ + { + "name": "sourceRequisitionListUid", + "description": "The unique ID of the source requisition list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "destinationRequisitionListUid", + "description": "The unique ID of the destination requisition list. If null, a new requisition list will be created.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "requisitionListItem", + "description": "The list of products to copy.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CopyItemsBetweenRequisitionListsInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CopyItemsFromRequisitionListsOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "copyProductsBetweenWishlists", + "description": "Copy products from one wish list to another. The original wish list is unchanged.", + "args": [ + { + "name": "sourceWishlistUid", + "description": "The ID of the original wish list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "destinationWishlistUid", + "description": "The ID of the target wish list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "wishlistItems", + "description": "An array of items to copy.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "WishlistItemCopyInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CopyProductsBetweenWishlistsOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createBraintreeClientToken", + "description": "Creates Client Token for Braintree Javascript SDK initialization.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createBraintreePayPalClientToken", + "description": "Creates Client Token for Braintree PayPal Javascript SDK initialization.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createBraintreePayPalVaultClientToken", + "description": "Creates Client Token for Braintree PayPal Vault Javascript SDK initialization.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "BraintreeVaultInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createCompany", + "description": "Create a company at the request of either a customer or a guest.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CreateCompanyOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createCompanyRole", + "description": "Create a new company role.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyRoleCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CreateCompanyRoleOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createCompanyTeam", + "description": "Create a new team for the customer's company within the current company context.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyTeamCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CreateCompanyTeamOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createCompanyUser", + "description": "Create a new company user at the request of an existing customer.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyUserCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CreateCompanyUserOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createCompareList", + "description": "Create a new compare list. The compare list is saved for logged in customers.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "CreateCompareListInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompareList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createCustomer", + "description": null, + "args": [ + { + "name": "input", + "description": "An input object that defines the customer to be created.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerOutput", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `createCustomerV2` instead." + }, + { + "name": "createCustomerAddress", + "description": "Create a billing or shipping address for a customer or guest.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerAddressInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createCustomerV2", + "description": "Create a customer account.", + "args": [ + { + "name": "input", + "description": "An input object that defines the customer to be created.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createEmptyCart", + "description": "Create an empty shopping cart for a guest or logged in user", + "args": [ + { + "name": "input", + "description": "An optional input object that assigns the specified ID to the cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "createEmptyCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `Mutation.createGuestCart` or `Query.customerCart` for logged in customer" + }, + { + "name": "createGiftRegistry", + "description": "Create a gift registry on behalf of the customer.", + "args": [ + { + "name": "giftRegistry", + "description": "An input object that defines a new gift registry.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CreateGiftRegistryInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CreateGiftRegistryOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createGuestCart", + "description": "Create a new shopping cart", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "CreateGuestCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CreateGuestCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createPayflowProToken", + "description": "Initiate a transaction and receive a token. Use this mutation for Payflow Pro and Payments Pro payment methods", + "args": [ + { + "name": "input", + "description": "An input object that defines the requirements to fetch payment token information.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PayflowProTokenInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CreatePayflowProTokenOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createPaymentOrder", + "description": "Creates a payment order for further payment processing", + "args": [ + { + "name": "input", + "description": "Contains payment order details that are used while processing the payment order", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CreatePaymentOrderInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CreatePaymentOrderOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createPaypalExpressToken", + "description": "Initiate an Express Checkout transaction and receive a token. Use this mutation for Express Checkout and Payments Standard payment methods.", + "args": [ + { + "name": "input", + "description": "An input object that defines the requirements to receive a payment token.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PaypalExpressTokenInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PaypalExpressTokenOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createProductReview", + "description": "Create a product review for the specified product.", + "args": [ + { + "name": "input", + "description": "An input object that contains the details necessary to create a product review.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CreateProductReviewInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CreateProductReviewOutput", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createPurchaseOrderApprovalRule", + "description": "Create a purchase order approval rule.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PurchaseOrderApprovalRuleInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PurchaseOrderApprovalRule", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createRequisitionList", + "description": "Create an empty requisition list.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "CreateRequisitionListInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CreateRequisitionListOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createVaultCardPaymentToken", + "description": "Creates a vault payment token", + "args": [ + { + "name": "input", + "description": "Describe the variables needed to create a vault card payment token", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CreateVaultCardPaymentTokenInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CreateVaultCardPaymentTokenOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createVaultCardSetupToken", + "description": "Creates a vault card setup token", + "args": [ + { + "name": "input", + "description": "Describe the variables needed to create a vault card setup token", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CreateVaultCardSetupTokenInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CreateVaultCardSetupTokenOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createWishlist", + "description": "Create a new wish list.", + "args": [ + { + "name": "input", + "description": "An input object that defines a new wish list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CreateWishlistInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CreateWishlistOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deleteCompanyRole", + "description": "Delete the specified company role.", + "args": [ + { + "name": "id", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DeleteCompanyRoleOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deleteCompanyTeam", + "description": "Delete the specified company team.", + "args": [ + { + "name": "id", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DeleteCompanyTeamOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deleteCompanyUser", + "description": "Delete the specified company user.", + "args": [ + { + "name": "id", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DeleteCompanyUserOutput", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use deleteCompanyUserV2 instead. The current method only deactivates the user account associated with the company." + }, + { + "name": "deleteCompanyUserV2", + "description": "Delete the specified company user.", + "args": [ + { + "name": "id", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DeleteCompanyUserOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deleteCompareList", + "description": "Delete the specified compare list.", + "args": [ + { + "name": "uid", + "description": "The unique ID of the compare list to be deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DeleteCompareListOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deleteCustomer", + "description": "Delete customer account", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deleteCustomerAddress", + "description": "Delete the billing or shipping address of a customer.", + "args": [ + { + "name": "id", + "description": "The ID of the customer address to be deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `deleteCustomerAddressV2` instead." + }, + { + "name": "deleteCustomerAddressV2", + "description": "Delete the billing or shipping address of a customer.", + "args": [ + { + "name": "uid", + "description": "The unique ID of the customer address to be deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deleteNegotiableQuoteTemplate", + "description": "Delete a negotiable quote template", + "args": [ + { + "name": "input", + "description": "An input object that cancels a negotiable quote template.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeleteNegotiableQuoteTemplateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deleteNegotiableQuotes", + "description": "Delete a negotiable quote. The negotiable quote will not be displayed on the storefront.", + "args": [ + { + "name": "input", + "description": "An input object that deletes a negotiable quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeleteNegotiableQuotesInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DeleteNegotiableQuotesOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deletePaymentToken", + "description": "Delete a customer's payment token.", + "args": [ + { + "name": "public_hash", + "description": "The reusable payment token securely stored in the vault.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DeletePaymentTokenOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deletePurchaseOrderApprovalRule", + "description": "Delete existing purchase order approval rules.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeletePurchaseOrderApprovalRuleInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DeletePurchaseOrderApprovalRuleOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deleteRequisitionList", + "description": "Delete a requisition list.", + "args": [ + { + "name": "requisitionListUid", + "description": "The unique ID of the requisition list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DeleteRequisitionListOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deleteRequisitionListItems", + "description": "Delete items from a requisition list.", + "args": [ + { + "name": "requisitionListUid", + "description": "The unique ID of the requisition list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "requisitionListItemUids", + "description": "An array of UIDs representing products to be removed from the requisition list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DeleteRequisitionListItemsOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deleteWishlist", + "description": "Delete the specified wish list. You cannot delete the customer's default (first) wish list.", + "args": [ + { + "name": "wishlistId", + "description": "The ID of the wish list to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DeleteWishlistOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "duplicateNegotiableQuote", + "description": "Negotiable Quote resulting from duplication operation.", + "args": [ + { + "name": "input", + "description": "An input object that defines ID of the quote to be duplicated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DuplicateNegotiableQuoteInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DuplicateNegotiableQuoteOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "estimateShippingMethods", + "description": "Estimate shipping method(s) for cart based on address", + "args": [ + { + "name": "input", + "description": "An input object that specifies details for estimation of available shipping methods", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "EstimateTotalsInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AvailableShippingMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "estimateTotals", + "description": "Estimate totals for cart based on the address", + "args": [ + { + "name": "input", + "description": "An input object that specifies details for cart totals estimation", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "EstimateTotalsInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "EstimateTotalsOutput", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "exchangeExternalCustomerToken", + "description": "Generate a token for specified customer.", + "args": [ + { + "name": "input", + "description": "Contains details about external customer.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ExchangeExternalCustomerTokenInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ExchangeExternalCustomerTokenOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "generateCustomerToken", + "description": "Generate a token for specified customer.", + "args": [ + { + "name": "email", + "description": "The customer's email address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "password", + "description": "The customer's password.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "generateCustomerTokenAsAdmin", + "description": "Request a customer token so that an administrator can perform remote shopping assistance.", + "args": [ + { + "name": "input", + "description": "An input object that defines the customer email address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "GenerateCustomerTokenAsAdminInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "GenerateCustomerTokenAsAdminOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "generateNegotiableQuoteFromTemplate", + "description": "Generate a negotiable quote from an accept quote template.", + "args": [ + { + "name": "input", + "description": "An input object that contains the data to generate a negotiable quote from quote template.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "GenerateNegotiableQuoteFromTemplateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "GenerateNegotiableQuoteFromTemplateOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handlePayflowProResponse", + "description": "Handle a payment response and save the payment in Quote. Use this mutation for Payflow Pro and Payments Pro payment methods.", + "args": [ + { + "name": "input", + "description": "An input object that includes the payload returned by PayPal and the cart ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PayflowProResponseInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PayflowProResponseOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mergeCarts", + "description": "Transfer the contents of a guest cart into the cart of a logged-in customer.", + "args": [ + { + "name": "source_cart_id", + "description": "The guest's cart ID before they login.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "destination_cart_id", + "description": "The cart ID after the guest logs in.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "moveCartItemsToGiftRegistry", + "description": "Move all items from the cart to a gift registry.", + "args": [ + { + "name": "cartUid", + "description": "The unique ID of the cart containing items to be moved to a gift registry.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "giftRegistryUid", + "description": "The unique ID of the target gift registry.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MoveCartItemsToGiftRegistryOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "moveItemsBetweenRequisitionLists", + "description": "Move Items from one requisition list to another.", + "args": [ + { + "name": "sourceRequisitionListUid", + "description": "The unique ID of the source requisition list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "destinationRequisitionListUid", + "description": "The unique ID of the destination requisition list. If null, a new requisition list will be created.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "requisitionListItem", + "description": "The list of products to move.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MoveItemsBetweenRequisitionListsInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MoveItemsBetweenRequisitionListsOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "moveLineItemToRequisitionList", + "description": "Move negotiable quote item to requisition list.", + "args": [ + { + "name": "input", + "description": "An input object that defines the quote item and requisition list moved to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MoveLineItemToRequisitionListInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MoveLineItemToRequisitionListOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "moveProductsBetweenWishlists", + "description": "Move products from one wish list to another.", + "args": [ + { + "name": "sourceWishlistUid", + "description": "The ID of the original wish list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "destinationWishlistUid", + "description": "The ID of the target wish list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "wishlistItems", + "description": "An array of items to move.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "WishlistItemMoveInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MoveProductsBetweenWishlistsOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "openNegotiableQuoteTemplate", + "description": "Open an existing negotiable quote template.", + "args": [ + { + "name": "input", + "description": "An input object that contains the data to open a negotiable quote template.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "OpenNegotiableQuoteTemplateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplate", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "placeNegotiableQuoteOrder", + "description": "Convert a negotiable quote into an order.", + "args": [ + { + "name": "input", + "description": "An input object that specifies the negotiable quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PlaceNegotiableQuoteOrderInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PlaceNegotiableQuoteOrderOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "placeOrder", + "description": "Convert the quote into an order.", + "args": [ + { + "name": "input", + "description": "An input object that defines the shopper's cart ID.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PlaceOrderInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PlaceOrderOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "placeOrderForPurchaseOrder", + "description": "Convert the purchase order into an order.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PlaceOrderForPurchaseOrderInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PlaceOrderForPurchaseOrderOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "placePurchaseOrder", + "description": "Place a purchase order.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PlacePurchaseOrderInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PlacePurchaseOrderOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "redeemGiftCardBalanceAsStoreCredit", + "description": "Redeem a gift card for store credit.", + "args": [ + { + "name": "input", + "description": "An input object that specifies the gift card code to redeem.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "GiftCardAccountInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "GiftCardAccount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rejectPurchaseOrders", + "description": "Reject purchase orders.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PurchaseOrdersActionInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PurchaseOrdersActionOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "removeCouponFromCart", + "description": "Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon.", + "args": [ + { + "name": "input", + "description": "An input object that defines which coupon code to remove from the cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "RemoveCouponFromCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RemoveCouponFromCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "removeCouponsFromCart", + "description": "Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon.", + "args": [ + { + "name": "input", + "description": "An input object that defines which coupon code to remove from the cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "RemoveCouponsFromCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RemoveCouponFromCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "removeGiftCardFromCart", + "description": "Removes a gift card from the cart.", + "args": [ + { + "name": "input", + "description": "An input object that specifies which gift card code to remove from the cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "RemoveGiftCardFromCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RemoveGiftCardFromCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "removeGiftRegistry", + "description": "Delete the specified gift registry.", + "args": [ + { + "name": "giftRegistryUid", + "description": "The unique ID of the gift registry to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RemoveGiftRegistryOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "removeGiftRegistryItems", + "description": "Delete the specified items from a gift registry.", + "args": [ + { + "name": "giftRegistryUid", + "description": "The unique ID of the gift registry.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "itemsUid", + "description": "An array of item IDs to remove from the gift registry.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RemoveGiftRegistryItemsOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "removeGiftRegistryRegistrants", + "description": "Removes registrants from a gift registry.", + "args": [ + { + "name": "giftRegistryUid", + "description": "The unique ID of the gift registry.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "registrantsUid", + "description": "An array of registrant IDs to remove.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RemoveGiftRegistryRegistrantsOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "removeItemFromCart", + "description": "Delete the entire quantity of a specified item from the cart. If you remove all items from the cart, the cart continues to exist.", + "args": [ + { + "name": "input", + "description": "An input object that defines which products to remove from the cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "RemoveItemFromCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RemoveItemFromCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "removeNegotiableQuoteItems", + "description": "Remove one or more products from a negotiable quote.", + "args": [ + { + "name": "input", + "description": "An input object that removes one or more items from a negotiable quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RemoveNegotiableQuoteItemsInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RemoveNegotiableQuoteItemsOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "removeNegotiableQuoteTemplateItems", + "description": "Remove one or more products from a negotiable quote template.", + "args": [ + { + "name": "input", + "description": "An input object that removes one or more items from a negotiable quote template.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RemoveNegotiableQuoteTemplateItemsInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplate", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "removeProductsFromCompareList", + "description": "Remove products from the specified compare list.", + "args": [ + { + "name": "input", + "description": "An input object that defines which products to remove from a compare list.", + "type": { + "kind": "INPUT_OBJECT", + "name": "RemoveProductsFromCompareListInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompareList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "removeProductsFromWishlist", + "description": "Remove one or more products from the specified wish list.", + "args": [ + { + "name": "wishlistId", + "description": "The ID of a wish list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "wishlistItemsIds", + "description": "An array of item IDs representing products to be removed.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RemoveProductsFromWishlistOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "removeReturnTracking", + "description": "Remove a tracked shipment from a return.", + "args": [ + { + "name": "input", + "description": "An input object that removes tracking information.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RemoveReturnTrackingInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RemoveReturnTrackingOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "removeRewardPointsFromCart", + "description": "Cancel the application of reward points to the cart.", + "args": [ + { + "name": "cartId", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RemoveRewardPointsFromCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "removeStoreCreditFromCart", + "description": "Remove store credit that has been applied to the specified cart.", + "args": [ + { + "name": "input", + "description": "An input object that specifies the cart ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RemoveStoreCreditFromCartInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RemoveStoreCreditFromCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "renameNegotiableQuote", + "description": "Rename negotiable quote.", + "args": [ + { + "name": "input", + "description": "An input object that defines the quote item name and comment.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RenameNegotiableQuoteInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RenameNegotiableQuoteOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reorderItems", + "description": "Add all products from a customer's previous order to the cart.", + "args": [ + { + "name": "orderNumber", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ReorderItemsOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requestGuestOrderCancel", + "description": "Request to cancel specified guest order.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "GuestOrderCancelInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CancelOrderOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requestGuestReturn", + "description": null, + "args": [ + { + "name": "input", + "description": "An input object that contains the fields needed to start a return request for guest.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RequestGuestReturnInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RequestReturnOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requestNegotiableQuote", + "description": "Request a new negotiable quote on behalf of the buyer.", + "args": [ + { + "name": "input", + "description": "An input object that contains a request to initiate a negotiable quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RequestNegotiableQuoteInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RequestNegotiableQuoteOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requestNegotiableQuoteTemplateFromQuote", + "description": "Request a new negotiable quote on behalf of the buyer.", + "args": [ + { + "name": "input", + "description": "An input object that contains a request to initiate a negotiable quote template.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RequestNegotiableQuoteTemplateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplate", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requestPasswordResetEmail", + "description": "Request an email with a reset password token for the registered customer identified by the specified email.", + "args": [ + { + "name": "email", + "description": "The customer's email address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requestReturn", + "description": "Initiates a buyer's request to return items for replacement or refund.", + "args": [ + { + "name": "input", + "description": "An input object that contains the fields needed to start a return request.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RequestReturnInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RequestReturnOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "resendConfirmationEmail", + "description": "Resends the confirmation email to a customer.", + "args": [ + { + "name": "email", + "description": "The email address to send the confirmation email to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "resetPassword", + "description": "Reset a customer's password using the reset password token that the customer received in an email after requesting it using `requestPasswordResetEmail`.", + "args": [ + { + "name": "email", + "description": "The customer's email address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "resetPasswordToken", + "description": "A runtime token generated by the `requestPasswordResetEmail` mutation.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "newPassword", + "description": "The customer's new password.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "revokeCustomerToken", + "description": "Revoke the customer token.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RevokeCustomerTokenOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sendEmailToFriend", + "description": "Send a message on behalf of a customer to the specified email addresses.", + "args": [ + { + "name": "input", + "description": "An input object that defines sender, recipients, and product.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SendEmailToFriendInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SendEmailToFriendOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sendNegotiableQuoteForReview", + "description": "Send the negotiable quote to the seller for review.", + "args": [ + { + "name": "input", + "description": "An input object that sends a request for the merchant to review a negotiable quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SendNegotiableQuoteForReviewInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SendNegotiableQuoteForReviewOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "setBillingAddressOnCart", + "description": "Set the billing address on a specific cart.", + "args": [ + { + "name": "input", + "description": "An input object that defines the billing address to be assigned to the cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SetBillingAddressOnCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SetBillingAddressOnCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "setCartAsInactive", + "description": "Sets the cart as inactive", + "args": [ + { + "name": "cartId", + "description": "The customer cart ID", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SetCartAsInactiveOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "setGiftOptionsOnCart", + "description": "Set gift options, including gift messages, gift wrapping, gift receipts, and printed cards.", + "args": [ + { + "name": "input", + "description": "An input object that defines the selected gift options.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SetGiftOptionsOnCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SetGiftOptionsOnCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "setGuestEmailOnCart", + "description": "Assign the email address of a guest to the cart.", + "args": [ + { + "name": "input", + "description": "An input object that defines a guest email address.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SetGuestEmailOnCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SetGuestEmailOnCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "setLineItemNote", + "description": "Add buyer's note to a negotiable quote item.", + "args": [ + { + "name": "input", + "description": "An input object that defines the quote item note.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "LineItemNoteInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SetLineItemNoteOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "setNegotiableQuoteBillingAddress", + "description": "Assign a billing address to a negotiable quote.", + "args": [ + { + "name": "input", + "description": "An input object that defines the billing address to be assigned to a negotiable quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SetNegotiableQuoteBillingAddressInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SetNegotiableQuoteBillingAddressOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "setNegotiableQuotePaymentMethod", + "description": "Set the payment method on a negotiable quote.", + "args": [ + { + "name": "input", + "description": "An input object that defines the payment method for the specified negotiable quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SetNegotiableQuotePaymentMethodInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SetNegotiableQuotePaymentMethodOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "setNegotiableQuoteShippingAddress", + "description": "Assign a previously-defined address as the shipping address for a negotiable quote.", + "args": [ + { + "name": "input", + "description": "An input object that defines the shipping address to be assigned to a negotiable quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SetNegotiableQuoteShippingAddressInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SetNegotiableQuoteShippingAddressOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "setNegotiableQuoteShippingMethods", + "description": "Assign the shipping methods on the negotiable quote.", + "args": [ + { + "name": "input", + "description": "An input object that defines the shipping methods to be assigned to a negotiable quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SetNegotiableQuoteShippingMethodsInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SetNegotiableQuoteShippingMethodsOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "setNegotiableQuoteTemplateShippingAddress", + "description": "Assign a previously-defined address as the shipping address for a negotiable quote template.", + "args": [ + { + "name": "input", + "description": "An input object that defines the shipping address to be assigned to a negotiable quote template.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SetNegotiableQuoteTemplateShippingAddressInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplate", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "setPaymentMethodAndPlaceOrder", + "description": "Set the cart payment method and convert the cart into an order.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "SetPaymentMethodAndPlaceOrderInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PlaceOrderOutput", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Should use setPaymentMethodOnCart and placeOrder mutations in single request." + }, + { + "name": "setPaymentMethodOnCart", + "description": "Apply a payment method to the cart.", + "args": [ + { + "name": "input", + "description": "An input object that defines which payment method to apply to the cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SetPaymentMethodOnCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SetPaymentMethodOnCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "setQuoteTemplateLineItemNote", + "description": "Add buyer's note to a negotiable quote template item.", + "args": [ + { + "name": "input", + "description": "An input object that defines the quote template item note.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "QuoteTemplateLineItemNoteInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplate", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "setShippingAddressesOnCart", + "description": "Set one or more shipping addresses on a specific cart.", + "args": [ + { + "name": "input", + "description": "An input object that defines one or more shipping addresses to be assigned to the cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SetShippingAddressesOnCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SetShippingAddressesOnCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "setShippingMethodsOnCart", + "description": "Set one or more delivery methods on a cart.", + "args": [ + { + "name": "input", + "description": "An input object that applies one or more shipping methods to the cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SetShippingMethodsOnCartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SetShippingMethodsOnCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shareGiftRegistry", + "description": "Send an email about the gift registry to a list of invitees.", + "args": [ + { + "name": "giftRegistryUid", + "description": "The unique ID of the gift registry.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sender", + "description": "The sender's email address and gift message.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ShareGiftRegistrySenderInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "invitees", + "description": "An array containing invitee names and email addresses.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ShareGiftRegistryInviteeInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ShareGiftRegistryOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "submitNegotiableQuoteTemplateForReview", + "description": "Accept an existing negotiable quote template.", + "args": [ + { + "name": "input", + "description": "An input object that contains the data to update a negotiable quote template.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubmitNegotiableQuoteTemplateForReviewInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplate", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscribeEmailToNewsletter", + "description": "Subscribe the specified email to the store's newsletter.", + "args": [ + { + "name": "email", + "description": "The email address that will receive the store's newsletter.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscribeEmailToNewsletterOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "syncPaymentOrder", + "description": "Synchronizes the payment order details for further payment processing", + "args": [ + { + "name": "input", + "description": "Describes the variables needed to synchronize the payment order details", + "type": { + "kind": "INPUT_OBJECT", + "name": "SyncPaymentOrderInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateCartItems", + "description": "Modify items in the cart.", + "args": [ + { + "name": "input", + "description": "An input object that defines products to be updated.", + "type": { + "kind": "INPUT_OBJECT", + "name": "UpdateCartItemsInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UpdateCartItemsOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateCompany", + "description": "Update company information.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UpdateCompanyOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateCompanyRole", + "description": "Update company role information.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyRoleUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UpdateCompanyRoleOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateCompanyStructure", + "description": "Change the parent node of a company team within the current company context.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyStructureUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UpdateCompanyStructureOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateCompanyTeam", + "description": "Update company team data.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyTeamUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UpdateCompanyTeamOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateCompanyUser", + "description": "Update an existing company user.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyUserUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UpdateCompanyUserOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateCustomer", + "description": null, + "args": [ + { + "name": "input", + "description": "An input object that defines the customer characteristics to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerOutput", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `updateCustomerV2` instead." + }, + { + "name": "updateCustomerAddress", + "description": "Update the billing or shipping address of a customer or guest.", + "args": [ + { + "name": "id", + "description": "The ID assigned to the customer address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "An input object that contains changes to the customer address.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerAddressInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAddress", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `updateCustomerAddressV2` instead." + }, + { + "name": "updateCustomerAddressV2", + "description": "Update the billing or shipping address of a customer or guest.", + "args": [ + { + "name": "uid", + "description": "The unique ID of the customer address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "An input object that contains changes to the customer address.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerAddressInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateCustomerEmail", + "description": "Change the email address for the logged-in customer.", + "args": [ + { + "name": "email", + "description": "The customer's email address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "password", + "description": "The customer's password.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateCustomerV2", + "description": "Update the customer's personal information.", + "args": [ + { + "name": "input", + "description": "An input object that defines the customer characteristics to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateGiftRegistry", + "description": "Update the specified gift registry.", + "args": [ + { + "name": "giftRegistryUid", + "description": "The unique ID of an existing gift registry.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "giftRegistry", + "description": "An input object that defines which fields to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "UpdateGiftRegistryInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UpdateGiftRegistryOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateGiftRegistryItems", + "description": "Update the specified items in the gift registry.", + "args": [ + { + "name": "giftRegistryUid", + "description": "The unique ID of the gift registry.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "items", + "description": "An array of items to be updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "UpdateGiftRegistryItemInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UpdateGiftRegistryItemsOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateGiftRegistryRegistrants", + "description": "Modify the properties of one or more gift registry registrants.", + "args": [ + { + "name": "giftRegistryUid", + "description": "The unique ID of the gift registry.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "registrants", + "description": "An array of registrants to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "UpdateGiftRegistryRegistrantInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UpdateGiftRegistryRegistrantsOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateNegotiableQuoteQuantities", + "description": "Change the quantity of one or more items in an existing negotiable quote.", + "args": [ + { + "name": "input", + "description": "An input object that changes the quantity of one or more items in a negotiable quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "UpdateNegotiableQuoteQuantitiesInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UpdateNegotiableQuoteItemsQuantityOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateNegotiableQuoteTemplateQuantities", + "description": "Change the quantity of one or more items in an existing negotiable quote template.", + "args": [ + { + "name": "input", + "description": "An input object that changes the quantity of one or more items in a negotiable quote template.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "UpdateNegotiableQuoteTemplateQuantitiesInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UpdateNegotiableQuoteTemplateItemsQuantityOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateProductsInWishlist", + "description": "Update one or more products in the specified wish list.", + "args": [ + { + "name": "wishlistId", + "description": "The ID of a wish list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "wishlistItems", + "description": "An array of items to be updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "WishlistItemUpdateInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UpdateProductsInWishlistOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatePurchaseOrderApprovalRule", + "description": "Update existing purchase order approval rules.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "UpdatePurchaseOrderApprovalRuleInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PurchaseOrderApprovalRule", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateRequisitionList", + "description": "Rename a requisition list and change its description.", + "args": [ + { + "name": "requisitionListUid", + "description": "The unique ID of the requisition list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "UpdateRequisitionListInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UpdateRequisitionListOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateRequisitionListItems", + "description": "Update items in a requisition list.", + "args": [ + { + "name": "requisitionListUid", + "description": "The unique ID of the requisition list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "requisitionListItems", + "description": "Items to be updated in the requisition list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "UpdateRequisitionListItemsInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UpdateRequisitionListItemsOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateWishlist", + "description": "Change the name and visibility of the specified wish list.", + "args": [ + { + "name": "wishlistId", + "description": "The ID of the wish list to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The name assigned to the wish list.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "visibility", + "description": "Indicates the visibility of the wish list.", + "type": { + "kind": "ENUM", + "name": "WishlistVisibilityEnum", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UpdateWishlistOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "validatePurchaseOrders", + "description": "Validate purchase orders.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ValidatePurchaseOrdersInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ValidatePurchaseOrdersOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "description": "Defines the comparison operators that can be used in a filter.", + "fields": null, + "inputFields": [ + { + "name": "eq", + "description": "Equals.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "finset", + "description": "", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "from", + "description": "From. Must be used with the `to` field.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "gt", + "description": "Greater than.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "gteq", + "description": "Greater than or equal to.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "in", + "description": "In. The value can contain a set of comma-separated values.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "like", + "description": "Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lt", + "description": "Less than.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lteq", + "description": "Less than or equal to.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "moreq", + "description": "More than or equal to.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "neq", + "description": "Not equal to.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "nin", + "description": "Not in. The value can contain a set of comma-separated values.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "notnull", + "description": "Not null.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "null", + "description": "Is null.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "to", + "description": "To. Must be used with the `from` field.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "description": "Defines a filter that matches the input exactly.", + "fields": null, + "inputFields": [ + { + "name": "eq", + "description": "Use this attribute to exactly match the specified string. For example, to filter on a specific category ID, specify a value such as `5`.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "in", + "description": "Use this attribute to filter on an array of values. For example, to filter on category IDs 4, 5, and 6, specify a value of `[\"4\", \"5\", \"6\"]`.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FilterRangeTypeInput", + "description": "Defines a filter that matches a range of values, such as prices or dates.", + "fields": null, + "inputFields": [ + { + "name": "from", + "description": "Use this attribute to specify the lowest possible value in the range.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "to", + "description": "Use this attribute to specify the highest possible value in the range.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FilterMatchTypeInput", + "description": "Defines a filter that performs a fuzzy search.", + "fields": null, + "inputFields": [ + { + "name": "match", + "description": "Use this attribute to fuzzy match the specified string. For example, to filter on a specific SKU, specify a value such as `24-MB01`.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "match_type", + "description": "Filter match type for fine-tuned results. Possible values FULL or PARTIAL. If match_type is not provided, returned results will default to FULL match.", + "type": { + "kind": "ENUM", + "name": "FilterMatchTypeEnum", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FilterMatchTypeEnum", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FULL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PARTIAL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FilterStringTypeInput", + "description": "Defines a filter for an input string.", + "fields": null, + "inputFields": [ + { + "name": "eq", + "description": "Filters items that are exactly the same as the specified string.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "in", + "description": "Filters items that are exactly the same as entries specified in an array of strings.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "match", + "description": "Defines a filter that performs a fuzzy search using the specified string.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "description": "Provides navigation for the query response.", + "fields": [ + { + "name": "current_page", + "description": "The specific page to return.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_size", + "description": "The maximum number of items to return per page of results.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_pages", + "description": "The total number of pages in the response.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SortEnum", + "description": "Indicates whether to return results in ascending or descending order.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ASC", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DESC", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ComplexTextValue", + "description": "", + "fields": [ + { + "name": "html", + "description": "Text that can contain HTML tags.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Money", + "description": "Defines a monetary value, including a numeric value and a currency code.", + "fields": [ + { + "name": "currency", + "description": "A three-letter currency code, such as USD or EUR.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CurrencyEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "A number expressing a monetary value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CurrencyEnum", + "description": "The list of available currency codes.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "AFN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ALL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AZN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DZD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AOA", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ARS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AMD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AWG", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AUD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BSD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BHD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BDT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BBD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BYN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BZD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BMD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BTN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BOB", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BAM", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BWP", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BRL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GBP", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BND", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BGN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BUK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BIF", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KHR", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CAD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CVE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CZK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KYD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GQE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CLP", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CNY", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COP", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KMF", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CDF", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CRC", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HRK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUP", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DKK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DJF", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DOP", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "XCD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EGP", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SVC", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ERN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EEK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ETB", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EUR", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FKP", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FJD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GMD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GEK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GEL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GHS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GIP", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GTQ", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GNF", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GYD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HTG", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HNL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HKD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HUF", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ISK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INR", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IDR", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IRR", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IQD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ILS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JMD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JPY", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JOD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KZT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KES", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KWD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KGS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LAK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LVL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LBP", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LSL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LRD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LYD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LTL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MOP", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MKD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MGA", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MWK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MYR", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MVR", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LSM", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MRO", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MUR", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MXN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MDL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MAD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MZN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MMK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NPR", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ANG", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "YTL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NZD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NIC", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NGN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KPW", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OMR", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PKR", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAB", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PGK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PYG", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PEN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PHP", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PLN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "QAR", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RHD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RON", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RUB", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RWF", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHP", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SAR", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RSD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCR", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SLL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SGD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SKK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SBD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SOS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZAR", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KRW", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LKR", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SDG", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SRD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SZL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SEK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CHF", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SYP", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TWD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TJS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TZS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "THB", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOP", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TTD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TND", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TMM", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "USD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UGX", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UAH", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UYU", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UZS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VUV", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VEB", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VEF", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VND", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CHE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CHW", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "XOF", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WST", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "YER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZMK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZWD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TRY", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AZM", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ROL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TRL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "XPF", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "EnteredOptionInput", + "description": "Defines a customer-entered option.", + "fields": null, + "inputFields": [ + { + "name": "uid", + "description": "The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "Text the customer entered.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "BatchMutationStatus", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SUCCESS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILURE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MIXED_RESULTS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "ErrorInterface", + "description": "", + "fields": [ + { + "name": "message", + "description": "The returned error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "NoSuchEntityUidError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "InternalError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteInvalidStateError", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "NoSuchEntityUidError", + "description": "Contains an error message when an invalid UID was specified.", + "fields": [ + { + "name": "message", + "description": "The returned error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The specified invalid unique ID of an object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ErrorInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InternalError", + "description": "Contains an error message when an internal error occurred.", + "fields": [ + { + "name": "message", + "description": "The returned error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ErrorInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomAttributeMetadata", + "description": "Defines an array of custom attributes.", + "fields": [ + { + "name": "items", + "description": "An array of attributes.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Attribute", + "description": "Contains details about the attribute, including the code and type.", + "fields": [ + { + "name": "attribute_code", + "description": "The unique identifier for an attribute code. This value should be in lowercase letters without spaces.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attribute_options", + "description": "Attribute options list.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AttributeOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attribute_type", + "description": "The data type of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "entity_type", + "description": "The type of entity that defines the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "input_type", + "description": "The frontend input type of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "storefront_properties", + "description": "Details about the storefront properties configured for the attribute.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "StorefrontProperties", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StorefrontProperties", + "description": "Indicates where an attribute can be displayed.", + "fields": [ + { + "name": "position", + "description": "The relative position of the attribute in the layered navigation block.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "use_in_layered_navigation", + "description": "Indicates whether the attribute is filterable with results, without results, or not at all.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UseInLayeredNavigationOptions", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "use_in_product_listing", + "description": "Indicates whether the attribute is displayed in product listings.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "use_in_search_results_layered_navigation", + "description": "Indicates whether the attribute can be used in layered navigation on search results pages.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "visible_on_catalog_pages", + "description": "Indicates whether the attribute is displayed on product pages.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "UseInLayeredNavigationOptions", + "description": "Defines whether the attribute is filterable in layered navigation.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NO", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FILTERABLE_WITH_RESULTS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FILTERABLE_NO_RESULT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AttributeOption", + "description": "Defines an attribute option.", + "fields": [ + { + "name": "label", + "description": "The label assigned to the attribute option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The attribute option value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "description": "Defines the attribute characteristics to search for the `attribute_code` and `entity_type` to search.", + "fields": null, + "inputFields": [ + { + "name": "attribute_code", + "description": "The unique identifier for an attribute code. This value should be in lowercase letters without spaces.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "entity_type", + "description": "The type of entity that defines the attribute.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AttributesMetadataOutput", + "description": "Metadata of EAV attributes.", + "fields": [ + { + "name": "errors", + "description": "Errors of retrieving certain attributes metadata.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AttributeMetadataError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "Requested attributes metadata.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CustomAttributeMetadataInterface", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AttributeMetadataError", + "description": "Attribute metadata retrieval error.", + "fields": [ + { + "name": "message", + "description": "Attribute metadata retrieval error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "Attribute metadata retrieval error type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AttributeMetadataErrorType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AttributeMetadataErrorType", + "description": "Attribute metadata retrieval error types.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ENTITY_NOT_FOUND", + "description": "The requested entity was not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ATTRIBUTE_NOT_FOUND", + "description": "The requested attribute was not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FILTER_NOT_FOUND", + "description": "The filter cannot be applied as it does not belong to the entity", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNDEFINED", + "description": "Not categorized error, see the error message.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "CustomAttributeMetadataInterface", + "description": "An interface containing fields that define the EAV attribute.", + "fields": [ + { + "name": "code", + "description": "The unique identifier for an attribute code. This value should be in lowercase letters without spaces.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "default_value", + "description": "Default attribute value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "entity_type", + "description": "The type of entity that defines the attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AttributeEntityTypeEnum", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "frontend_class", + "description": "The frontend class of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "frontend_input", + "description": "The frontend input type of the attribute.", + "args": [], + "type": { + "kind": "ENUM", + "name": "AttributeFrontendInputEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_required", + "description": "Whether the attribute value is required.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_unique", + "description": "Whether the attribute value must be unique.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The label assigned to the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "Attribute options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CustomAttributeOptionInterface", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AttributeMetadata", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CatalogAttributeMetadata", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomerAttributeMetadata", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ReturnItemAttributeMetadata", + "ofType": null + } + ] + }, + { + "kind": "INTERFACE", + "name": "CustomAttributeOptionInterface", + "description": "", + "fields": [ + { + "name": "is_default", + "description": "Is the option value default.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The label assigned to the attribute option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The attribute option value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AttributeOptionMetadata", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "AttributeOptionMetadata", + "description": "Base EAV implementation of CustomAttributeOptionInterface.", + "fields": [ + { + "name": "is_default", + "description": "Is the option value default.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The label assigned to the attribute option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The attribute option value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CustomAttributeOptionInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AttributeMetadata", + "description": "Base EAV implementation of CustomAttributeMetadataInterface.", + "fields": [ + { + "name": "code", + "description": "The unique identifier for an attribute code. This value should be in lowercase letters without spaces.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "default_value", + "description": "Default attribute value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "entity_type", + "description": "The type of entity that defines the attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AttributeEntityTypeEnum", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "frontend_class", + "description": "The frontend class of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "frontend_input", + "description": "The frontend input type of the attribute.", + "args": [], + "type": { + "kind": "ENUM", + "name": "AttributeFrontendInputEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_required", + "description": "Whether the attribute value is required.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_unique", + "description": "Whether the attribute value must be unique.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The label assigned to the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "Attribute options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CustomAttributeOptionInterface", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CustomAttributeMetadataInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AttributeEntityTypeEnum", + "description": "List of all entity types. Populated by the modules introducing EAV entities.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CATALOG_PRODUCT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATALOG_CATEGORY", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_ADDRESS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RMA_ITEM", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AttributeFrontendInputEnum", + "description": "EAV attribute frontend input types.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BOOLEAN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DATE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DATETIME", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FILE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GALLERY", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HIDDEN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IMAGE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MEDIA_IMAGE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MULTILINE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MULTISELECT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELECT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TEXT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TEXTAREA", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WEIGHT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNDEFINED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AttributesFormOutput", + "description": "Metadata of EAV attributes associated to form", + "fields": [ + { + "name": "errors", + "description": "Errors of retrieving certain attributes metadata.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AttributeMetadataError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "Requested attributes metadata.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CustomAttributeMetadataInterface", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "description": "", + "fields": [ + { + "name": "code", + "description": "The attribute code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AttributeValue", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "AttributeSelectedOptions", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCartAttributeValue", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "AttributeValue", + "description": "", + "fields": [ + { + "name": "code", + "description": "The attribute code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The attribute value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AttributeSelectedOptions", + "description": "", + "fields": [ + { + "name": "code", + "description": "The attribute code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "selected_options", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "AttributeSelectedOptionInterface", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "AttributeSelectedOptionInterface", + "description": "", + "fields": [ + { + "name": "label", + "description": "The attribute selected option label.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The attribute selected option value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AttributeSelectedOption", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "AttributeSelectedOption", + "description": "", + "fields": [ + { + "name": "label", + "description": "The attribute selected option label.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The attribute selected option value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "AttributeSelectedOptionInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AttributeValueInput", + "description": "Specifies the value for attribute.", + "fields": null, + "inputFields": [ + { + "name": "attribute_code", + "description": "The code of the attribute.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "selected_options", + "description": "An array containing selected options for a select or multiselect attribute.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeInputSelectedOption", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The value assigned to the attribute.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AttributeInputSelectedOption", + "description": "Specifies selected option for a select or multiselect attribute value.", + "fields": null, + "inputFields": [ + { + "name": "value", + "description": "The attribute option value.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", + "description": "An input object that specifies the filters used for attributes.", + "fields": null, + "inputFields": [ + { + "name": "is_comparable", + "description": "Whether a product or category attribute can be compared against another or not.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "is_filterable", + "description": "Whether a product or category attribute can be filtered or not.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "is_filterable_in_search", + "description": "Whether a product or category attribute can be filtered in search or not.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "is_html_allowed_on_front", + "description": "Whether a product or category attribute can use HTML on front or not.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "is_searchable", + "description": "Whether a product or category attribute can be searched or not.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "is_used_for_customer_segment", + "description": "Whether a customer or customer address attribute is used for customer segment or not.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "is_used_for_price_rules", + "description": "Whether a product or category attribute can be used for price rules or not.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "is_used_for_promo_rules", + "description": "Whether a product or category attribute is used for promo rules or not.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "is_visible_in_advanced_search", + "description": "Whether a product or category attribute is visible in advanced search or not.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "is_visible_on_front", + "description": "Whether a product or category attribute is visible on front or not.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "is_wysiwyg_enabled", + "description": "Whether a product or category attribute has WYSIWYG enabled or not.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "used_in_product_listing", + "description": "Whether a product or category attribute is used in product listing or not.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StoreConfig", + "description": "Contains information about a store's configuration.", + "fields": [ + { + "name": "absolute_footer", + "description": "Contains scripts that must be included in the HTML before the closing `` tag.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "allow_gift_receipt", + "description": "Indicates if the gift sender has the option to send a gift receipt. Possible values: 1 (Yes) and 0 (No).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "allow_gift_wrapping_on_order", + "description": "Indicates whether gift wrapping can be added for the entire order. Possible values: 1 (Yes) and 0 (No).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "allow_gift_wrapping_on_order_items", + "description": "Indicates whether gift wrapping can be added for individual order items. Possible values: 1 (Yes) and 0 (No).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "allow_guests_to_write_product_reviews", + "description": "Indicates whether guest users can write product reviews. Possible values: 1 (Yes) and 0 (No).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "allow_items", + "description": "The value of the Allow Gift Messages for Order Items option", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "allow_order", + "description": "The value of the Allow Gift Messages on Order Level option", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "allow_printed_card", + "description": "Indicates if a printed card can accompany an order. Possible values: 1 (Yes) and 0 (No).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "autocomplete_on_storefront", + "description": "Indicates whether to enable autocomplete on login and forgot password forms.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "base_currency_code", + "description": "The base currency code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "base_link_url", + "description": "A fully-qualified URL that is used to create relative links to the `base_url`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "base_media_url", + "description": "The fully-qualified URL that specifies the location of media files.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "base_static_url", + "description": "The fully-qualified URL that specifies the location of static view files.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "base_url", + "description": "The store’s fully-qualified base URL.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_3dsecure_allowspecific", + "description": "Braintree 3D Secure, should 3D Secure be used for specific countries.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_3dsecure_always_request_3ds", + "description": "Braintree 3D Secure, always request 3D Secure flag.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_3dsecure_specificcountry", + "description": "Braintree 3D Secure, the specific countries to use 3D Secure in, to be used if allow specific is status is enabled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_3dsecure_threshold_amount", + "description": "Braintree 3D Secure, threshold above which 3D Secure should be requested.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_3dsecure_verify_3dsecure", + "description": "Braintree 3D Secure enabled/active status.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_ach_direct_debit_vault_active", + "description": "Braintree ACH vault status.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_applepay_merchant_name", + "description": "Braintree Apple Pay merchant name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_applepay_vault_active", + "description": "Braintree Apple Pay vault status.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_cc_vault_active", + "description": "Braintree cc vault status.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_cc_vault_cvv", + "description": "Braintree cc vault CVV re-verification enabled status.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_environment", + "description": "Braintree environment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_googlepay_btn_color", + "description": "Braintree Google Pay button color.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_googlepay_cctypes", + "description": "Braintree Google Pay Card types supported.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_googlepay_merchant_id", + "description": "Braintree Google Pay merchant ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_googlepay_vault_active", + "description": "Braintree Google Pay vault status.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_local_payment_allowed_methods", + "description": "Braintree Local Payment Methods allowed payment methods.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_local_payment_fallback_button_text", + "description": "Braintree Local Payment Methods fallback button text.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_local_payment_redirect_on_fail", + "description": "Braintree Local Payment Methods redirect URL on failed payment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_merchant_account_id", + "description": "Braintree Merchant Account ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_cart_type_credit_color", + "description": "Braintree PayPal Credit mini-cart & cart button style color.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_cart_type_credit_label", + "description": "Braintree PayPal Credit mini-cart & cart button style label.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_cart_type_credit_shape", + "description": "Braintree PayPal Credit mini-cart & cart button style shape.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_cart_type_credit_show", + "description": "Braintree PayPal Credit mini-cart & cart button show status.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_cart_type_messaging_layout", + "description": "Braintree PayPal Pay Later messaging mini-cart & cart style layout.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_cart_type_messaging_logo", + "description": "Braintree PayPal Pay Later messaging mini-cart & cart style logo.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_cart_type_messaging_logo_position", + "description": "Braintree PayPal Pay Later messaging mini-cart & cart style logo position.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_cart_type_messaging_show", + "description": "Braintree PayPal Pay Later messaging mini-cart & cart show status.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_cart_type_messaging_text_color", + "description": "Braintree PayPal Pay Later messaging checkout style text color.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_cart_type_paylater_color", + "description": "Braintree PayPal Pay Later mini-cart & cart button style color.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_cart_type_paylater_label", + "description": "Braintree PayPal Pay Later mini-cart & cart button style label.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_cart_type_paylater_shape", + "description": "Braintree PayPal Pay Later mini-cart & cart button style shape.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_cart_type_paylater_show", + "description": "Braintree PayPal Pay Later mini-cart & cart button show status.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_cart_type_paypal_color", + "description": "Braintree PayPal mini-cart & cart button style color.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_cart_type_paypal_label", + "description": "Braintree PayPal mini-cart & cart button style label.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_cart_type_paypal_shape", + "description": "Braintree PayPal mini-cart & cart button style shape.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_cart_type_paypal_show", + "description": "Braintree PayPal mini-cart & cart button show.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_checkout_type_credit_color", + "description": "Braintree PayPal Credit checkout button style color.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_checkout_type_credit_label", + "description": "Braintree PayPal Credit checkout button style label.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_checkout_type_credit_shape", + "description": "Braintree PayPal Credit checkout button style shape.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_checkout_type_credit_show", + "description": "Braintree PayPal Credit checkout button show status.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_checkout_type_messaging_layout", + "description": "Braintree PayPal Pay Later messaging checkout style layout.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_checkout_type_messaging_logo", + "description": "Braintree PayPal Pay Later messaging checkout style logo.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_checkout_type_messaging_logo_position", + "description": "Braintree PayPal Pay Later messaging checkout style logo position.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_checkout_type_messaging_show", + "description": "Braintree PayPal Pay Later messaging checkout show status.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_checkout_type_messaging_text_color", + "description": "Braintree PayPal Pay Later messaging checkout style text color.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_checkout_type_paylater_color", + "description": "Braintree PayPal Pay Later checkout button style color.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_checkout_type_paylater_label", + "description": "Braintree PayPal Pay Later checkout button style label.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_checkout_type_paylater_shape", + "description": "Braintree PayPal Pay Later checkout button style shape.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_checkout_type_paylater_show", + "description": "Braintree PayPal Pay Later checkout button show status.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_checkout_type_paypal_color", + "description": "Braintree PayPal checkout button style color.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_checkout_type_paypal_label", + "description": "Braintree PayPal checkout button style label.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_checkout_type_paypal_shape", + "description": "Braintree PayPal checkout button style shape.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_checkout_type_paypal_show", + "description": "Braintree PayPal checkout button show.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_productpage_type_credit_color", + "description": "Braintree PayPal Credit PDP button style color.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_productpage_type_credit_label", + "description": "Braintree PayPal Credit PDP button style label.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_productpage_type_credit_shape", + "description": "Braintree PayPal Credit PDP button style shape.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_productpage_type_credit_show", + "description": "Braintree PayPal Credit PDP button show status.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_productpage_type_messaging_layout", + "description": "Braintree PayPal Pay Later messaging PDP style layout.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_productpage_type_messaging_logo", + "description": "Braintree PayPal Pay Later messaging PDP style logo.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_productpage_type_messaging_logo_position", + "description": "Braintree PayPal Pay Later messaging PDP style logo position.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_productpage_type_messaging_show", + "description": "Braintree PayPal Pay Later messaging PDP show status.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_productpage_type_messaging_text_color", + "description": "Braintree PayPal Pay Later messaging PDP style text color.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_productpage_type_paylater_color", + "description": "Braintree PayPal Pay Later PDP button style color.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_productpage_type_paylater_label", + "description": "Braintree PayPal Pay Later PDP button style label.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_productpage_type_paylater_shape", + "description": "Braintree PayPal Pay Later PDP button style shape.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_productpage_type_paylater_show", + "description": "Braintree PayPal Pay Later PDP button show status.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_productpage_type_paypal_color", + "description": "Braintree PayPal PDP button style color.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_productpage_type_paypal_label", + "description": "Braintree PayPal PDP button style label.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_productpage_type_paypal_shape", + "description": "Braintree PayPal PDP button style shape.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_button_location_productpage_type_paypal_show", + "description": "Braintree PayPal PDP button show.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_credit_uk_merchant_name", + "description": "Braintree PayPal Credit Merchant Name on the FCA Register.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_display_on_shopping_cart", + "description": "Should display Braintree PayPal in mini-cart & cart?", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_merchant_country", + "description": "Braintree PayPal merchant's country.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_merchant_name_override", + "description": "Braintree PayPal override for Merchant Name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_require_billing_address", + "description": "Does Braintree PayPal require the customer's billing address?", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_send_cart_line_items", + "description": "Does Braintree PayPal require the order line items?", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "braintree_paypal_vault_active", + "description": "Braintree PayPal vault status.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cart_expires_in_days", + "description": "checkout/cart/delete_quote_after: quote lifetime in days.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cart_gift_wrapping", + "description": "Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cart_merge_preference", + "description": "Configuration data from checkout/cart/cart_merge_preference", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cart_printed_card", + "description": "Indicates if printed card prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cart_summary_display_quantity", + "description": "checkout/cart_link/use_qty: what to show in the display cart summary, number of items or item quantities.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "catalog_default_sort_by", + "description": "The default sort order of the search results list.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "category_fixed_product_tax_display_setting", + "description": "Corresponds to the 'Display Prices In Product Lists' field in the Admin. It indicates how FPT information is displayed on category pages.", + "args": [], + "type": { + "kind": "ENUM", + "name": "FixedProductTaxDisplaySettings", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "category_url_suffix", + "description": "The suffix applied to category pages, such as `.htm` or `.html`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "check_money_order_enable_for_specific_countries", + "description": "Indicates whether only specific countries can use this payment method.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "check_money_order_enabled", + "description": "Indicates whether the Check/Money Order payment method is enabled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "check_money_order_make_check_payable_to", + "description": "The name of the party to whom the check must be payable.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "check_money_order_max_order_total", + "description": "The maximum order amount required to qualify for the Check/Money Order payment method.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "check_money_order_min_order_total", + "description": "The minimum order amount required to qualify for the Check/Money Order payment method.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "check_money_order_new_order_status", + "description": "The status of new orders placed using the Check/Money Order payment method.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "check_money_order_payment_from_specific_countries", + "description": "A comma-separated list of specific countries allowed to use the Check/Money Order payment method.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "check_money_order_send_check_to", + "description": "The full street address or PO Box where the checks are mailed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "check_money_order_sort_order", + "description": "A number indicating the position of the Check/Money Order payment method in the list of available payment methods during checkout.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "check_money_order_title", + "description": "The title of the Check/Money Order payment method displayed on the storefront.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cms_home_page", + "description": "The name of the CMS page that identifies the home page for the store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cms_no_cookies", + "description": "A specific CMS page that displays when cookies are not enabled for the browser.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cms_no_route", + "description": "A specific CMS page that displays when a 404 'Page Not Found' error occurs.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "A code assigned to the store to identify it.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `store_code` instead." + }, + { + "name": "configurable_product_image", + "description": "checkout/cart/configurable_product_image: which image to use for configurable products.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ProductImageThumbnail", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "configurable_thumbnail_source", + "description": "Indicates whether the `parent` or child (`itself`) thumbnail should be used in the cart for configurable products.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "contact_enabled", + "description": "Indicates whether the Contact Us form in enabled.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "copyright", + "description": "The copyright statement that appears at the bottom of each page.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "countries_with_required_region", + "description": "Extended Config Data - general/region/state_required", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "create_account_confirmation", + "description": "Indicates if the new accounts need confirmation.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer_access_token_lifetime", + "description": "Customer access token lifetime.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "default_country", + "description": "Extended Config Data - general/country/default", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "default_description", + "description": "The description that provides a summary of your site for search engine listings. It should not be more than 160 characters in length.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "default_display_currency_code", + "description": "The default display currency code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "default_keywords", + "description": "A series of keywords that describe your store, each separated by a comma.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "default_title", + "description": "The title that appears at the title bar of each page when viewed in a browser.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "demonotice", + "description": "Controls the display of the demo store notice at the top of the page. Options: 0 (No) or 1 (Yes).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "display_product_prices_in_catalog", + "description": "Configuration data from tax/display/type", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "display_shipping_prices", + "description": "Configuration data from tax/display/shipping", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "display_state_if_optional", + "description": "Extended Config Data - general/region/display_all", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "enable_multiple_wishlists", + "description": "Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fixed_product_taxes_apply_tax_to_fpt", + "description": "Configuration data from tax/weee/apply_vat", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fixed_product_taxes_display_prices_in_emails", + "description": "Configuration data from tax/weee/display_email", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fixed_product_taxes_display_prices_in_product_lists", + "description": "Configuration data from tax/weee/display_list", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fixed_product_taxes_display_prices_in_sales_modules", + "description": "Configuration data from tax/weee/display_sales", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fixed_product_taxes_display_prices_on_product_view_page", + "description": "Configuration data from tax/weee/display", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fixed_product_taxes_enable", + "description": "Configuration data from tax/weee/enable", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fixed_product_taxes_include_fpt_in_subtotal", + "description": "Configuration data from tax/weee/include_in_subtotal", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "front", + "description": "The landing page that is associated with the base URL.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "graphql_share_customer_group", + "description": "Configuration data from customer/account_information/graphql_share_customer_group", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "grid_per_page", + "description": "The default number of products per page in Grid View.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "grid_per_page_values", + "description": "A list of numbers that define how many products can be displayed in Grid View.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "grouped_product_image", + "description": "checkout/cart/grouped_product_image: which image to use for grouped products.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ProductImageThumbnail", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "head_includes", + "description": "Scripts that must be included in the HTML before the closing `` tag.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "head_shortcut_icon", + "description": "The small graphic image (favicon) that appears in the address bar and tab of the browser.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "header_logo_src", + "description": "The path to the logo that appears in the header.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID number assigned to the store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `store_code` instead." + }, + { + "name": "is_checkout_agreements_enabled", + "description": "Configuration data from checkout/options/enable_agreements", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_default_store", + "description": "Indicates whether the store view has been designated as the default within the store group.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_default_store_group", + "description": "Indicates whether the store group has been designated as the default within the website.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_guest_checkout_enabled", + "description": "checkout/options/guest_checkout: whether the guest checkout is enabled or not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_negotiable_quote_active", + "description": "Indicates whether negotiable quote functionality is enabled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_one_page_checkout_enabled", + "description": "checkout/options/onepage_checkout_enabled: whether the one page checkout is enabled or not", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_requisition_list_active", + "description": "Indicates whether requisition lists are enabled. Possible values: 1 (Yes) and 0 (No).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "list_mode", + "description": "The format of the search results list.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "list_per_page", + "description": "The default number of products per page in List View.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "list_per_page_values", + "description": "A list of numbers that define how many products can be displayed in List View.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locale", + "description": "The store locale.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "logo_alt", + "description": "The Alt text that is associated with the logo.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "logo_height", + "description": "The height of the logo image, in pixels.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "logo_width", + "description": "The width of the logo image, in pixels.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "magento_reward_general_is_enabled", + "description": "Indicates whether reward points functionality is enabled. Possible values: 1 (Enabled) and 0 (Disabled).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "magento_reward_general_is_enabled_on_front", + "description": "Indicates whether reward points functionality is enabled on the storefront. Possible values: 1 (Enabled) and 0 (Disabled).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "magento_reward_general_min_points_balance", + "description": "The minimum point balance customers must have before they can redeem them. A null value indicates no minimum.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "magento_reward_general_publish_history", + "description": "When enabled, customers can see a detailed history of their reward points. Possible values: 1 (Enabled) and 0 (Disabled).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "magento_reward_points_invitation_customer", + "description": "The number of points for a referral when an invitee registers on the site.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "magento_reward_points_invitation_customer_limit", + "description": "The maximum number of registration referrals that will qualify for rewards. A null value indicates no limit.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "magento_reward_points_invitation_order", + "description": "The number of points for a referral, when an invitee places their first order on the site.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "magento_reward_points_invitation_order_limit", + "description": "The number of order conversions that can earn points for the customer who sends the invitation. A null value indicates no limit.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "magento_reward_points_newsletter", + "description": "The number of points earned by registered customers who subscribe to a newsletter.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "magento_reward_points_order", + "description": "Indicates customers earn points for shopping according to the reward point exchange rate. In Luma, this also controls whether to show a message in the shopping cart about the rewards points earned for the purchase, as well as the customer’s current reward point balance.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "magento_reward_points_register", + "description": "The number of points customer gets for registering.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "magento_reward_points_review", + "description": "The number of points for writing a review.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "magento_reward_points_review_limit", + "description": "The maximum number of reviews that will qualify for the rewards. A null value indicates no limit.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "magento_wishlist_general_is_enabled", + "description": "Indicates whether wishlists are enabled (1) or disabled (0).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "max_items_in_order_summary", + "description": "checkout/options/max_items_display_count: maximum number of items to display in order summary.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maximum_number_of_wishlists", + "description": "If multiple wish lists are enabled, the maximum number of wish lists the customer can have.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minicart_display", + "description": "checkout/sidebar/display: whether to display the minicart or not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minicart_max_items", + "description": "checkout/sidebar/count: maximum number of items to show in minicart.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minimum_password_length", + "description": "The minimum number of characters required for a valid password.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "newsletter_enabled", + "description": "Indicates whether newsletters are enabled.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "no_route", + "description": "The default page that displays when a 404 'Page not Found' error occurs.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "optional_zip_countries", + "description": "Extended Config Data - general/country/optional_zip_countries", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_cancellation_enabled", + "description": "Indicates whether orders can be cancelled by customers or not.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_cancellation_reasons", + "description": "An array containing available cancellation reasons.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CancellationReason", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders_invoices_credit_memos_display_full_summary", + "description": "Configuration data from tax/sales_display/full_summary", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders_invoices_credit_memos_display_grandtotal", + "description": "Configuration data from tax/sales_display/grandtotal", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders_invoices_credit_memos_display_price", + "description": "Configuration data from tax/sales_display/price", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders_invoices_credit_memos_display_shipping_amount", + "description": "Configuration data from tax/sales_display/shipping", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders_invoices_credit_memos_display_subtotal", + "description": "Configuration data from tax/sales_display/subtotal", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders_invoices_credit_memos_display_zero_tax", + "description": "Configuration data from tax/sales_display/zero_tax", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_payflowpro_cc_vault_active", + "description": "Payflow Pro vault status.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "printed_card_price", + "description": "The default price of a printed card that accompanies an order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use printed_card_priceV2 instead" + }, + { + "name": "printed_card_priceV2", + "description": "The default price of a printed card that accompanies an order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_fixed_product_tax_display_setting", + "description": "Corresponds to the 'Display Prices On Product View Page' field in the Admin. It indicates how FPT information is displayed on product pages.", + "args": [], + "type": { + "kind": "ENUM", + "name": "FixedProductTaxDisplaySettings", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_reviews_enabled", + "description": "Indicates whether product reviews are enabled. Possible values: 1 (Yes) and 0 (No).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_url_suffix", + "description": "The suffix applied to product pages, such as `.htm` or `.html`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quickorder_active", + "description": "Indicates whether quick order functionality is enabled.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "required_character_classes_number", + "description": "The number of different character classes (lowercase, uppercase, digits, special characters) required in a password.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returns_enabled", + "description": "Indicates whether RMA is enabled on the storefront. Possible values: enabled/disabled.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "root_category_id", + "description": "The ID of the root category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `root_category_uid` instead." + }, + { + "name": "root_category_uid", + "description": "The unique ID for a `CategoryInterface` object.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sales_fixed_product_tax_display_setting", + "description": "Corresponds to the 'Display Prices In Sales Modules' field in the Admin. It indicates how FPT information is displayed on cart, checkout, and order pages.", + "args": [], + "type": { + "kind": "ENUM", + "name": "FixedProductTaxDisplaySettings", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sales_gift_wrapping", + "description": "Indicates if gift wrapping prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sales_printed_card", + "description": "Indicates if printed card prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "secure_base_link_url", + "description": "A secure fully-qualified URL that is used to create relative links to the `base_url`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "secure_base_media_url", + "description": "The secure fully-qualified URL that specifies the location of media files.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "secure_base_static_url", + "description": "The secure fully-qualified URL that specifies the location of static view files.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "secure_base_url", + "description": "The store’s fully-qualified secure base URL.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "send_friend", + "description": "Email to a Friend configuration.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SendFriendConfiguration", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "share_active_segments", + "description": "Configuration data from customer/magento_customersegment/share_active_segments", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "share_applied_cart_rule", + "description": "Configuration data from promo/graphql/share_applied_cart_rule", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopping_cart_display_full_summary", + "description": "Extended Config Data - tax/cart_display/full_summary", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopping_cart_display_grand_total", + "description": "Extended Config Data - tax/cart_display/grandtotal", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopping_cart_display_price", + "description": "Extended Config Data - tax/cart_display/price", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopping_cart_display_shipping", + "description": "Extended Config Data - tax/cart_display/shipping", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopping_cart_display_subtotal", + "description": "Extended Config Data - tax/cart_display/subtotal", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopping_cart_display_tax_gift_wrapping", + "description": "Extended Config Data - tax/cart_display/gift_wrapping", + "args": [], + "type": { + "kind": "ENUM", + "name": "TaxWrappingEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopping_cart_display_zero_tax", + "description": "Extended Config Data - tax/cart_display/zero_tax", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "show_cms_breadcrumbs", + "description": "Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "store_code", + "description": "The unique ID of the store view. In the Admin, this is called the Store View Code. When making a GraphQL call, assign this value to the `Store` header to provide the scope.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "store_group_code", + "description": "The unique ID assigned to the store group. In the Admin, this is called the Store Name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "store_group_name", + "description": "The label assigned to the store group.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "store_name", + "description": "The label assigned to the store view.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "store_sort_order", + "description": "The store view sort order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "timezone", + "description": "The time zone of the store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title_prefix", + "description": "A prefix that appears before the title to create a two- or three-part title.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title_separator", + "description": "The character that separates the category name and subcategory in the browser title bar.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title_suffix", + "description": "A suffix that appears after the title to create a two- or three-part title.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "use_store_in_url", + "description": "Indicates whether the store code should be used in the URL.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "website_code", + "description": "The unique ID for the website.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "website_id", + "description": "The ID number assigned to the website store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "website_name", + "description": "The label assigned to the website.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "weight_unit", + "description": "The unit of weight.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "welcome", + "description": "Text that appears in the header of the page and includes the name of the logged in customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zero_subtotal_enable_for_specific_countries", + "description": "Indicates whether only specific countries can use this payment method.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zero_subtotal_enabled", + "description": "Indicates whether the Zero Subtotal payment method is enabled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zero_subtotal_new_order_status", + "description": "The status of new orders placed using the Zero Subtotal payment method.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zero_subtotal_payment_action", + "description": "When the new order status is 'Processing', this can be set to `authorize_capture` to automatically invoice all items that have a zero balance.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zero_subtotal_payment_from_specific_countries", + "description": "A comma-separated list of specific countries allowed to use the Zero Subtotal payment method.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zero_subtotal_sort_order", + "description": "A number indicating the position of the Zero Subtotal payment method in the list of available payment methods during checkout.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zero_subtotal_title", + "description": "The title of the Zero Subtotal payment method displayed on the storefront.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CmsPage", + "description": "Contains details about a CMS page.", + "fields": [ + { + "name": "content", + "description": "The content of the CMS page in raw HTML.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "content_heading", + "description": "The heading that displays at the top of the CMS page.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "identifier", + "description": "The ID of a CMS page.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_description", + "description": "A brief description of the page for search results listings.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_keywords", + "description": "A brief description of the page for search results listings.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_title", + "description": "A page title that is indexed by search engines and appears in search results listings.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_layout", + "description": "The design layout of the page, indicating the number of columns and navigation features used on the page.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The name that appears in the breadcrumb trail navigation and in the browser title bar and tab.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_key", + "description": "The URL key of the CMS page, which is often based on the `content_heading`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "RoutableInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CmsBlocks", + "description": "Contains an array CMS block items.", + "fields": [ + { + "name": "items", + "description": "An array of CMS blocks.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CmsBlock", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CmsBlock", + "description": "Contains details about a specific CMS block.", + "fields": [ + { + "name": "content", + "description": "The content of the CMS block in raw HTML.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "identifier", + "description": "The CMS block identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title assigned to the CMS block.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Website", + "description": "Deprecated. It should not be used on the storefront. Contains information about a website.", + "fields": [ + { + "name": "code", + "description": "A code assigned to the website to identify it.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "default_group_id", + "description": "The default group ID of the website.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "id", + "description": "The ID number assigned to the website.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "is_default", + "description": "Indicates whether this is the default website.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "name", + "description": "The website name. Websites use this name to identify it easier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "sort_order", + "description": "The attribute to use for sorting websites.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Price", + "description": "Deprecated. Use `ProductPrice` instead. Defines the price of a product as well as any tax-related adjustments.", + "fields": [ + { + "name": "adjustments", + "description": "An array that provides information about tax, weee, or weee_tax adjustments.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceAdjustment", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `ProductPrice` instead." + }, + { + "name": "amount", + "description": "The price of a product plus a three-letter currency code.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `ProductPrice` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceAdjustment", + "description": "Deprecated. Taxes will be included or excluded in the price. Defines the amount of money to apply as an adjustment, the type of adjustment to apply, and whether the item is included or excluded from the adjustment.", + "fields": [ + { + "name": "amount", + "description": "The amount of the price adjustment and its currency code.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "Indicates whether the adjustment involves tax, weee, or weee_tax.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PriceAdjustmentCodesEnum", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "`PriceAdjustment` is deprecated." + }, + { + "name": "description", + "description": "Indicates whether the entity described by the code attribute is included or excluded from the adjustment.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PriceAdjustmentDescriptionEnum", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "`PriceAdjustment` is deprecated." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceAdjustmentCodesEnum", + "description": "`PriceAdjustment.code` is deprecated.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TAX", + "description": "", + "isDeprecated": true, + "deprecationReason": "`PriceAdjustmentCodesEnum` is deprecated. Tax is included or excluded in the price. Tax is not shown separately in Catalog." + }, + { + "name": "WEEE", + "description": "", + "isDeprecated": true, + "deprecationReason": "WEEE code is deprecated. Use `fixed_product_taxes.label` instead." + }, + { + "name": "WEEE_TAX", + "description": "", + "isDeprecated": true, + "deprecationReason": "Use `fixed_product_taxes` instead. Tax is included or excluded in price. The tax is not shown separtely in Catalog." + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceAdjustmentDescriptionEnum", + "description": "`PriceAdjustmentDescriptionEnum` is deprecated. States whether a price adjustment is included or excluded.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INCLUDED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXCLUDED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceTypeEnum", + "description": "Defines the price type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FIXED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PERCENT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DYNAMIC", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomizableDateTypeEnum", + "description": "Defines the customizable date type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DATE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DATE_TIME", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TIME", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductPrices", + "description": "Deprecated. Use `PriceRange` instead. Contains the regular price of an item, as well as its minimum and maximum prices. Only composite products, which include bundle, configurable, and grouped products, can contain a minimum and maximum price.", + "fields": [ + { + "name": "maximalPrice", + "description": "The highest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the `to` value.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Price", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `PriceRange.maximum_price` instead." + }, + { + "name": "minimalPrice", + "description": "The lowest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the `from` value.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Price", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `PriceRange.minimum_price` instead." + }, + { + "name": "regularPrice", + "description": "The base price of a product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Price", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `regular_price` from `PriceRange.minimum_price` or `PriceRange.maximum_price` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRange", + "description": "Contains the price range for a product. If the product has a single price, the minimum and maximum price will be the same.", + "fields": [ + { + "name": "maximum_price", + "description": "The highest possible price for the product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductPrice", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minimum_price", + "description": "The lowest possible price for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductPrice", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductPrice", + "description": "Represents a product price.", + "fields": [ + { + "name": "discount", + "description": "The price discount. Represents the difference between the regular and final price.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductDiscount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "final_price", + "description": "The final price of the product after applying discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fixed_product_taxes", + "description": "An array of the multiple Fixed Product Taxes that can be applied to a product price.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FixedProductTax", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "regular_price", + "description": "The regular price of the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductDiscount", + "description": "Contains the discount applied to a product price.", + "fields": [ + { + "name": "amount_off", + "description": "The actual value of the discount.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "percent_off", + "description": "The discount expressed a percentage.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductLinks", + "description": "An implementation of `ProductLinksInterface`.", + "fields": [ + { + "name": "link_type", + "description": "One of related, associated, upsell, or crosssell.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "linked_product_sku", + "description": "The SKU of the linked product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "linked_product_type", + "description": "The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "The position within the list of product links.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The identifier of the linked product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ProductLinksInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "ProductLinksInterface", + "description": "Contains information about linked products, including the link type and product type of each item.", + "fields": [ + { + "name": "link_type", + "description": "One of related, associated, upsell, or crosssell.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "linked_product_sku", + "description": "The SKU of the linked product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "linked_product_type", + "description": "The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "The position within the list of product links.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The identifier of the linked product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "ProductLinks", + "ofType": null + } + ] + }, + { + "kind": "INTERFACE", + "name": "ProductInterface", + "description": "Contains fields that are common to all types of products.", + "fields": [ + { + "name": "activity", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "attribute_set_id", + "description": "The attribute set assigned to the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "categories", + "description": "The categories assigned to a product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CategoryInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "category_gear", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "climate", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "collar", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "color", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "country_of_manufacture", + "description": "The product's country of origin.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "Timestamp indicating when the product was created.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "crosssell_products", + "description": "An array of cross-sell products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_attributesV2", + "description": "Product custom attributes.", + "args": [ + { + "name": "filters", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductCustomAttributes", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "eco_collection", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "erin_recommends", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "features_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "format", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "gender", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "gift_message_available", + "description": "Returns a value indicating gift message availability for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_available", + "description": "Returns a value indicating gift wrapping availability for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_price", + "description": "Returns value and currency indicating gift wrapping price for the product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID number assigned to the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `uid` field instead." + }, + { + "name": "image", + "description": "The relative path to the main image on the product page.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_returnable", + "description": "Indicates whether the product can be returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "material", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "max_sale_qty", + "description": "Maximum Qty Allowed in Shopping Cart", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media_gallery", + "description": "An array of media gallery objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "MediaGalleryInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media_gallery_entries", + "description": "An array of MediaGalleryEntry objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaGalleryEntry", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `media_gallery` instead." + }, + { + "name": "meta_description", + "description": "A brief overview of the product for search results listings, maximum 255 characters.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_keyword", + "description": "A comma-separated list of keywords that are visible only to search engines.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_title", + "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "min_sale_qty", + "description": "Minimum Qty Allowed in Shopping Cart", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The product name. Customers use this name to identify the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "new", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "new_from_date", + "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "new_to_date", + "description": "The end date for new product listings.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "only_x_left_in_stock", + "description": "Product stock only x left count", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options_container", + "description": "If the product has multiple options, determines where they appear on the product page.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pattern", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "performance_fabric", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "price", + "description": "Indicates the price of an item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductPrices", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `price_range` for product price information." + }, + { + "name": "price_range", + "description": "The range of prices for the product", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRange", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_tiers", + "description": "An array of `TierPrice` objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TierPrice", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_links", + "description": "An array of `ProductLinks` objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductLinksInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "purpose", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "quantity", + "description": "Amount of available stock", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "related_products", + "description": "An array of related products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "review_count", + "description": "The total count of all the reviews given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reviews", + "description": "The list of products reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sale", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "short_description", + "description": "A short description of the product. Its use depends on the theme.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "size", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "sku", + "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sleeve", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "small_image", + "description": "The relative path to the small image, which is used on catalog pages.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "special_from_date", + "description": "The beginning date that a product has a special price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "special_price", + "description": "The discounted price of the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "special_to_date", + "description": "The end date for a product with a special price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staged", + "description": "Indicates whether the product is staged for a future campaign.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stock_status", + "description": "Stock status of the product", + "args": [], + "type": { + "kind": "ENUM", + "name": "ProductStockStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "strap_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_bottom", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_general", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "swatch_image", + "description": "The file name of a swatch image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "thumbnail", + "description": "The relative path to the product's thumbnail image.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tier_price", + "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." + }, + { + "name": "tier_prices", + "description": "An array of ProductTierPrices objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductTierPrices", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." + }, + { + "name": "type_id", + "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `__typename` instead." + }, + { + "name": "uid", + "description": "The unique ID for a `ProductInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "Timestamp indicating when the product was updated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "upsell_products", + "description": "An array of up-sell products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_key", + "description": "The part of the URL that identifies the product", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_path", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use product's `canonical_url` or url rewrites instead" + }, + { + "name": "url_rewrites", + "description": "URL rewrites list", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRewrite", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_suffix", + "description": "The part of the product URL that is appended after the url key", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "websites", + "description": "An array of websites in which the product is available.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Website", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "VirtualProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SimpleProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DownloadableProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BundleProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GroupedProduct", + "ofType": null + } + ] + }, + { + "kind": "INTERFACE", + "name": "PhysicalProductInterface", + "description": "Contains attributes specific to tangible products.", + "fields": [ + { + "name": "weight", + "description": "The weight of the item, in units defined by the store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SimpleProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BundleProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GroupedProduct", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "CustomizableAreaOption", + "description": "Contains information about a text area that is defined as part of a customizable option.", + "fields": [ + { + "name": "option_id", + "description": "Option ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" + }, + { + "name": "product_sku", + "description": "The Stock Keeping Unit of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "required", + "description": "Indicates whether the option is required.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The order in which the option is displayed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The display name for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CustomizableOptionInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "An object that defines a text area.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomizableAreaValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableAreaValue", + "description": "Defines the price and sku of a product whose page contains a customized text area.", + "fields": [ + { + "name": "max_characters", + "description": "The maximum number of characters that can be entered for this customizable option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price assigned to this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_type", + "description": "FIXED, PERCENT, or DYNAMIC.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PriceTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The Stock Keeping Unit for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CustomizableAreaValue` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CategoryTree", + "description": "Contains the hierarchy of categories.", + "fields": [ + { + "name": "automatic_sorting", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "available_sort_by", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "breadcrumbs", + "description": "An array of breadcrumb items.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Breadcrumb", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "children", + "description": "A tree of child categories.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CategoryTree", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "children_count", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cms_block", + "description": "Contains a category CMS block.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CmsBlock", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "The timestamp indicating when the category was created.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "custom_layout_update_file", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "default_sort_by", + "description": "The attribute to use for sorting.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "An optional description of the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "display_mode", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "filter_price_range", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "An ID that uniquely identifies the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." + }, + { + "name": "image", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "include_in_menu", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_anchor", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "landing_page", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "level", + "description": "The depth of the category within the tree.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_keywords", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_title", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The display name of the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "path", + "description": "The full category path.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "path_in_store", + "description": "The category path within the store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "The position of the category relative to other categories at the same level in tree.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_count", + "description": "The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "The list of products assigned to the category.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "sort", + "description": "The attributes to sort on, and whether to return the results in ascending or descending order.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ProductAttributeSortInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CategoryProducts", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staged", + "description": "Indicates whether the category is staged for a future campaign.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CategoryInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "The timestamp indicating when the category was updated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "url_key", + "description": "The URL key assigned to the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_path", + "description": "The URL path assigned to the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_suffix", + "description": "The part of the category URL that is appended after the url key", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CategoryInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "RoutableInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CategoryResult", + "description": "Contains a collection of `CategoryTree` objects and pagination information.", + "fields": [ + { + "name": "items", + "description": "A list of categories that match the filter criteria.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CategoryTree", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "An object that includes the `page_info` and `currentPage` values specified in the query.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The total number of categories that match the criteria.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableDateOption", + "description": "Contains information about a date picker that is defined as part of a customizable option.", + "fields": [ + { + "name": "option_id", + "description": "Option ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" + }, + { + "name": "product_sku", + "description": "The Stock Keeping Unit of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "required", + "description": "Indicates whether the option is required.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The order in which the option is displayed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The display name for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CustomizableOptionInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "An object that defines a date field in a customizable option.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomizableDateValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableDateValue", + "description": "Defines the price and sku of a product whose page contains a customized date picker.", + "fields": [ + { + "name": "price", + "description": "The price assigned to this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_type", + "description": "FIXED, PERCENT, or DYNAMIC.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PriceTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The Stock Keeping Unit for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "DATE, DATE_TIME or TIME", + "args": [], + "type": { + "kind": "ENUM", + "name": "CustomizableDateTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CustomizableDateValue` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableDropDownOption", + "description": "Contains information about a drop down menu that is defined as part of a customizable option.", + "fields": [ + { + "name": "option_id", + "description": "Option ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" + }, + { + "name": "required", + "description": "Indicates whether the option is required.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The order in which the option is displayed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The display name for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CustomizableOptionInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "An array that defines the set of options for a drop down menu.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomizableDropDownValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableDropDownValue", + "description": "Defines the price and sku of a product whose page contains a customized drop down menu.", + "fields": [ + { + "name": "option_type_id", + "description": "The ID assigned to the value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price assigned to this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_type", + "description": "FIXED, PERCENT, or DYNAMIC.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PriceTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The Stock Keeping Unit for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The order in which the option is displayed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The display name for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CustomizableDropDownValue` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableMultipleOption", + "description": "Contains information about a multiselect that is defined as part of a customizable option.", + "fields": [ + { + "name": "option_id", + "description": "Option ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" + }, + { + "name": "required", + "description": "Indicates whether the option is required.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The order in which the option is displayed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The display name for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CustomizableOptionInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "An array that defines the set of options for a multiselect.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomizableMultipleValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableMultipleValue", + "description": "Defines the price and sku of a product whose page contains a customized multiselect.", + "fields": [ + { + "name": "option_type_id", + "description": "The ID assigned to the value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price assigned to this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_type", + "description": "FIXED, PERCENT, or DYNAMIC.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PriceTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The Stock Keeping Unit for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The order in which the option is displayed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The display name for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CustomizableMultipleValue` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableFieldOption", + "description": "Contains information about a text field that is defined as part of a customizable option.", + "fields": [ + { + "name": "option_id", + "description": "Option ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" + }, + { + "name": "product_sku", + "description": "The Stock Keeping Unit of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "required", + "description": "Indicates whether the option is required.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The order in which the option is displayed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The display name for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CustomizableOptionInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "An object that defines a text field.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomizableFieldValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableFieldValue", + "description": "Defines the price and sku of a product whose page contains a customized text field.", + "fields": [ + { + "name": "max_characters", + "description": "The maximum number of characters that can be entered for this customizable option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price of the custom value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_type", + "description": "FIXED, PERCENT, or DYNAMIC.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PriceTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The Stock Keeping Unit for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CustomizableFieldValue` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableFileOption", + "description": "Contains information about a file picker that is defined as part of a customizable option.", + "fields": [ + { + "name": "option_id", + "description": "Option ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" + }, + { + "name": "product_sku", + "description": "The Stock Keeping Unit of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "required", + "description": "Indicates whether the option is required.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The order in which the option is displayed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The display name for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CustomizableOptionInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "An object that defines a file value.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomizableFileValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableFileValue", + "description": "Defines the price and sku of a product whose page contains a customized file picker.", + "fields": [ + { + "name": "file_extension", + "description": "The file extension to accept.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image_size_x", + "description": "The maximum width of an image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image_size_y", + "description": "The maximum height of an image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price assigned to this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_type", + "description": "FIXED, PERCENT, or DYNAMIC.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PriceTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The Stock Keeping Unit for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CustomizableFileValue` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "MediaGalleryInterface", + "description": "Contains basic information about a product image or video.", + "fields": [ + { + "name": "disabled", + "description": "Indicates whether the image is hidden from view.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The label of the product image or video.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "The media item's position after it has been sorted.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "types", + "description": "Array of image types. It can have the following values: image, small_image, thumbnail.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL of the product image or video.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVideo", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "ProductImage", + "description": "Contains product image information, including the image URL and label.", + "fields": [ + { + "name": "disabled", + "description": "Indicates whether the image is hidden from view.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The label of the product image or video.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "The media item's position after it has been sorted.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "types", + "description": "Array of image types. It can have the following values: image, small_image, thumbnail.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL of the product image or video.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "MediaGalleryInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVideo", + "description": "Contains information about a product video.", + "fields": [ + { + "name": "disabled", + "description": "Indicates whether the image is hidden from view.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The label of the product image or video.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "The media item's position after it has been sorted.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "types", + "description": "Array of image types. It can have the following values: image, small_image, thumbnail.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL of the product image or video.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "video_content", + "description": "Contains a `ProductMediaGalleryEntriesVideoContent` object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductMediaGalleryEntriesVideoContent", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "MediaGalleryInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "description": "Contains basic information about a customizable option. It can be implemented by several types of configurable options.", + "fields": [ + { + "name": "option_id", + "description": "Option ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" + }, + { + "name": "required", + "description": "Indicates whether the option is required.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The order in which the option is displayed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The display name for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CustomizableOptionInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CustomizableAreaOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomizableDateOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomizableDropDownOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomizableMultipleOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomizableFieldOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomizableFileOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomizableRadioOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomizableCheckboxOption", + "ofType": null + } + ] + }, + { + "kind": "INTERFACE", + "name": "CustomizableProductInterface", + "description": "Contains information about customizable product options.", + "fields": [ + { + "name": "options", + "description": "An array of options for a customizable product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "VirtualProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SimpleProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DownloadableProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BundleProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardProduct", + "ofType": null + } + ] + }, + { + "kind": "INTERFACE", + "name": "CategoryInterface", + "description": "Contains the full set of attributes that can be returned in a category search.", + "fields": [ + { + "name": "automatic_sorting", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "available_sort_by", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "breadcrumbs", + "description": "An array of breadcrumb items.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Breadcrumb", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "children_count", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cms_block", + "description": "Contains a category CMS block.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CmsBlock", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "The timestamp indicating when the category was created.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "custom_layout_update_file", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "default_sort_by", + "description": "The attribute to use for sorting.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "An optional description of the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "display_mode", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "filter_price_range", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "An ID that uniquely identifies the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." + }, + { + "name": "image", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "include_in_menu", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_anchor", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "landing_page", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "level", + "description": "The depth of the category within the tree.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_keywords", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_title", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The display name of the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "path", + "description": "The full category path.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "path_in_store", + "description": "The category path within the store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "The position of the category relative to other categories at the same level in tree.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_count", + "description": "The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "The list of products assigned to the category.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "sort", + "description": "The attributes to sort on, and whether to return the results in ascending or descending order.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ProductAttributeSortInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CategoryProducts", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staged", + "description": "Indicates whether the category is staged for a future campaign.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CategoryInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "The timestamp indicating when the category was updated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "url_key", + "description": "The URL key assigned to the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_path", + "description": "The URL path assigned to the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_suffix", + "description": "The part of the category URL that is appended after the url key", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CategoryTree", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "Breadcrumb", + "description": "Contains details about an individual category that comprises a breadcrumb.", + "fields": [ + { + "name": "category_id", + "description": "The ID of the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `category_uid` instead." + }, + { + "name": "category_level", + "description": "The category level.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "category_name", + "description": "The display name of the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "category_uid", + "description": "The unique ID for a `Breadcrumb` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "category_url_key", + "description": "The URL key of the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "category_url_path", + "description": "The URL path of the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableRadioOption", + "description": "Contains information about a set of radio buttons that are defined as part of a customizable option.", + "fields": [ + { + "name": "option_id", + "description": "Option ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" + }, + { + "name": "required", + "description": "Indicates whether the option is required.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The order in which the option is displayed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The display name for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CustomizableOptionInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "An array that defines a set of radio buttons.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomizableRadioValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableRadioValue", + "description": "Defines the price and sku of a product whose page contains a customized set of radio buttons.", + "fields": [ + { + "name": "option_type_id", + "description": "The ID assigned to the value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price assigned to this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_type", + "description": "FIXED, PERCENT, or DYNAMIC.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PriceTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The Stock Keeping Unit for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The order in which the radio button is displayed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The display name for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CustomizableRadioValue` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableCheckboxOption", + "description": "Contains information about a set of checkbox values that are defined as part of a customizable option.", + "fields": [ + { + "name": "option_id", + "description": "Option ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" + }, + { + "name": "required", + "description": "Indicates whether the option is required.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The order in which the option is displayed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The display name for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CustomizableOptionInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "An array that defines a set of checkbox values.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomizableCheckboxValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomizableCheckboxValue", + "description": "Defines the price and sku of a product whose page contains a customized set of checkbox values.", + "fields": [ + { + "name": "option_type_id", + "description": "The ID assigned to the value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price assigned to this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_type", + "description": "FIXED, PERCENT, or DYNAMIC.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PriceTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The Stock Keeping Unit for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The order in which the checkbox value is displayed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The display name for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CustomizableCheckboxValue` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VirtualProduct", + "description": "Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory.", + "fields": [ + { + "name": "activity", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "attribute_set_id", + "description": "The attribute set assigned to the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "categories", + "description": "The categories assigned to a product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CategoryInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "category_gear", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "climate", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "collar", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "color", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "country_of_manufacture", + "description": "The product's country of origin.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "Timestamp indicating when the product was created.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "crosssell_products", + "description": "An array of cross-sell products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_attributesV2", + "description": "Product custom attributes.", + "args": [ + { + "name": "filters", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductCustomAttributes", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "eco_collection", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "erin_recommends", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "features_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "format", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "gender", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "gift_message_available", + "description": "Returns a value indicating gift message availability for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_available", + "description": "Returns a value indicating gift wrapping availability for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_price", + "description": "Returns value and currency indicating gift wrapping price for the product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID number assigned to the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `uid` field instead." + }, + { + "name": "image", + "description": "The relative path to the main image on the product page.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_returnable", + "description": "Indicates whether the product can be returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "material", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "max_sale_qty", + "description": "Maximum Qty Allowed in Shopping Cart", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media_gallery", + "description": "An array of media gallery objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "MediaGalleryInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media_gallery_entries", + "description": "An array of MediaGalleryEntry objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaGalleryEntry", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `media_gallery` instead." + }, + { + "name": "meta_description", + "description": "A brief overview of the product for search results listings, maximum 255 characters.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_keyword", + "description": "A comma-separated list of keywords that are visible only to search engines.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_title", + "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "min_sale_qty", + "description": "Minimum Qty Allowed in Shopping Cart", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The product name. Customers use this name to identify the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "new", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "new_from_date", + "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "new_to_date", + "description": "The end date for new product listings.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "only_x_left_in_stock", + "description": "Product stock only x left count", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "An array of options for a customizable product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options_container", + "description": "If the product has multiple options, determines where they appear on the product page.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pattern", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "performance_fabric", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "price", + "description": "Indicates the price of an item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductPrices", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `price_range` for product price information." + }, + { + "name": "price_range", + "description": "The range of prices for the product", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRange", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_tiers", + "description": "An array of `TierPrice` objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TierPrice", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_links", + "description": "An array of `ProductLinks` objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductLinksInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "purpose", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "quantity", + "description": "Amount of available stock", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "related_products", + "description": "An array of related products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "review_count", + "description": "The total count of all the reviews given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reviews", + "description": "The list of products reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sale", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "short_description", + "description": "A short description of the product. Its use depends on the theme.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "size", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "sku", + "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sleeve", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "small_image", + "description": "The relative path to the small image, which is used on catalog pages.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "special_from_date", + "description": "The beginning date that a product has a special price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "special_price", + "description": "The discounted price of the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "special_to_date", + "description": "The end date for a product with a special price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staged", + "description": "Indicates whether the product is staged for a future campaign.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stock_status", + "description": "Stock status of the product", + "args": [], + "type": { + "kind": "ENUM", + "name": "ProductStockStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "strap_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_bottom", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_general", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "swatch_image", + "description": "The file name of a swatch image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "thumbnail", + "description": "The relative path to the product's thumbnail image.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tier_price", + "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." + }, + { + "name": "tier_prices", + "description": "An array of ProductTierPrices objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductTierPrices", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." + }, + { + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type_id", + "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `__typename` instead." + }, + { + "name": "uid", + "description": "The unique ID for a `ProductInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "Timestamp indicating when the product was updated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "upsell_products", + "description": "An array of up-sell products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_key", + "description": "The part of the URL that identifies the product", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_path", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use product's `canonical_url` or url rewrites instead" + }, + { + "name": "url_rewrites", + "description": "URL rewrites list", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRewrite", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_suffix", + "description": "The part of the product URL that is appended after the url key", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "websites", + "description": "An array of websites in which the product is available.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Website", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "RoutableInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "CustomizableProductInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SimpleProduct", + "description": "Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities.", + "fields": [ + { + "name": "activity", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "attribute_set_id", + "description": "The attribute set assigned to the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "categories", + "description": "The categories assigned to a product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CategoryInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "category_gear", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "climate", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "collar", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "color", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "country_of_manufacture", + "description": "The product's country of origin.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "Timestamp indicating when the product was created.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "crosssell_products", + "description": "An array of cross-sell products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_attributesV2", + "description": "Product custom attributes.", + "args": [ + { + "name": "filters", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductCustomAttributes", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "eco_collection", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "erin_recommends", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "features_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "format", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "gender", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "gift_message_available", + "description": "Returns a value indicating gift message availability for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_available", + "description": "Returns a value indicating gift wrapping availability for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_price", + "description": "Returns value and currency indicating gift wrapping price for the product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID number assigned to the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `uid` field instead." + }, + { + "name": "image", + "description": "The relative path to the main image on the product page.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_returnable", + "description": "Indicates whether the product can be returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "material", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "max_sale_qty", + "description": "Maximum Qty Allowed in Shopping Cart", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media_gallery", + "description": "An array of media gallery objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "MediaGalleryInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media_gallery_entries", + "description": "An array of MediaGalleryEntry objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaGalleryEntry", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `media_gallery` instead." + }, + { + "name": "meta_description", + "description": "A brief overview of the product for search results listings, maximum 255 characters.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_keyword", + "description": "A comma-separated list of keywords that are visible only to search engines.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_title", + "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "min_sale_qty", + "description": "Minimum Qty Allowed in Shopping Cart", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The product name. Customers use this name to identify the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "new", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "new_from_date", + "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "new_to_date", + "description": "The end date for new product listings.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "only_x_left_in_stock", + "description": "Product stock only x left count", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "An array of options for a customizable product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options_container", + "description": "If the product has multiple options, determines where they appear on the product page.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pattern", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "performance_fabric", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "price", + "description": "Indicates the price of an item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductPrices", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `price_range` for product price information." + }, + { + "name": "price_range", + "description": "The range of prices for the product", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRange", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_tiers", + "description": "An array of `TierPrice` objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TierPrice", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_links", + "description": "An array of `ProductLinks` objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductLinksInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "purpose", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "quantity", + "description": "Amount of available stock", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "related_products", + "description": "An array of related products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "review_count", + "description": "The total count of all the reviews given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reviews", + "description": "The list of products reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sale", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "short_description", + "description": "A short description of the product. Its use depends on the theme.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "size", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "sku", + "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sleeve", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "small_image", + "description": "The relative path to the small image, which is used on catalog pages.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "special_from_date", + "description": "The beginning date that a product has a special price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "special_price", + "description": "The discounted price of the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "special_to_date", + "description": "The end date for a product with a special price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staged", + "description": "Indicates whether the product is staged for a future campaign.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stock_status", + "description": "Stock status of the product", + "args": [], + "type": { + "kind": "ENUM", + "name": "ProductStockStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "strap_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_bottom", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_general", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "swatch_image", + "description": "The file name of a swatch image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "thumbnail", + "description": "The relative path to the product's thumbnail image.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tier_price", + "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." + }, + { + "name": "tier_prices", + "description": "An array of ProductTierPrices objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductTierPrices", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." + }, + { + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type_id", + "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `__typename` instead." + }, + { + "name": "uid", + "description": "The unique ID for a `ProductInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "Timestamp indicating when the product was updated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "upsell_products", + "description": "An array of up-sell products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_key", + "description": "The part of the URL that identifies the product", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_path", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use product's `canonical_url` or url rewrites instead" + }, + { + "name": "url_rewrites", + "description": "URL rewrites list", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRewrite", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_suffix", + "description": "The part of the product URL that is appended after the url key", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "websites", + "description": "An array of websites in which the product is available.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Website", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "weight", + "description": "The weight of the item, in units defined by the store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "RoutableInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "PhysicalProductInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "CustomizableProductInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Products", + "description": "Contains the results of a `products` query.", + "fields": [ + { + "name": "aggregations", + "description": "A bucket that contains the attribute code and label for each filterable option.", + "args": [ + { + "name": "filter", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "AggregationsFilterInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Aggregation", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "filters", + "description": "Layered navigation filters array.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LayerFilter", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `aggregations` instead." + }, + { + "name": "items", + "description": "An array of products that match the specified search criteria.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "An object that includes the page_info and currentPage values specified in the query.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_fields", + "description": "An object that includes the default sort field and all available sort fields.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SortFields", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "suggestions", + "description": "An array of search suggestions for case when search query have no results.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SearchSuggestion", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The number of products that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AggregationsFilterInput", + "description": "An input object that specifies the filters used in product aggregations.", + "fields": null, + "inputFields": [ + { + "name": "category", + "description": "Filter category aggregations in layered navigation.", + "type": { + "kind": "INPUT_OBJECT", + "name": "AggregationsCategoryFilterInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AggregationsCategoryFilterInput", + "description": "Filter category aggregations in layered navigation.", + "fields": null, + "inputFields": [ + { + "name": "includeDirectChildrenOnly", + "description": "Indicates whether to include only direct subcategories or all children categories at all levels.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CategoryProducts", + "description": "Contains details about the products assigned to a category.", + "fields": [ + { + "name": "items", + "description": "An array of products that are assigned to the category.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Pagination metadata.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductAttributeFilterInput", + "description": "Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.", + "fields": null, + "inputFields": [ + { + "name": "activity", + "description": "Attribute label: Activity", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "category_gear", + "description": "Attribute label: Category Gear", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "category_id", + "description": "Deprecated: use `category_uid` to filter product by category ID.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "category_uid", + "description": "Filter product by the unique ID for a `CategoryInterface` object.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "category_url_path", + "description": "Filter product by category URL path.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "climate", + "description": "Attribute label: Climate", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "collar", + "description": "Attribute label: Collar", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "color", + "description": "Attribute label: Color", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "description", + "description": "Attribute label: Description", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterMatchTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "eco_collection", + "description": "Attribute label: Eco Collection", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "erin_recommends", + "description": "Attribute label: Erin Recommends", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "features_bags", + "description": "Attribute label: Features", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "format", + "description": "Attribute label: Format", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "gender", + "description": "Attribute label: Gender", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "material", + "description": "Attribute label: Material", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": "Attribute label: Product Name", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterMatchTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "new", + "description": "Attribute label: New", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pattern", + "description": "Attribute label: Pattern", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "performance_fabric", + "description": "Attribute label: Performance Fabric", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "price", + "description": "Attribute label: Price", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterRangeTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "purpose", + "description": "Attribute label: Purpose", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sale", + "description": "Attribute label: Sale", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "short_description", + "description": "Attribute label: Short Description", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterMatchTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "size", + "description": "Attribute label: Size", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sku", + "description": "Attribute label: SKU", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sleeve", + "description": "Attribute label: Sleeve", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "strap_bags", + "description": "Attribute label: Strap/Handle", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "style_bags", + "description": "Attribute label: Style Bags", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "style_bottom", + "description": "Attribute label: Style Bottom", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "style_general", + "description": "Attribute label: Style General", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "url_key", + "description": "The part of the URL that identifies the product", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CategoryFilterInput", + "description": "Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.", + "fields": null, + "inputFields": [ + { + "name": "category_uid", + "description": "Filter by the unique category ID for a `CategoryInterface` object.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "ids", + "description": "Deprecated: use 'category_uid' to filter uniquely identifiers of categories.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": "Filter by the display name of the category.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterMatchTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "parent_category_uid", + "description": "Filter by the unique parent category ID for a `CategoryInterface` object.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "parent_id", + "description": "Filter by the unique parent category ID for a `CategoryInterface` object.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "url_key", + "description": "Filter by the part of the URL that identifies the category.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "url_path", + "description": "Filter by the URL path for the category.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductFilterInput", + "description": "ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. ProductFilterInput defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.", + "fields": null, + "inputFields": [ + { + "name": "category_id", + "description": "The category ID the product belongs to.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "country_of_manufacture", + "description": "The product's country of origin.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "created_at", + "description": "The timestamp indicating when the product was created.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "custom_layout", + "description": "The name of a custom layout.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "custom_layout_update", + "description": "XML code that is applied as a layout update to the product page.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "gift_message_available", + "description": "Indicates whether a gift message is available.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "has_options", + "description": "Indicates whether additional attributes have been created for the product.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "image", + "description": "The relative path to the main image on the product page.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "image_label", + "description": "The label assigned to a product image.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "is_returnable", + "description": "Indicates whether the product can be returned.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "max_price", + "description": "The numeric maximal price of the product. Do not include the currency code.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "meta_description", + "description": "A brief overview of the product for search results listings, maximum 255 characters.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "meta_keyword", + "description": "A comma-separated list of keywords that are visible only to search engines.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "meta_title", + "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "min_price", + "description": "The numeric minimal price of the product. Do not include the currency code.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The product name. Customers use this name to identify the product.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "news_from_date", + "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "news_to_date", + "description": "The end date for new product listings.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "options_container", + "description": "If the product has multiple options, determines where they appear on the product page.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "or", + "description": "The keyword required to perform a logical OR comparison.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ProductFilterInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "price", + "description": "The price of an item.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "required_options", + "description": "Indicates whether the product has required options.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "short_description", + "description": "A short description of the product. Its use depends on the theme.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sku", + "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "small_image", + "description": "The relative path to the small image, which is used on catalog pages.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "small_image_label", + "description": "The label assigned to a product's small image.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "special_from_date", + "description": "The beginning date that a product has a special price.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "special_price", + "description": "The discounted price of the product. Do not include the currency code.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "special_to_date", + "description": "The end date that a product has a special price.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "swatch_image", + "description": "The file name of a swatch image.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "thumbnail", + "description": "The relative path to the product's thumbnail image.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "thumbnail_label", + "description": "The label assigned to a product's thumbnail image.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "tier_price", + "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "updated_at", + "description": "The timestamp indicating when the product was updated.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "url_key", + "description": "The part of the URL that identifies the product", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "url_path", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "weight", + "description": "The weight of the item, in units defined by the store.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductMediaGalleryEntriesContent", + "description": "Contains an image in base64 format and basic information about the image.", + "fields": [ + { + "name": "base64_encoded_data", + "description": "The image in base64 format.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The file name of the image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The MIME type of the file, such as image/png.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductMediaGalleryEntriesVideoContent", + "description": "Contains a link to a video file and basic information about the video.", + "fields": [ + { + "name": "media_type", + "description": "Must be external-video.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "video_description", + "description": "A description of the video.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "video_metadata", + "description": "Optional data about the video.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "video_provider", + "description": "Describes the video source.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "video_title", + "description": "The title of the video.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "video_url", + "description": "The URL to the video.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductSortInput", + "description": "Deprecated. Use `ProductAttributeSortInput` instead. Specifies the attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order.", + "fields": null, + "inputFields": [ + { + "name": "country_of_manufacture", + "description": "The product's country of origin.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "created_at", + "description": "The timestamp indicating when the product was created.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "custom_layout", + "description": "The name of a custom layout.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "custom_layout_update", + "description": "XML code that is applied as a layout update to the product page.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "gift_message_available", + "description": "Indicates whether a gift message is available.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "has_options", + "description": "Indicates whether additional attributes have been created for the product.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "image", + "description": "The relative path to the main image on the product page.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "image_label", + "description": "The label assigned to a product image.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "is_returnable", + "description": "Indicates whether the product can be returned.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "meta_description", + "description": "A brief overview of the product for search results listings, maximum 255 characters.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "meta_keyword", + "description": "A comma-separated list of keywords that are visible only to search engines.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "meta_title", + "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The product name. Customers use this name to identify the product.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "news_from_date", + "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "news_to_date", + "description": "The end date for new product listings.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "options_container", + "description": "If the product has multiple options, determines where they appear on the product page.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "price", + "description": "The price of the item.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "required_options", + "description": "Indicates whether the product has required options.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "short_description", + "description": "A short description of the product. Its use depends on the theme.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sku", + "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "small_image", + "description": "The relative path to the small image, which is used on catalog pages.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "small_image_label", + "description": "The label assigned to a product's small image.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "special_from_date", + "description": "The beginning date that a product has a special price.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "special_price", + "description": "The discounted price of the product.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "special_to_date", + "description": "The end date that a product has a special price.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "swatch_image", + "description": "Indicates the criteria to sort swatches.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "thumbnail", + "description": "The relative path to the product's thumbnail image.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "thumbnail_label", + "description": "The label assigned to a product's thumbnail image.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "tier_price", + "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "updated_at", + "description": "The timestamp indicating when the product was updated.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "url_key", + "description": "The part of the URL that identifies the product", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "url_path", + "description": "", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "weight", + "description": "The weight of the item, in units defined by the store.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductAttributeSortInput", + "description": "Specifies the attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. It's possible to sort products using searchable attributes with enabled 'Use in Filter Options' option", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "Attribute label: Product Name", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "position", + "description": "Sort by the position assigned to each product.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "price", + "description": "Attribute label: Price", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "relevance", + "description": "Sort by the search relevance score (default).", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MediaGalleryEntry", + "description": "Defines characteristics about images and videos associated with a specific product.", + "fields": [ + { + "name": "content", + "description": "Details about the content of the media gallery item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductMediaGalleryEntriesContent", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "disabled", + "description": "Indicates whether the image is hidden from view.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "file", + "description": "The path of the image on the server.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The identifier assigned to the object.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." + }, + { + "name": "label", + "description": "The alt text displayed on the storefront when the user points to the image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media_type", + "description": "Either `image` or `video`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "The media item's position after it has been sorted.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "types", + "description": "Array of image types. It can have the following values: image, small_image, thumbnail.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `MediaGalleryEntry` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "video_content", + "description": "Details about the content of a video item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductMediaGalleryEntriesVideoContent", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LayerFilter", + "description": "Contains information for rendering layered navigation.", + "fields": [ + { + "name": "filter_items", + "description": "An array of filter items.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "LayerFilterItemInterface", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `Aggregation.options` instead." + }, + { + "name": "filter_items_count", + "description": "The count of filter items in filter group.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `Aggregation.count` instead." + }, + { + "name": "name", + "description": "The name of a layered navigation filter.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `Aggregation.label` instead." + }, + { + "name": "request_var", + "description": "The request variable name for a filter query.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `Aggregation.attribute_code` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "LayerFilterItemInterface", + "description": "", + "fields": [ + { + "name": "items_count", + "description": "The count of items per filter.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `AggregationOption.count` instead." + }, + { + "name": "label", + "description": "The label for a filter.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `AggregationOption.label` instead." + }, + { + "name": "value_string", + "description": "The value of a filter request variable to be used in query.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `AggregationOption.value` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "LayerFilterItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SwatchLayerFilterItem", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "LayerFilterItem", + "description": "", + "fields": [ + { + "name": "items_count", + "description": "The count of items per filter.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `AggregationOption.count` instead." + }, + { + "name": "label", + "description": "The label for a filter.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `AggregationOption.label` instead." + }, + { + "name": "value_string", + "description": "The value of a filter request variable to be used in query.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `AggregationOption.value` instead." + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "LayerFilterItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Aggregation", + "description": "Contains information for each filterable option (such as price, category `UID`, and custom attributes).", + "fields": [ + { + "name": "attribute_code", + "description": "Attribute code of the aggregation group.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "count", + "description": "The number of options in the aggregation group.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The aggregation display name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "Array of options for the aggregation.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AggregationOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "The relative position of the attribute in a layered navigation block.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SearchSuggestion", + "description": "A string that contains search suggestion", + "fields": [ + { + "name": "search", + "description": "The search suggestion of existing product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "AggregationOptionInterface", + "description": "Defines aggregation option fields.", + "fields": [ + { + "name": "count", + "description": "The number of items that match the aggregation option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The display label for an aggregation option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The internal ID that represents the value of the option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AggregationOption", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "AggregationOption", + "description": "An implementation of `AggregationOptionInterface`.", + "fields": [ + { + "name": "count", + "description": "The number of items that match the aggregation option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The display label for an aggregation option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The internal ID that represents the value of the option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "AggregationOptionInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SortField", + "description": "Defines a possible sort field.", + "fields": [ + { + "name": "label", + "description": "The label of the sort field.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The attribute code of the sort field.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SortFields", + "description": "Contains a default value for sort fields and all available sort fields.", + "fields": [ + { + "name": "default", + "description": "The default sort field value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "An array of possible sort fields.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SortField", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SimpleWishlistItem", + "description": "Contains a simple product wish list item.", + "fields": [ + { + "name": "added_at", + "description": "The date and time the item was added to the wish list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizable_options", + "description": "Custom options selected for the wish list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `WishlistItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Product details of the wish list item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of this wish list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "WishlistItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VirtualWishlistItem", + "description": "Contains a virtual product wish list item.", + "fields": [ + { + "name": "added_at", + "description": "The date and time the item was added to the wish list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizable_options", + "description": "Custom options selected for the wish list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `WishlistItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Product details of the wish list item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of this wish list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "WishlistItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CatalogAttributeMetadata", + "description": "Swatch attribute metadata.", + "fields": [ + { + "name": "apply_to", + "description": "To which catalog types an attribute can be applied.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CatalogAttributeApplyToEnum", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "The unique identifier for an attribute code. This value should be in lowercase letters without spaces.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "default_value", + "description": "Default attribute value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "entity_type", + "description": "The type of entity that defines the attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AttributeEntityTypeEnum", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "frontend_class", + "description": "The frontend class of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "frontend_input", + "description": "The frontend input type of the attribute.", + "args": [], + "type": { + "kind": "ENUM", + "name": "AttributeFrontendInputEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_comparable", + "description": "Whether a product or category attribute can be compared against another or not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_filterable", + "description": "Whether a product or category attribute can be filtered or not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_filterable_in_search", + "description": "Whether a product or category attribute can be filtered in search or not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_html_allowed_on_front", + "description": "Whether a product or category attribute can use HTML on front or not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_required", + "description": "Whether the attribute value is required.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_searchable", + "description": "Whether a product or category attribute can be searched or not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_unique", + "description": "Whether the attribute value must be unique.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_used_for_price_rules", + "description": "Whether a product or category attribute can be used for price rules or not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_used_for_promo_rules", + "description": "Whether a product or category attribute is used for promo rules or not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_visible_in_advanced_search", + "description": "Whether a product or category attribute is visible in advanced search or not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_visible_on_front", + "description": "Whether a product or category attribute is visible on front or not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_wysiwyg_enabled", + "description": "Whether a product or category attribute has WYSIWYG enabled or not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The label assigned to the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "Attribute options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CustomAttributeOptionInterface", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "swatch_input_type", + "description": "Input type of the swatch attribute option.", + "args": [], + "type": { + "kind": "ENUM", + "name": "SwatchInputTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "update_product_preview_image", + "description": "Whether update product preview image or not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "use_product_image_for_swatch", + "description": "Whether use product image for swatch or not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "used_in_product_listing", + "description": "Whether a product or category attribute is used in product listing or not.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CustomAttributeMetadataInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CatalogAttributeApplyToEnum", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SIMPLE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIRTUAL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BUNDLE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DOWNLOADABLE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONFIGURABLE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GROUPED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATEGORY", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductCustomAttributes", + "description": "Product custom attributes", + "fields": [ + { + "name": "errors", + "description": "Errors when retrieving custom attributes metadata.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AttributeMetadataError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "Requested custom attributes", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductStockStatus", + "description": "This enumeration states whether a product stock status is in stock or out of stock", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "IN_STOCK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OUT_OF_STOCK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "CartItemInterface", + "description": "An interface for products in a cart.", + "fields": [ + { + "name": "discount", + "description": "Contains discount for quote line item.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errors", + "description": "An array of errors encountered while loading the cart item", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartItemError", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." + }, + { + "name": "is_available", + "description": "True if requested quantity is less than available stock, false otherwise.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "max_qty", + "description": "Line item max qty in quote template", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "min_qty", + "description": "Line item min qty in quote template", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "not_available_message", + "description": "Message to display when the product is not available with this selected option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note_from_buyer", + "description": "The buyer's quote line item note.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemNote", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note_from_seller", + "description": "The seller's quote line item note.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemNote", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CartItemPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Details about an item in the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of this item in the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CartItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SimpleCartItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VirtualCartItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableCartItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DownloadableCartItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BundleCartItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardCartItem", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "EntityUrl", + "description": "Contains the `uid`, `relative_url`, and `type` attributes.", + "fields": [ + { + "name": "canonical_url", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `relative_url` instead." + }, + { + "name": "entity_uid", + "description": "The unique ID for a `ProductInterface`, `CategoryInterface`, `CmsPage`, or similar object associated with the specified URL. This could be a product, category, or CMS page UID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID assigned to the object associated with the specified url. This could be a product ID, category ID, or page ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `entity_uid` instead." + }, + { + "name": "redirectCode", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "description": "This enumeration defines the entity type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CMS_PAGE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATEGORY", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRewrite", + "description": "Contains URL rewrite details.", + "fields": [ + { + "name": "parameters", + "description": "An array of request parameters.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "HttpQueryParameter", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The request URL.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "HttpQueryParameter", + "description": "Contains target path parameters.", + "fields": [ + { + "name": "name", + "description": "A parameter name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "A parameter value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RoutableUrl", + "description": "Default implementation of RoutableInterface. This type is returned when the URL is not linked to an entity.", + "fields": [ + { + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "RoutableInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "RoutableInterface", + "description": "Routable entities serve as the model for a rendered page.", + "fields": [ + { + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CmsPage", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CategoryTree", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VirtualProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SimpleProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "RoutableUrl", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DownloadableProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BundleProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GroupedProduct", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "CreateGuestCartInput", + "description": "", + "fields": null, + "inputFields": [ + { + "name": "cart_uid", + "description": "Optional client-generated ID", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "createEmptyCartInput", + "description": "Assigns a specific `cart_id` to the empty cart.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The ID to assign to the cart.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AddSimpleProductsToCartInput", + "description": "Defines the simple and group products to add to the cart.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "cart_items", + "description": "An array of simple and group items to add.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SimpleProductCartItemInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SimpleProductCartItemInput", + "description": "Defines a single product to add to the cart.", + "fields": null, + "inputFields": [ + { + "name": "customizable_options", + "description": "An array that defines customizable options for the product.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomizableOptionInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "data", + "description": "An object containing the `sku`, `quantity`, and other relevant information about the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartItemInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AddVirtualProductsToCartInput", + "description": "Defines the virtual products to add to the cart.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "cart_items", + "description": "An array of virtual products to add.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "VirtualProductCartItemInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "VirtualProductCartItemInput", + "description": "Defines a single product to add to the cart.", + "fields": null, + "inputFields": [ + { + "name": "customizable_options", + "description": "An array that defines customizable options for the product.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomizableOptionInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "data", + "description": "An object containing the `sku`, `quantity`, and other relevant information about the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartItemInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CartItemInput", + "description": "Defines an item to be added to the cart.", + "fields": null, + "inputFields": [ + { + "name": "entered_options", + "description": "An array of entered options for the base product, such as personalization text.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "EnteredOptionInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "parent_sku", + "description": "For a child product, the SKU of its parent product.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The amount or number of an item to add.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "selected_options", + "description": "The selected options for the base product, such as color or size, using the unique ID for an object such as `CustomizableRadioOption`, `CustomizableDropDownOption`, or `ConfigurableProductOptionsValues`.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sku", + "description": "The SKU of the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SortQuoteItemsEnum", + "description": "Specifies the field to use for sorting quote items", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ITEM_ID", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED_AT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_ID", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SKU", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAME", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DESCRIPTION", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WEIGHT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "QTY", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BASE_PRICE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOM_PRICE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCOUNT_PERCENT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCOUNT_AMOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BASE_DISCOUNT_AMOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAX_PERCENT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAX_AMOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BASE_TAX_AMOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ROW_TOTAL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BASE_ROW_TOTAL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ROW_TOTAL_WITH_DISCOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ROW_WEIGHT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_TYPE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BASE_TAX_BEFORE_DISCOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAX_BEFORE_DISCOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORIGINAL_CUSTOM_PRICE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_INC_TAX", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BASE_PRICE_INC_TAX", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ROW_TOTAL_INC_TAX", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BASE_ROW_TOTAL_INC_TAX", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCOUNT_TAX_COMPENSATION_AMOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FREE_SHIPPING", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "QuoteItemsSortInput", + "description": "Specifies the field to use for sorting quote items", + "fields": null, + "inputFields": [ + { + "name": "field", + "description": "Specifies the quote items field to sort by", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SortQuoteItemsEnum", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "order", + "description": "Specifies the order of quote items' sorting", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomizableOptionInput", + "description": "Defines a customizable option.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The customizable option ID of the product.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "uid", + "description": "The unique ID for a `CartItemInterface` object.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "value_string", + "description": "The string value of the option.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ApplyCouponToCartInput", + "description": "Specifies the coupon code to apply to the cart.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "coupon_code", + "description": "A valid coupon code.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "UpdateCartItemsInput", + "description": "Modifies the specified items in the cart.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "cart_items", + "description": "An array of items to be updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartItemUpdateInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CartItemUpdateInput", + "description": "A single item to be updated.", + "fields": null, + "inputFields": [ + { + "name": "cart_item_id", + "description": "Deprecated. Use `cart_item_uid` instead.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cart_item_uid", + "description": "The unique ID for a `CartItemInterface` object.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customizable_options", + "description": "An array that defines customizable options for the product.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomizableOptionInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "gift_message", + "description": "Gift message details for the cart item", + "type": { + "kind": "INPUT_OBJECT", + "name": "GiftMessageInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "gift_wrapping_id", + "description": "The unique ID for a `GiftWrapping` object to be used for the cart item.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The new quantity of the item.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RemoveItemFromCartInput", + "description": "Specifies which items to remove from the cart.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "cart_item_id", + "description": "Deprecated. Use `cart_item_uid` instead.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cart_item_uid", + "description": "Required field. The unique ID for a `CartItemInterface` object.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SetShippingAddressesOnCartInput", + "description": "Specifies an array of addresses to use for shipping.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "shipping_addresses", + "description": "An array of shipping addresses.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ShippingAddressInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ShippingAddressInput", + "description": "Defines a single shipping address.", + "fields": null, + "inputFields": [ + { + "name": "address", + "description": "Defines a shipping address.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CartAddressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customer_address_id", + "description": "An ID from the customer's address book that uniquely identifies the address to be used for shipping.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address to be used for shipping.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customer_notes", + "description": "Text provided by the shopper.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pickup_location_code", + "description": "The code of Pickup Location which will be used for In-Store Pickup.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SetBillingAddressOnCartInput", + "description": "Sets the billing address.", + "fields": null, + "inputFields": [ + { + "name": "billing_address", + "description": "The billing address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "BillingAddressInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "BillingAddressInput", + "description": "Defines the billing address.", + "fields": null, + "inputFields": [ + { + "name": "address", + "description": "Defines a billing address.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CartAddressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customer_address_id", + "description": "An ID from the customer's address book that uniquely identifies the address to be used for billing.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address to be used for billing.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "same_as_shipping", + "description": "Indicates whether to set the billing address to be the same as the existing shipping address on the cart.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "use_for_shipping", + "description": "Indicates whether to set the shipping address to be the same as this billing address.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CartAddressInput", + "description": "Defines the billing or shipping address to be applied to the cart.", + "fields": null, + "inputFields": [ + { + "name": "city", + "description": "The city specified for the billing or shipping address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "company", + "description": "The company specified for the billing or shipping address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "country_code", + "description": "The country code and label for the billing or shipping address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "custom_attributes", + "description": "The custom attribute values of the billing or shipping address.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeValueInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "fax", + "description": "The customer's fax number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "firstname", + "description": "The first name of the customer or guest.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lastname", + "description": "The last name of the customer or guest.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "middlename", + "description": "The middle name of the person associated with the billing/shipping address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "postcode", + "description": "The ZIP or postal code of the billing or shipping address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "region", + "description": "A string that defines the state or province of the billing or shipping address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "region_id", + "description": "An integer that defines the state or province of the billing or shipping address.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "save_in_address_book", + "description": "Determines whether to save the address in the customer's address book. The default value is true.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "street", + "description": "An array containing the street for the billing or shipping address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "telephone", + "description": "The telephone number for the billing or shipping address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "vat_id", + "description": "The VAT company number for billing or shipping address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SetShippingMethodsOnCartInput", + "description": "Applies one or shipping methods to the cart.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "shipping_methods", + "description": "An array of shipping methods.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ShippingMethodInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ShippingMethodInput", + "description": "Defines the shipping carrier and method.", + "fields": null, + "inputFields": [ + { + "name": "carrier_code", + "description": "A string that identifies a commercial carrier or an offline delivery method.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "method_code", + "description": "A string that indicates which service a commercial carrier will use to ship items. For offline delivery methods, this value is similar to the label displayed on the checkout page.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SetPaymentMethodAndPlaceOrderInput", + "description": "Applies a payment method to the quote.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "payment_method", + "description": "The payment method data to apply to the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PaymentMethodInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PlaceOrderInput", + "description": "Specifies the quote to be converted to an order.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SetPaymentMethodOnCartInput", + "description": "Applies a payment method to the cart.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "payment_method", + "description": "The payment method data to apply to the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PaymentMethodInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PaymentMethodInput", + "description": "Defines the payment method.", + "fields": null, + "inputFields": [ + { + "name": "braintree", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "BraintreeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "braintree_ach_direct_debit", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "BraintreeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "braintree_ach_direct_debit_vault", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "BraintreeVaultInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "braintree_applepay_vault", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "BraintreeVaultInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "braintree_cc_vault", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "BraintreeCcVaultInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "braintree_googlepay_vault", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "BraintreeVaultInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "braintree_paypal", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "BraintreeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "braintree_paypal_vault", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "BraintreeVaultInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "code", + "description": "The internal name for the payment method.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "hosted_pro", + "description": "Required input for PayPal Hosted pro payments.", + "type": { + "kind": "INPUT_OBJECT", + "name": "HostedProInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "payflow_express", + "description": "Required input for Payflow Express Checkout payments.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PayflowExpressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "payflow_link", + "description": "Required input for PayPal Payflow Link and Payments Advanced payments.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PayflowLinkInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "payflowpro", + "description": "Required input for PayPal Payflow Pro and Payment Pro payments.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PayflowProInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "payflowpro_cc_vault", + "description": "Required input for PayPal Payflow Pro vault payments.", + "type": { + "kind": "INPUT_OBJECT", + "name": "VaultTokenInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "payment_services_paypal_apple_pay", + "description": "Required input for Apple Pay button", + "type": { + "kind": "INPUT_OBJECT", + "name": "ApplePayMethodInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "payment_services_paypal_fastlane", + "description": "Required input for fastlane", + "type": { + "kind": "INPUT_OBJECT", + "name": "FastlaneMethodInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "payment_services_paypal_google_pay", + "description": "Required input for Google Pay button", + "type": { + "kind": "INPUT_OBJECT", + "name": "GooglePayMethodInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "payment_services_paypal_hosted_fields", + "description": "Required input for Hosted Fields", + "type": { + "kind": "INPUT_OBJECT", + "name": "HostedFieldsInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "payment_services_paypal_smart_buttons", + "description": "Required input for Smart buttons", + "type": { + "kind": "INPUT_OBJECT", + "name": "SmartButtonMethodInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "payment_services_paypal_vault", + "description": "Required input for vault", + "type": { + "kind": "INPUT_OBJECT", + "name": "VaultMethodInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "paypal_express", + "description": "Required input for Express Checkout and Payments Standard payments.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PaypalExpressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "purchase_order_number", + "description": "The purchase order number. Optional for most payment methods.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SetGuestEmailOnCartInput", + "description": "Defines the guest email and cart.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "The email address of the guest.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartPrices", + "description": "Contains details about the final price of items in the cart, including discount and tax information.", + "fields": [ + { + "name": "applied_taxes", + "description": "An array containing the names and amounts of taxes applied to each item in the cart.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartTaxItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discount", + "description": null, + "args": [], + "type": { + "kind": "OBJECT", + "name": "CartDiscount", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use discounts instead." + }, + { + "name": "discounts", + "description": "An array containing cart rule discounts, store credit and gift cards applied to the cart.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_options", + "description": "The list of prices for the selected gift options.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftOptionsPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "grand_total", + "description": "The total, including discounts, taxes, shipping, and other fees.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "grand_total_excluding_tax", + "description": "The total of the cart, including discounts, shipping, and other fees without tax.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotal_excluding_tax", + "description": "The subtotal without any applied taxes.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotal_including_tax", + "description": "The subtotal including any applied taxes.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotal_with_discount_excluding_tax", + "description": "The subtotal with any discounts applied, but not taxes.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartTaxItem", + "description": "Contains tax information about an item in the cart.", + "fields": [ + { + "name": "amount", + "description": "The amount of tax applied to the item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The description of the tax.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartDiscount", + "description": "Contains information about discounts applied to the cart.", + "fields": [ + { + "name": "amount", + "description": "The amount of the discount applied to the item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The description of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateGuestCartOutput", + "description": "", + "fields": [ + { + "name": "cart", + "description": "The newly created cart.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SetPaymentMethodOnCartOutput", + "description": "Contains details about the cart after setting the payment method.", + "fields": [ + { + "name": "cart", + "description": "The cart after setting the payment method.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SetBillingAddressOnCartOutput", + "description": "Contains details about the cart after setting the billing address.", + "fields": [ + { + "name": "cart", + "description": "The cart after setting the billing address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SetShippingAddressesOnCartOutput", + "description": "Contains details about the cart after setting the shipping addresses.", + "fields": [ + { + "name": "cart", + "description": "The cart after setting the shipping addresses.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SetShippingMethodsOnCartOutput", + "description": "Contains details about the cart after setting the shipping methods.", + "fields": [ + { + "name": "cart", + "description": "The cart after setting the shipping methods.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ApplyCouponToCartOutput", + "description": "Contains details about the cart after applying a coupon.", + "fields": [ + { + "name": "cart", + "description": "The cart after applying a coupon.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PlaceOrderOutput", + "description": "Contains the results of the request to place an order.", + "fields": [ + { + "name": "errors", + "description": "An array of place order errors.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PlaceOrderError", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "The ID of the order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `orderV2` instead." + }, + { + "name": "orderV2", + "description": "Full order information.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PlaceOrderError", + "description": "An error encountered while placing an order.", + "fields": [ + { + "name": "code", + "description": "An error code that is specific to place order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PlaceOrderErrorCodes", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "A localized error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PlaceOrderErrorCodes", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CART_NOT_FOUND", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CART_NOT_ACTIVE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GUEST_EMAIL_MISSING", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNABLE_TO_PLACE_ORDER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNDEFINED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Cart", + "description": "Contains the contents and other details about a guest or customer cart.", + "fields": [ + { + "name": "applied_coupon", + "description": null, + "args": [], + "type": { + "kind": "OBJECT", + "name": "AppliedCoupon", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `applied_coupons` instead." + }, + { + "name": "applied_coupons", + "description": "An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppliedCoupon", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "applied_gift_cards", + "description": "An array of gift card items applied to the cart.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppliedGiftCard", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "applied_reward_points", + "description": "The amount of reward points applied to the cart.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RewardPointsAmount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "applied_store_credit", + "description": "Store credit information applied to the cart.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "AppliedStoreCredit", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "available_gift_wrappings", + "description": "The list of available gift wrapping options for the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftWrapping", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "available_payment_methods", + "description": "An array of available payment methods.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AvailablePaymentMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "billing_address", + "description": "The billing address assigned to the cart.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "BillingCartAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "The email address of the guest or customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_message", + "description": "The entered gift message for the cart", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftMessage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_receipt_included", + "description": "Indicates whether the shopper requested gift receipt for the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping", + "description": "The selected gift wrapping for the cart.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftWrapping", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `Cart` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_virtual", + "description": "Indicates whether the cart contains only virtual products.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "An array of products that have been added to the cart.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CartItemInterface", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `itemsV2` instead." + }, + { + "name": "itemsV2", + "description": null, + "args": [ + { + "name": "pageSize", + "description": "", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "sort", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "QuoteItemsSortInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CartItems", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "Pricing details for the quote.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CartPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "printed_card_included", + "description": "Indicates whether the shopper requested a printed card for the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rules", + "description": "Provides applied cart rules in the current active cart", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartRuleStorefront", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "selected_payment_method", + "description": "Indicates which payment method was applied to the cart.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SelectedPaymentMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shipping_addresses", + "description": "An array of shipping addresses assigned to the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShippingCartAddress", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_quantity", + "description": "The total number of items in the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartItems", + "description": "", + "fields": [ + { + "name": "items", + "description": "An array of products that have been added to the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CartItemInterface", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Metadata for pagination rendering.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The number of returned cart items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "CartAddressInterface", + "description": "", + "fields": [ + { + "name": "city", + "description": "The city specified for the billing or shipping address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company", + "description": "The company specified for the billing or shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "An object containing the country label and code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartAddressCountry", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_attributes", + "description": "The custom attribute values of the billing or shipping address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fax", + "description": "The customer's fax number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstname", + "description": "The first name of the customer or guest.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "Id of the customer address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `customer_address_uid` instead." + }, + { + "name": "lastname", + "description": "The last name of the customer or guest.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "middlename", + "description": "The middle name of the person associated with the billing/shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "postcode", + "description": "The ZIP or postal code of the billing or shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "region", + "description": "An object containing the region label and code.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CartAddressRegion", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "street", + "description": "An array containing the street for the billing or shipping address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "telephone", + "description": "The telephone number for the billing or shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique id of the customer cart address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vat_id", + "description": "The VAT company number for billing or shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "ShippingCartAddress", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BillingCartAddress", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "ShippingCartAddress", + "description": "Contains shipping addresses and methods.", + "fields": [ + { + "name": "available_shipping_methods", + "description": "An array that lists the shipping methods that can be applied to the cart.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AvailableShippingMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cart_items", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartItemQuantity", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `cart_items_v2` instead." + }, + { + "name": "cart_items_v2", + "description": "An array that lists the items in the cart.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CartItemInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "The city specified for the billing or shipping address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company", + "description": "The company specified for the billing or shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "An object containing the country label and code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartAddressCountry", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_attributes", + "description": "The custom attribute values of the billing or shipping address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer_notes", + "description": "Text provided by the shopper.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fax", + "description": "The customer's fax number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstname", + "description": "The first name of the customer or guest.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "Id of the customer address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `customer_address_uid` instead." + }, + { + "name": "items_weight", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "This information should not be exposed on the frontend." + }, + { + "name": "lastname", + "description": "The last name of the customer or guest.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "middlename", + "description": "The middle name of the person associated with the billing/shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pickup_location_code", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "postcode", + "description": "The ZIP or postal code of the billing or shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "region", + "description": "An object containing the region label and code.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CartAddressRegion", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "same_as_billing", + "description": "Indicates whether the shipping address is same as billing address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "selected_shipping_method", + "description": "An object that describes the selected shipping method.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SelectedShippingMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "street", + "description": "An array containing the street for the billing or shipping address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "telephone", + "description": "The telephone number for the billing or shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique id of the customer cart address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vat_id", + "description": "The VAT company number for billing or shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CartAddressInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BillingCartAddress", + "description": "Contains details about the billing address.", + "fields": [ + { + "name": "city", + "description": "The city specified for the billing or shipping address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company", + "description": "The company specified for the billing or shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "An object containing the country label and code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartAddressCountry", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_attributes", + "description": "The custom attribute values of the billing or shipping address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer_notes", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field is used only in shipping address." + }, + { + "name": "fax", + "description": "The customer's fax number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstname", + "description": "The first name of the customer or guest.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "Id of the customer address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `customer_address_uid` instead." + }, + { + "name": "lastname", + "description": "The last name of the customer or guest.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "middlename", + "description": "The middle name of the person associated with the billing/shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "postcode", + "description": "The ZIP or postal code of the billing or shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "region", + "description": "An object containing the region label and code.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CartAddressRegion", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "street", + "description": "An array containing the street for the billing or shipping address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "telephone", + "description": "The telephone number for the billing or shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique id of the customer cart address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vat_id", + "description": "The VAT company number for billing or shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CartAddressInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartItemQuantity", + "description": "Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.", + "fields": [ + { + "name": "cart_item_id", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`." + }, + { + "name": "quantity", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartAddressRegion", + "description": "Contains details about the region in a billing or shipping address.", + "fields": [ + { + "name": "code", + "description": "The state or province code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The display label for the region.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "region_id", + "description": "The unique ID for a pre-defined region.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartAddressCountry", + "description": "Contains details the country in a billing or shipping address.", + "fields": [ + { + "name": "code", + "description": "The country code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The display label for the country.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SelectedShippingMethod", + "description": "Contains details about the selected shipping method and carrier.", + "fields": [ + { + "name": "amount", + "description": "The cost of shipping using this shipping method.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "base_amount", + "description": null, + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "carrier_code", + "description": "A string that identifies a commercial carrier or an offline shipping method.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "carrier_title", + "description": "The label for the carrier code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "method_code", + "description": "A shipping method code associated with a carrier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "method_title", + "description": "The label for the method code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_excl_tax", + "description": "The cost of shipping using this shipping method, excluding tax.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_incl_tax", + "description": "The cost of shipping using this shipping method, including tax.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AvailableShippingMethod", + "description": "Contains details about the possible shipping methods and carriers.", + "fields": [ + { + "name": "amount", + "description": "The cost of shipping using this shipping method.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "available", + "description": "Indicates whether this shipping method can be applied to the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "base_amount", + "description": null, + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "carrier_code", + "description": "A string that identifies a commercial carrier or an offline shipping method.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "carrier_title", + "description": "The label for the carrier code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "error_message", + "description": "Describes an error condition.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "method_code", + "description": "A shipping method code associated with a carrier. The value could be null if no method is available.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "method_title", + "description": "The label for the shipping method code. The value could be null if no method is available.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_excl_tax", + "description": "The cost of shipping using this shipping method, excluding tax.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_incl_tax", + "description": "The cost of shipping using this shipping method, including tax.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AvailablePaymentMethod", + "description": "Describes a payment method that the shopper can use to pay for the order.", + "fields": [ + { + "name": "code", + "description": "The payment method code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_deferred", + "description": "If the payment method is an online integration", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The payment method title.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SelectedPaymentMethod", + "description": "Describes the payment method the shopper selected.", + "fields": [ + { + "name": "code", + "description": "The payment method code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "purchase_order_number", + "description": "The purchase order number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The payment method title.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppliedCoupon", + "description": "Contains the applied coupon code.", + "fields": [ + { + "name": "code", + "description": "The coupon code the shopper applied to the card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RemoveCouponFromCartInput", + "description": "Specifies the cart from which to remove a coupon.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RemoveCouponFromCartOutput", + "description": "Contains details about the cart after removing a coupon.", + "fields": [ + { + "name": "cart", + "description": "The cart after removing a coupon.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AddSimpleProductsToCartOutput", + "description": "Contains details about the cart after adding simple or group products.", + "fields": [ + { + "name": "cart", + "description": "The cart after adding products.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AddVirtualProductsToCartOutput", + "description": "Contains details about the cart after adding virtual products.", + "fields": [ + { + "name": "cart", + "description": "The cart after adding products.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateCartItemsOutput", + "description": "Contains details about the cart after updating items.", + "fields": [ + { + "name": "cart", + "description": "The cart after updating products.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errors", + "description": "Contains errors encountered while updating an item to the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartUserInputError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RemoveItemFromCartOutput", + "description": "Contains details about the cart after removing an item.", + "fields": [ + { + "name": "cart", + "description": "The cart after removing an item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SetGuestEmailOnCartOutput", + "description": "Contains details about the cart after setting the email of a guest.", + "fields": [ + { + "name": "cart", + "description": "The cart after setting the guest email.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SimpleCartItem", + "description": "An implementation for simple product cart items.", + "fields": [ + { + "name": "available_gift_wrapping", + "description": "The list of available gift wrapping options for the cart item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftWrapping", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizable_options", + "description": "An array containing the customizable options the shopper selected.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discount", + "description": "Contains discount for quote line item.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errors", + "description": "An array of errors encountered while loading the cart item", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartItemError", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_message", + "description": "The entered gift message for the cart item", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftMessage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping", + "description": "The selected gift wrapping for the cart item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftWrapping", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." + }, + { + "name": "is_available", + "description": "True if requested quantity is less than available stock, false otherwise.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "max_qty", + "description": "Line item max qty in quote template", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "min_qty", + "description": "Line item min qty in quote template", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "not_available_message", + "description": "Message to display when the product is not available with this selected option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note_from_buyer", + "description": "The buyer's quote line item note.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemNote", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note_from_seller", + "description": "The seller's quote line item note.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemNote", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CartItemPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Details about an item in the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of this item in the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CartItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CartItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VirtualCartItem", + "description": "An implementation for virtual product cart items.", + "fields": [ + { + "name": "customizable_options", + "description": "An array containing customizable options the shopper selected.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discount", + "description": "Contains discount for quote line item.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errors", + "description": "An array of errors encountered while loading the cart item", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartItemError", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." + }, + { + "name": "is_available", + "description": "True if requested quantity is less than available stock, false otherwise.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "max_qty", + "description": "Line item max qty in quote template", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "min_qty", + "description": "Line item min qty in quote template", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "not_available_message", + "description": "Message to display when the product is not available with this selected option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note_from_buyer", + "description": "The buyer's quote line item note.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemNote", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note_from_seller", + "description": "The seller's quote line item note.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemNote", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CartItemPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Details about an item in the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of this item in the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CartItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CartItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartItemError", + "description": "", + "fields": [ + { + "name": "code", + "description": "An error code that describes the error encountered", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CartItemErrorType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "A localized error message", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CartItemErrorType", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNDEFINED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_QTY", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_INCREMENTS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Discount", + "description": "Specifies the discount type and value for quote line item.", + "fields": [ + { + "name": "amount", + "description": "The amount of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "applied_to", + "description": "The type of the entity the discount is applied to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CartDiscountType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "coupon", + "description": "The coupon related to the discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "AppliedCoupon", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_discounting_locked", + "description": "Is quote discounting locked for line item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "A description of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "Quote line item discount value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CartDiscountType", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ITEM", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartItemPrices", + "description": "Contains details about the price of the item, including taxes and discounts.", + "fields": [ + { + "name": "catalog_discount", + "description": "The price discount for the unit price of the item represents the difference between its regular price and final price.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductDiscount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discounts", + "description": "An array of discounts to be applied to the cart item.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fixed_product_taxes", + "description": "An array of FPTs applied to the cart item.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FixedProductTax", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "original_item_price", + "description": "The value of the original unit price for the item, including discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "original_row_total", + "description": "The value of the original price multiplied by the quantity of the item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_including_tax", + "description": "The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "row_catalog_discount", + "description": "The price discount multiplied by the item quantity represents the total difference between the regular price and the final price for the entire quote item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductDiscount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "row_total", + "description": "The value of the price multiplied by the quantity of the item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "row_total_including_tax", + "description": "The value of `row_total` plus the tax applied to the item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_item_discount", + "description": "The total of all discounts applied to the item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "description": "Identifies a customized product that has been placed in a cart.", + "fields": [ + { + "name": "customizable_option_uid", + "description": "The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `SelectedCustomizableOption.customizable_option_uid` instead." + }, + { + "name": "is_required", + "description": "Indicates whether the customizable option is required.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The display name of the selected customizable option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "A value indicating the order to display this option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of `CustomizableOptionInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "values", + "description": "An array of selectable values.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOptionValue", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SelectedCustomizableOptionValue", + "description": "Identifies the value of the selected customized option.", + "fields": [ + { + "name": "customizable_option_value_uid", + "description": "The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `SelectedCustomizableOptionValue.customizable_option_value_uid` instead." + }, + { + "name": "label", + "description": "The display name of the selected value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price of the selected customizable value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartItemSelectedOptionValuePrice", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The text identifying the selected value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartItemSelectedOptionValuePrice", + "description": "Contains details about the price of a selected customizable value.", + "fields": [ + { + "name": "type", + "description": "Indicates whether the price type is fixed, percent, or dynamic.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PriceTypeEnum", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "units", + "description": "A string that describes the unit of the value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "A price value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Order", + "description": "Contains the order ID.", + "fields": [ + { + "name": "order_id", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `order_number` instead." + }, + { + "name": "order_number", + "description": "The unique ID for an `Order` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "Error", + "description": "An error encountered while adding an item to the the cart.", + "fields": [ + { + "name": "code", + "description": "A cart-specific error code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CartUserInputErrorType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "A localized error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CartUserInputError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "InsufficientStockError", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "CartUserInputError", + "description": "", + "fields": [ + { + "name": "code", + "description": "A cart-specific error code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CartUserInputErrorType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "A localized error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Error", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InsufficientStockError", + "description": "", + "fields": [ + { + "name": "code", + "description": "A cart-specific error code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CartUserInputErrorType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "A localized error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "Amount of available stock", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Error", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AddProductsToCartOutput", + "description": "Contains details about the cart after adding products to it.", + "fields": [ + { + "name": "cart", + "description": "The cart after products have been added.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "user_errors", + "description": "Contains errors encountered while adding an item to the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "Error", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CartUserInputErrorType", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRODUCT_NOT_FOUND", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_SALABLE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INSUFFICIENT_STOCK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COULD_NOT_FIND_CART_ITEM", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REQUIRED_PARAMETER_MISSING", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_PARAMETER_VALUE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNDEFINED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PERMISSION_DENIED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductImageThumbnail", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ITSELF", + "description": "Use thumbnail of product as image.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PARENT", + "description": "Use thumbnail of product's parent as image.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "EstimateTotalsInput", + "description": "", + "fields": null, + "inputFields": [ + { + "name": "address", + "description": "Customer's address to estimate totals.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "EstimateAddressInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "cart_id", + "description": "The unique ID of the cart to query.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "shipping_method", + "description": "Selected shipping method to estimate totals.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ShippingMethodInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "EstimateTotalsOutput", + "description": "Estimate totals output.", + "fields": [ + { + "name": "cart", + "description": "Cart after totals estimation", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "EstimateAddressInput", + "description": "Contains details about an address.", + "fields": null, + "inputFields": [ + { + "name": "country_code", + "description": "The two-letter code representing the customer's country.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCodeEnum", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "postcode", + "description": "The customer's ZIP or postal code.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "region", + "description": "An object containing the region name, region code, and region ID.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerAddressRegionInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutAgreement", + "description": "Defines details about an individual checkout agreement.", + "fields": [ + { + "name": "agreement_id", + "description": "The ID for a checkout agreement.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkbox_text", + "description": "The checkbox text for the checkout agreement.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "content", + "description": "Required. The text of the agreement.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "content_height", + "description": "The height of the text box where the Terms and Conditions statement appears during checkout.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_html", + "description": "Indicates whether the `content` text is in HTML format.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mode", + "description": "Indicates whether agreements are accepted automatically or manually.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CheckoutAgreementMode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name given to the condition.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CheckoutAgreementMode", + "description": "Indicates how agreements are accepted.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "AUTO", + "description": "Conditions are automatically accepted upon checkout.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MANUAL", + "description": "Shoppers must manually accept the conditions to place an order.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ConfirmEmailInput", + "description": "Contains details about a customer email address to confirm.", + "fields": null, + "inputFields": [ + { + "name": "confirmation_key", + "description": "The key to confirm the email address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "The email address to be confirmed.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerAddressInput", + "description": "Contains details about a billing or shipping address.", + "fields": null, + "inputFields": [ + { + "name": "city", + "description": "The customer's city or town.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "company", + "description": "The customer's company.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "country_code", + "description": "The two-letter code representing the customer's country.", + "type": { + "kind": "ENUM", + "name": "CountryCodeEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "country_id", + "description": "", + "type": { + "kind": "ENUM", + "name": "CountryCodeEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "custom_attributes", + "description": "", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerAddressAttributeInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "custom_attributesV2", + "description": "Custom attributes assigned to the customer address.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeValueInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "default_billing", + "description": "Indicates whether the address is the default billing address.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "default_shipping", + "description": "Indicates whether the address is the default shipping address.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fax", + "description": "The customer's fax number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "firstname", + "description": "The first name of the person associated with the billing/shipping address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lastname", + "description": "The family name of the person associated with the billing/shipping address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "middlename", + "description": "The middle name of the person associated with the billing/shipping address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "postcode", + "description": "The customer's ZIP or postal code.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "region", + "description": "An object containing the region name, region code, and region ID.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerAddressRegionInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "street", + "description": "An array of strings that define the street number and name.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "telephone", + "description": "The customer's telephone number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "vat_id", + "description": "The customer's Tax/VAT number (for corporate customers).", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerAddressRegionInput", + "description": "Defines the customer's state or province.", + "fields": null, + "inputFields": [ + { + "name": "region", + "description": "The state or province name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "region_code", + "description": "The address region code.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "region_id", + "description": "The unique ID for a pre-defined region.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerAddressAttributeInput", + "description": "Specifies the attribute code and value of a customer attribute.", + "fields": null, + "inputFields": [ + { + "name": "attribute_code", + "description": "The name assigned to the attribute.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The value assigned to the attribute.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerToken", + "description": "Contains a customer authorization token.", + "fields": [ + { + "name": "token", + "description": "The customer authorization token.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerInput", + "description": "An input object that assigns or updates customer attributes.", + "fields": null, + "inputFields": [ + { + "name": "date_of_birth", + "description": "The customer's date of birth.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "dob", + "description": "", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "email", + "description": "The customer's email address. Required when creating a customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "firstname", + "description": "The customer's first name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "gender", + "description": "The customer's gender (Male - 1, Female - 2).", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "is_subscribed", + "description": "Indicates whether the customer is subscribed to the company's newsletter.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lastname", + "description": "The customer's family name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "middlename", + "description": "The customer's middle name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "password", + "description": "The customer's password.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "taxvat", + "description": "The customer's Tax/VAT number (for corporate customers).", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerCreateInput", + "description": "An input object for creating a customer.", + "fields": null, + "inputFields": [ + { + "name": "allow_remote_shopping_assistance", + "description": "Indicates whether the customer has enabled remote shopping assistance.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "custom_attributes", + "description": "The customer's custom attributes.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeValueInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "date_of_birth", + "description": "The customer's date of birth.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "dob", + "description": "", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "email", + "description": "The customer's email address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "firstname", + "description": "The customer's first name.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "gender", + "description": "The customer's gender (Male - 1, Female - 2).", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "is_subscribed", + "description": "Indicates whether the customer is subscribed to the company's newsletter.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lastname", + "description": "The customer's family name.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "middlename", + "description": "The customer's middle name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "password", + "description": "The customer's password.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "taxvat", + "description": "The customer's Tax/VAT number (for corporate customers).", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerUpdateInput", + "description": "An input object for updating a customer.", + "fields": null, + "inputFields": [ + { + "name": "allow_remote_shopping_assistance", + "description": "Indicates whether the customer has enabled remote shopping assistance.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "custom_attributes", + "description": "The customer's custom attributes.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeValueInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "date_of_birth", + "description": "The customer's date of birth.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "dob", + "description": "", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "firstname", + "description": "The customer's first name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "gender", + "description": "The customer's gender (Male - 1, Female - 2).", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "is_subscribed", + "description": "Indicates whether the customer is subscribed to the company's newsletter.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lastname", + "description": "The customer's family name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "middlename", + "description": "The customer's middle name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "taxvat", + "description": "The customer's Tax/VAT number (for corporate customers).", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerOutput", + "description": "Contains details about a newly-created or updated customer.", + "fields": [ + { + "name": "customer", + "description": "Customer details after creating or updating a customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RevokeCustomerTokenOutput", + "description": "Contains the result of a request to revoke a customer token.", + "fields": [ + { + "name": "result", + "description": "The result of a request to revoke a customer token.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Customer", + "description": "Defines the customer name, addresses, and other details.", + "fields": [ + { + "name": "addresses", + "description": "An array containing the customer's shipping and billing addresses.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerAddress", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addressesV2", + "description": "An array containing the customer's shipping and billing addresses.", + "args": [ + { + "name": "currentPage", + "description": "Specifies which page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "pageSize", + "description": "Specifies the maximum number of results to return at once. The default value is 5.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "5" + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAddresses", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "allow_remote_shopping_assistance", + "description": "Indicates whether the customer has enabled remote shopping assistance.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companies", + "description": "An object that contains a list of companies user is assigned to.", + "args": [ + { + "name": "input", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "UserCompaniesInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserCompaniesOutput", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "compare_list", + "description": "The contents of the customer's compare list.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompareList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "confirmation_status", + "description": "The customer's confirmation status.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ConfirmationStatusEnum", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "Timestamp indicating when the account was created.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_attributes", + "description": "Customer's custom attributes.", + "args": [ + { + "name": "attributeCodes", + "description": "", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "date_of_birth", + "description": "The customer's date of birth.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "default_billing", + "description": "The ID assigned to the billing address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "default_shipping", + "description": "The ID assigned to the shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "dob", + "description": "The customer's date of birth.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `date_of_birth` instead." + }, + { + "name": "email", + "description": "The customer's email address. Required.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstname", + "description": "The customer's first name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gender", + "description": "The customer's gender (Male - 1, Female - 2).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_registries", + "description": "Details about all of the customer's gift registries.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftRegistry", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_registry", + "description": "Details about a specific gift registry.", + "args": [ + { + "name": "giftRegistryUid", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "GiftRegistry", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "group", + "description": "Customer group assigned to the customer", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerGroupStorefront", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "group_id", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Customer group should not be exposed in the storefront scenarios." + }, + { + "name": "id", + "description": "The unique ID assigned to the customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_subscribed", + "description": "Indicates whether the customer is subscribed to the company's newsletter.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "job_title", + "description": "The job title of a company user.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastname", + "description": "The customer's family name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "middlename", + "description": "The customer's middle name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders", + "description": null, + "args": [ + { + "name": "filter", + "description": "Defines the filter to use for searching customer orders.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerOrdersFilterInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "currentPage", + "description": "Specifies which page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "pageSize", + "description": "Specifies the maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "sort", + "description": "Specifies which field to sort on, and whether to return the results in ascending or descending order.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerOrderSortInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "scope", + "description": "Specifies the scope to search for customer orders. The Store request header identifies the customer's store view code. The default value of STORE limits the search to the value specified in the header. Specify WEBSITE to expand the search to include all customer orders assigned to the website that is defined in the header, or specify GLOBAL to include all customer orders across all websites and stores.", + "type": { + "kind": "ENUM", + "name": "ScopeTypeEnum", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerOrders", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "purchase_order", + "description": "Purchase order details.", + "args": [ + { + "name": "uid", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PurchaseOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "purchase_order_approval_rule", + "description": "Details about a single purchase order approval rule.", + "args": [ + { + "name": "uid", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PurchaseOrderApprovalRule", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "purchase_order_approval_rule_metadata", + "description": "Purchase order approval rule metadata that can be used for rule edit form rendering.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PurchaseOrderApprovalRuleMetadata", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "purchase_order_approval_rules", + "description": "A list of purchase order approval rules visible to the customer.", + "args": [ + { + "name": "currentPage", + "description": "", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "pageSize", + "description": "", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + } + ], + "type": { + "kind": "OBJECT", + "name": "PurchaseOrderApprovalRules", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "purchase_orders", + "description": "A list of purchase orders visible to the customer.", + "args": [ + { + "name": "filter", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "PurchaseOrdersFilterInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "currentPage", + "description": "", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "pageSize", + "description": "", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + } + ], + "type": { + "kind": "OBJECT", + "name": "PurchaseOrders", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "purchase_orders_enabled", + "description": "Indicates whether purchase order functionality is enabled for the current customer. Global and company-level settings are factored into the result.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requisition_lists", + "description": "An object that contains the customer's requisition lists.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "filter", + "description": "The filter to use to limit the number of requisition lists to return.", + "type": { + "kind": "INPUT_OBJECT", + "name": "RequisitionListFilterInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RequisitionLists", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "return", + "description": "Details about the specified return request from the unique ID for a `Return` object.", + "args": [ + { + "name": "uid", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Return", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returns", + "description": "Information about the customer's return requests.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "OBJECT", + "name": "Returns", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reviews", + "description": "Contains the customer's product reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reward_points", + "description": "Customer reward points details.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RewardPoints", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "role", + "description": "The role name and permissions assigned to the company user.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanyRole", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "segments", + "description": "Customer segments associated with the current customer", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerSegmentStorefront", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "Indicates whether the company user is ACTIVE or INACTIVE.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CompanyUserStatusEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "store_credit", + "description": "Store credit information applied for the logged in customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerStoreCredit", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "structure_id", + "description": "ID of the company structure", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxvat", + "description": "The customer's Value-added tax (VAT) number (for corporate customers).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "team", + "description": "The team the company user is assigned to.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanyTeam", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "telephone", + "description": "The phone number of the company user.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "wishlist", + "description": "Return a customer's wish lists.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Wishlist", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `Customer.wishlists` or `Customer.wishlist_v2` instead." + }, + { + "name": "wishlist_v2", + "description": "Retrieve the wish list identified by the unique ID for a `Wishlist` object.", + "args": [ + { + "name": "id", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Wishlist", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "wishlists", + "description": "An array of wishlists. In Magento Open Source, customers are limited to one wish list. The number of wish lists is configurable for Adobe Commerce.", + "args": [ + { + "name": "pageSize", + "description": "Specifies the maximum number of results to return at once. This attribute is optional.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "Specifies which page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Wishlist", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerAddresses", + "description": "", + "fields": [ + { + "name": "items", + "description": "An array containing the customer's shipping and billing addresses.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerAddress", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Contains pagination metadata.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The total count of customer addresses.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerAddress", + "description": "Contains detailed information about a customer's billing or shipping address.", + "fields": [ + { + "name": "city", + "description": "The customer's city or town.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company", + "description": "The customer's company.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country_code", + "description": "The customer's country.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CountryCodeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country_id", + "description": "The customer's country.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `country_code` instead." + }, + { + "name": "custom_attributes", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerAddressAttribute", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use custom_attributesV2 instead." + }, + { + "name": "custom_attributesV2", + "description": "Custom attributes assigned to the customer address.", + "args": [ + { + "name": "attributeCodes", + "description": "", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer_id", + "description": "The customer ID", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "`customer_id` is not needed as part of `CustomerAddress`. The `id` is a unique identifier for the addresses." + }, + { + "name": "default_billing", + "description": "Indicates whether the address is the customer's default billing address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "default_shipping", + "description": "Indicates whether the address is the customer's default shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "extension_attributes", + "description": "Contains any extension attributes for the address.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerAddressAttribute", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fax", + "description": "The customer's fax number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstname", + "description": "The first name of the person associated with the shipping/billing address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID of a `CustomerAddress` object.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." + }, + { + "name": "lastname", + "description": "The family name of the person associated with the shipping/billing address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "middlename", + "description": "The middle name of the person associated with the shipping/billing address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "postcode", + "description": "The customer's ZIP or postal code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "region", + "description": "An object containing the region name, region code, and region ID.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerAddressRegion", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "region_id", + "description": "The unique ID for a pre-defined region.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "street", + "description": "An array of strings that define the street number and name.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "telephone", + "description": "The customer's telephone number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CustomerAddress` object.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vat_id", + "description": "The customer's Value-added tax (VAT) number (for corporate customers).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerAddressRegion", + "description": "Defines the customer's state or province.", + "fields": [ + { + "name": "region", + "description": "The state or province name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "region_code", + "description": "The address region code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "region_id", + "description": "The unique ID for a pre-defined region.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerAddressAttribute", + "description": "Specifies the attribute code and value of a customer address attribute.", + "fields": [ + { + "name": "attribute_code", + "description": "The name assigned to the customer address attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value assigned to the customer address attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "IsEmailAvailableOutput", + "description": "Contains the result of the `isEmailAvailable` query.", + "fields": [ + { + "name": "is_email_available", + "description": "Indicates whether the specified email address can be used to create a customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CountryCodeEnum", + "description": "The list of country codes.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "AF", + "description": "Afghanistan", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AX", + "description": "Åland Islands", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AL", + "description": "Albania", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DZ", + "description": "Algeria", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AS", + "description": "American Samoa", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AD", + "description": "Andorra", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AO", + "description": "Angola", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AI", + "description": "Anguilla", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AQ", + "description": "Antarctica", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AG", + "description": "Antigua & Barbuda", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AR", + "description": "Argentina", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AM", + "description": "Armenia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AW", + "description": "Aruba", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AU", + "description": "Australia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AT", + "description": "Austria", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AZ", + "description": "Azerbaijan", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BS", + "description": "Bahamas", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BH", + "description": "Bahrain", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BD", + "description": "Bangladesh", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BB", + "description": "Barbados", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BY", + "description": "Belarus", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BE", + "description": "Belgium", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BZ", + "description": "Belize", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BJ", + "description": "Benin", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BM", + "description": "Bermuda", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BT", + "description": "Bhutan", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BO", + "description": "Bolivia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BA", + "description": "Bosnia & Herzegovina", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BW", + "description": "Botswana", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BV", + "description": "Bouvet Island", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BR", + "description": "Brazil", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IO", + "description": "British Indian Ocean Territory", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VG", + "description": "British Virgin Islands", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BN", + "description": "Brunei", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BG", + "description": "Bulgaria", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BF", + "description": "Burkina Faso", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BI", + "description": "Burundi", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KH", + "description": "Cambodia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CM", + "description": "Cameroon", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA", + "description": "Canada", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CV", + "description": "Cape Verde", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KY", + "description": "Cayman Islands", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CF", + "description": "Central African Republic", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TD", + "description": "Chad", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CL", + "description": "Chile", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CN", + "description": "China", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CX", + "description": "Christmas Island", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CC", + "description": "Cocos (Keeling) Islands", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CO", + "description": "Colombia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KM", + "description": "Comoros", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CG", + "description": "Congo-Brazzaville", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CD", + "description": "Congo-Kinshasa", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CK", + "description": "Cook Islands", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CR", + "description": "Costa Rica", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CI", + "description": "Côte d’Ivoire", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HR", + "description": "Croatia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CU", + "description": "Cuba", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CY", + "description": "Cyprus", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CZ", + "description": "Czech Republic", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DK", + "description": "Denmark", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DJ", + "description": "Djibouti", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DM", + "description": "Dominica", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DO", + "description": "Dominican Republic", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EC", + "description": "Ecuador", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EG", + "description": "Egypt", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SV", + "description": "El Salvador", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GQ", + "description": "Equatorial Guinea", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ER", + "description": "Eritrea", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EE", + "description": "Estonia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SZ", + "description": "Eswatini", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ET", + "description": "Ethiopia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FK", + "description": "Falkland Islands", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FO", + "description": "Faroe Islands", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FJ", + "description": "Fiji", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FI", + "description": "Finland", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FR", + "description": "France", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GF", + "description": "French Guiana", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PF", + "description": "French Polynesia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TF", + "description": "French Southern Territories", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GA", + "description": "Gabon", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GM", + "description": "Gambia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GE", + "description": "Georgia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DE", + "description": "Germany", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GH", + "description": "Ghana", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GI", + "description": "Gibraltar", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GR", + "description": "Greece", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GL", + "description": "Greenland", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GD", + "description": "Grenada", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GP", + "description": "Guadeloupe", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GU", + "description": "Guam", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GT", + "description": "Guatemala", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GG", + "description": "Guernsey", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GN", + "description": "Guinea", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GW", + "description": "Guinea-Bissau", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GY", + "description": "Guyana", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HT", + "description": "Haiti", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HM", + "description": "Heard & McDonald Islands", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HN", + "description": "Honduras", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HK", + "description": "Hong Kong SAR China", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HU", + "description": "Hungary", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IS", + "description": "Iceland", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IN", + "description": "India", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Indonesia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IR", + "description": "Iran", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IQ", + "description": "Iraq", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IE", + "description": "Ireland", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IM", + "description": "Isle of Man", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IL", + "description": "Israel", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IT", + "description": "Italy", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JM", + "description": "Jamaica", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JP", + "description": "Japan", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JE", + "description": "Jersey", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JO", + "description": "Jordan", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KZ", + "description": "Kazakhstan", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KE", + "description": "Kenya", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KI", + "description": "Kiribati", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KW", + "description": "Kuwait", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KG", + "description": "Kyrgyzstan", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LA", + "description": "Laos", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LV", + "description": "Latvia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LB", + "description": "Lebanon", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LS", + "description": "Lesotho", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LR", + "description": "Liberia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LY", + "description": "Libya", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LI", + "description": "Liechtenstein", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LT", + "description": "Lithuania", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LU", + "description": "Luxembourg", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MO", + "description": "Macau SAR China", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MK", + "description": "Macedonia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MG", + "description": "Madagascar", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MW", + "description": "Malawi", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MY", + "description": "Malaysia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MV", + "description": "Maldives", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ML", + "description": "Mali", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MT", + "description": "Malta", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MH", + "description": "Marshall Islands", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MQ", + "description": "Martinique", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MR", + "description": "Mauritania", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MU", + "description": "Mauritius", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "YT", + "description": "Mayotte", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MX", + "description": "Mexico", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FM", + "description": "Micronesia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MD", + "description": "Moldova", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MC", + "description": "Monaco", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MN", + "description": "Mongolia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ME", + "description": "Montenegro", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MS", + "description": "Montserrat", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MA", + "description": "Morocco", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MZ", + "description": "Mozambique", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MM", + "description": "Myanmar (Burma)", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NA", + "description": "Namibia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NR", + "description": "Nauru", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NP", + "description": "Nepal", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NL", + "description": "Netherlands", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AN", + "description": "Netherlands Antilles", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NC", + "description": "New Caledonia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NZ", + "description": "New Zealand", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NI", + "description": "Nicaragua", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NE", + "description": "Niger", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NG", + "description": "Nigeria", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NU", + "description": "Niue", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NF", + "description": "Norfolk Island", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MP", + "description": "Northern Mariana Islands", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KP", + "description": "North Korea", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NO", + "description": "Norway", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OM", + "description": "Oman", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PK", + "description": "Pakistan", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PW", + "description": "Palau", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PS", + "description": "Palestinian Territories", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PA", + "description": "Panama", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PG", + "description": "Papua New Guinea", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PY", + "description": "Paraguay", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PE", + "description": "Peru", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PH", + "description": "Philippines", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PN", + "description": "Pitcairn Islands", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PL", + "description": "Poland", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PT", + "description": "Portugal", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "QA", + "description": "Qatar", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RE", + "description": "Réunion", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RO", + "description": "Romania", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RU", + "description": "Russia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RW", + "description": "Rwanda", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WS", + "description": "Samoa", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SM", + "description": "San Marino", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ST", + "description": "São Tomé & Príncipe", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SA", + "description": "Saudi Arabia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SN", + "description": "Senegal", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RS", + "description": "Serbia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SC", + "description": "Seychelles", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SL", + "description": "Sierra Leone", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SG", + "description": "Singapore", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SK", + "description": "Slovakia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SI", + "description": "Slovenia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SB", + "description": "Solomon Islands", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SO", + "description": "Somalia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZA", + "description": "South Africa", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GS", + "description": "South Georgia & South Sandwich Islands", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KR", + "description": "South Korea", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ES", + "description": "Spain", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LK", + "description": "Sri Lanka", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BL", + "description": "St. Barthélemy", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SH", + "description": "St. Helena", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KN", + "description": "St. Kitts & Nevis", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LC", + "description": "St. Lucia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MF", + "description": "St. Martin", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PM", + "description": "St. Pierre & Miquelon", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VC", + "description": "St. Vincent & Grenadines", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SD", + "description": "Sudan", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SR", + "description": "Suriname", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SJ", + "description": "Svalbard & Jan Mayen", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SE", + "description": "Sweden", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CH", + "description": "Switzerland", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SY", + "description": "Syria", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TW", + "description": "Taiwan", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TJ", + "description": "Tajikistan", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TZ", + "description": "Tanzania", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TH", + "description": "Thailand", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TL", + "description": "Timor-Leste", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TG", + "description": "Togo", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TK", + "description": "Tokelau", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TO", + "description": "Tonga", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TT", + "description": "Trinidad & Tobago", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TN", + "description": "Tunisia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TR", + "description": "Turkey", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TM", + "description": "Turkmenistan", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TC", + "description": "Turks & Caicos Islands", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TV", + "description": "Tuvalu", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UG", + "description": "Uganda", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UA", + "description": "Ukraine", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AE", + "description": "United Arab Emirates", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GB", + "description": "United Kingdom", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US", + "description": "United States", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UY", + "description": "Uruguay", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UM", + "description": "U.S. Outlying Islands", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VI", + "description": "U.S. Virgin Islands", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UZ", + "description": "Uzbekistan", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VU", + "description": "Vanuatu", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VA", + "description": "Vatican City", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VE", + "description": "Venezuela", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VN", + "description": "Vietnam", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WF", + "description": "Wallis & Futuna", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EH", + "description": "Western Sahara", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "YE", + "description": "Yemen", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZM", + "description": "Zambia", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZW", + "description": "Zimbabwe", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerAttributeMetadata", + "description": "Customer attribute metadata.", + "fields": [ + { + "name": "code", + "description": "The unique identifier for an attribute code. This value should be in lowercase letters without spaces.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "default_value", + "description": "Default attribute value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "entity_type", + "description": "The type of entity that defines the attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AttributeEntityTypeEnum", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "frontend_class", + "description": "The frontend class of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "frontend_input", + "description": "The frontend input type of the attribute.", + "args": [], + "type": { + "kind": "ENUM", + "name": "AttributeFrontendInputEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "input_filter", + "description": "The template used for the input of the attribute (e.g., 'date').", + "args": [], + "type": { + "kind": "ENUM", + "name": "InputFilterEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_required", + "description": "Whether the attribute value is required.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_unique", + "description": "Whether the attribute value must be unique.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The label assigned to the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "multiline_count", + "description": "The number of lines of the attribute value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "Attribute options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CustomAttributeOptionInterface", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The position of the attribute in the form.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "validate_rules", + "description": "The validation rules of the attribute value.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ValidationRule", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CustomAttributeMetadataInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "InputFilterEnum", + "description": "List of templates/filters applied to customer attribute input.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NONE", + "description": "There are no templates or filters to be applied.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DATE", + "description": "Forces attribute input to follow the date format.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TRIM", + "description": "Strip whitespace (or other characters) from the beginning and end of the input.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STRIPTAGS", + "description": "Strip HTML Tags.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ESCAPEHTML", + "description": "Escape HTML Entities.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ValidationRule", + "description": "Defines a customer attribute validation rule.", + "fields": [ + { + "name": "name", + "description": "Validation rule name applied to a customer attribute.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ValidationRuleEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "Validation rule value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ValidationRuleEnum", + "description": "List of validation rule names applied to a customer attribute.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DATE_RANGE_MAX", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DATE_RANGE_MIN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FILE_EXTENSIONS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INPUT_VALIDATION", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MAX_TEXT_LENGTH", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MIN_TEXT_LENGTH", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MAX_FILE_SIZE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MAX_IMAGE_HEIGHT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MAX_IMAGE_WIDTH", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ConfirmationStatusEnum", + "description": "List of account confirmation statuses.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACCOUNT_CONFIRMED", + "description": "Account confirmed", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ACCOUNT_CONFIRMATION_NOT_REQUIRED", + "description": "Account confirmation not required", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerGroupStorefront", + "description": "Data of customer group.", + "fields": [ + { + "name": "uid", + "description": "The unique ID for a `CustomerGroup` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RequestNegotiableQuoteInput", + "description": "Defines properties of a negotiable quote request.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The cart ID of the buyer requesting a new negotiable quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "comment", + "description": "Comments the buyer entered to describe the request.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteCommentInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "is_draft", + "description": "Flag indicating if quote is draft or not.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "quote_name", + "description": "The name the buyer assigned to the negotiable quote request.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "UpdateNegotiableQuoteQuantitiesInput", + "description": "Specifies the items to update.", + "fields": null, + "inputFields": [ + { + "name": "items", + "description": "An array of items to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteItemQuantityInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "quote_uid", + "description": "The unique ID of a `NegotiableQuote` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteItemQuantityInput", + "description": "Specifies the updated quantity of an item.", + "fields": null, + "inputFields": [ + { + "name": "quantity", + "description": "The new quantity of the negotiable quote item.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quote_item_uid", + "description": "The unique ID of a `CartItemInterface` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateNegotiableQuoteItemsQuantityOutput", + "description": "Contains the updated negotiable quote.", + "fields": [ + { + "name": "quote", + "description": "The updated negotiable quote.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuote", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PlaceNegotiableQuoteOrderInput", + "description": "Specifies the negotiable quote to convert to an order.", + "fields": null, + "inputFields": [ + { + "name": "quote_uid", + "description": "The unique ID of a `NegotiableQuote` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PlaceNegotiableQuoteOrderOutput", + "description": "An output object that returns the generated order.", + "fields": [ + { + "name": "order", + "description": "Contains the generated order number.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SendNegotiableQuoteForReviewInput", + "description": "Specifies which negotiable quote to send for review.", + "fields": null, + "inputFields": [ + { + "name": "comment", + "description": "A comment for the seller to review.", + "type": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteCommentInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "quote_uid", + "description": "The unique ID of a `NegotiableQuote` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SendNegotiableQuoteForReviewOutput", + "description": "Contains the negotiable quote.", + "fields": [ + { + "name": "quote", + "description": "The negotiable quote after sending for seller review.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuote", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SetNegotiableQuoteShippingAddressInput", + "description": "Defines the shipping address to assign to the negotiable quote.", + "fields": null, + "inputFields": [ + { + "name": "customer_address_id", + "description": "The unique ID of a `CustomerAddress` object.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "quote_uid", + "description": "The unique ID of a `NegotiableQuote` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "shipping_addresses", + "description": "An array of shipping addresses to apply to the negotiable quote.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteShippingAddressInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteShippingAddressInput", + "description": "Defines shipping addresses for the negotiable quote.", + "fields": null, + "inputFields": [ + { + "name": "address", + "description": "A shipping address.", + "type": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteAddressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customer_address_uid", + "description": "An ID from the company user's address book that uniquely identifies the address to be used for shipping.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customer_notes", + "description": "Text provided by the company user.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SetNegotiableQuoteBillingAddressInput", + "description": "Sets the billing address.", + "fields": null, + "inputFields": [ + { + "name": "billing_address", + "description": "The billing address to be added.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteBillingAddressInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quote_uid", + "description": "The unique ID of a `NegotiableQuote` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteBillingAddressInput", + "description": "Defines the billing address.", + "fields": null, + "inputFields": [ + { + "name": "address", + "description": "Defines a billing address.", + "type": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteAddressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customer_address_uid", + "description": "The unique ID of a `CustomerAddress` object.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "same_as_shipping", + "description": "Indicates whether to set the billing address to be the same as the existing shipping address on the negotiable quote.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "use_for_shipping", + "description": "Indicates whether to set the shipping address to be the same as this billing address.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteAddressInput", + "description": "Defines the billing or shipping address to be applied to the cart.", + "fields": null, + "inputFields": [ + { + "name": "city", + "description": "The city specified for the billing or shipping address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "company", + "description": "The company name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "country_code", + "description": "The country code and label for the billing or shipping address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "firstname", + "description": "The first name of the company user.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lastname", + "description": "The last name of the company user.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "postcode", + "description": "The ZIP or postal code of the billing or shipping address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "region", + "description": "A string that defines the state or province of the billing or shipping address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "region_id", + "description": "An integer that defines the state or province of the billing or shipping address.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "save_in_address_book", + "description": "Determines whether to save the address in the customer's address book. The default value is true.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "street", + "description": "An array containing the street for the billing or shipping address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "telephone", + "description": "The telephone number for the billing or shipping address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SetNegotiableQuoteShippingMethodsInput", + "description": "Defines the shipping method to apply to the negotiable quote.", + "fields": null, + "inputFields": [ + { + "name": "quote_uid", + "description": "The unique ID of a `NegotiableQuote` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "shipping_methods", + "description": "An array of shipping methods to apply to the negotiable quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ShippingMethodInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "LineItemNoteInput", + "description": "Sets quote item note.", + "fields": null, + "inputFields": [ + { + "name": "note", + "description": "The note text to be added.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "quote_item_uid", + "description": "The unique ID of a `CartLineItem` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quote_uid", + "description": "The unique ID of a `NegotiableQuote` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RenameNegotiableQuoteInput", + "description": "Sets new name for a negotiable quote.", + "fields": null, + "inputFields": [ + { + "name": "quote_comment", + "description": "The reason for the quote name change specified by the buyer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "quote_name", + "description": "The new quote name the buyer specified to the negotiable quote request.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quote_uid", + "description": "The cart ID of the buyer requesting a new negotiable quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SetLineItemNoteOutput", + "description": "Contains the updated negotiable quote.", + "fields": [ + { + "name": "quote", + "description": "The negotiable quote after sending for seller review.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuote", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MoveLineItemToRequisitionListInput", + "description": "Move Line Item to Requisition List.", + "fields": null, + "inputFields": [ + { + "name": "quote_item_uid", + "description": "The unique ID of a `CartLineItem` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quote_uid", + "description": "The unique ID of a `NegotiableQuote` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "requisition_list_uid", + "description": "The unique ID of a requisition list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MoveLineItemToRequisitionListOutput", + "description": "Contains the updated negotiable quote.", + "fields": [ + { + "name": "quote", + "description": "The negotiable quote after moving item to requisition list.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuote", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SetNegotiableQuoteShippingMethodsOutput", + "description": "Contains the negotiable quote.", + "fields": [ + { + "name": "quote", + "description": "The negotiable quote after applying shipping methods.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuote", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SetNegotiableQuoteShippingAddressOutput", + "description": "Contains the negotiable quote.", + "fields": [ + { + "name": "quote", + "description": "The negotiable quote after assigning a shipping address.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuote", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SetNegotiableQuoteBillingAddressOutput", + "description": "Contains the negotiable quote.", + "fields": [ + { + "name": "quote", + "description": "The negotiable quote after assigning a billing address.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuote", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RemoveNegotiableQuoteItemsInput", + "description": "Defines the items to remove from the specified negotiable quote.", + "fields": null, + "inputFields": [ + { + "name": "quote_item_uids", + "description": "An array of IDs indicating which items to remove from the negotiable quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "quote_uid", + "description": "The unique ID of a `NegotiableQuote` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RemoveNegotiableQuoteItemsOutput", + "description": "Contains the negotiable quote.", + "fields": [ + { + "name": "quote", + "description": "The negotiable quote after removing items.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuote", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CloseNegotiableQuotesInput", + "description": "Defines the negotiable quotes to mark as closed.", + "fields": null, + "inputFields": [ + { + "name": "quote_uids", + "description": "A list of unique IDs from `NegotiableQuote` objects.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CloseNegotiableQuotesOutput", + "description": "Contains the closed negotiable quotes and other negotiable quotes the company user can view.", + "fields": [ + { + "name": "closed_quotes", + "description": "An array containing the negotiable quotes that were just closed.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuote", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `operation_results` instead." + }, + { + "name": "negotiable_quotes", + "description": "A list of negotiable quotes that can be viewed by the logged-in customer", + "args": [ + { + "name": "filter", + "description": "The filter to use to determine which negotiable quotes to close.", + "type": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteFilterInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "sort", + "description": "The field to use for sorting results.", + "type": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteSortInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuotesOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "operation_results", + "description": "An array of closed negotiable quote UIDs and details about any errors.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "UNION", + "name": "CloseNegotiableQuoteOperationResult", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "result_status", + "description": "The status of the request to close one or more negotiable quotes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "BatchMutationStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RenameNegotiableQuoteOutput", + "description": "Contains the updated negotiable quote.", + "fields": [ + { + "name": "quote", + "description": "The negotiable quote after updating the name.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuote", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "CloseNegotiableQuoteOperationResult", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "NegotiableQuoteUidOperationSuccess", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CloseNegotiableQuoteOperationFailure", + "ofType": null + } + ] + }, + { + "kind": "UNION", + "name": "CloseNegotiableQuoteError", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "NegotiableQuoteInvalidStateError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "NoSuchEntityUidError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "InternalError", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "DeleteNegotiableQuotesOutput", + "description": "Contains a list of undeleted negotiable quotes the company user can view.", + "fields": [ + { + "name": "negotiable_quotes", + "description": "A list of negotiable quotes that the customer can view", + "args": [ + { + "name": "filter", + "description": "The filter to use to determine which negotiable quotes to delete.", + "type": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteFilterInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "sort", + "description": "The field to use for sorting results.", + "type": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteSortInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuotesOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "operation_results", + "description": "An array of deleted negotiable quote UIDs and details about any errors.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "UNION", + "name": "DeleteNegotiableQuoteOperationResult", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "result_status", + "description": "The status of the request to delete one or more negotiable quotes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "BatchMutationStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "DeleteNegotiableQuoteOperationResult", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "NegotiableQuoteUidOperationSuccess", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DeleteNegotiableQuoteOperationFailure", + "ofType": null + } + ] + }, + { + "kind": "UNION", + "name": "DeleteNegotiableQuoteError", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "NegotiableQuoteInvalidStateError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "NoSuchEntityUidError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "InternalError", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuotePaymentMethodInput", + "description": "Defines the payment method to be applied to the negotiable quote.", + "fields": null, + "inputFields": [ + { + "name": "code", + "description": "Payment method code", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "purchase_order_number", + "description": "The purchase order number. Optional for most payment methods.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SetNegotiableQuotePaymentMethodOutput", + "description": "Contains details about the negotiable quote after setting the payment method.", + "fields": [ + { + "name": "quote", + "description": "The updated negotiable quote.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuote", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuotesOutput", + "description": "Contains a list of negotiable that match the specified filter.", + "fields": [ + { + "name": "items", + "description": "A list of negotiable quotes", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuote", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Contains pagination metadata", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_fields", + "description": "Contains the default sort field and all available sort fields.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SortFields", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The number of negotiable quotes returned", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteSortInput", + "description": "Defines the field to use to sort a list of negotiable quotes.", + "fields": null, + "inputFields": [ + { + "name": "sort_direction", + "description": "Whether to return results in ascending or descending order.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sort_field", + "description": "The specified sort field.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "NegotiableQuoteSortableField", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "NegotiableQuoteSortableField", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "QUOTE_NAME", + "description": "Sorts negotiable quotes by name.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED_AT", + "description": "Sorts negotiable quotes by the dates they were created.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sorts negotiable quotes by the dates they were last modified.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteCommentInput", + "description": "Contains the commend provided by the buyer.", + "fields": null, + "inputFields": [ + { + "name": "comment", + "description": "The comment provided by the buyer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteComment", + "description": "Contains a single plain text comment from either the buyer or seller.", + "fields": [ + { + "name": "author", + "description": "The first and last name of the commenter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteUser", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "Timestamp indicating when the comment was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "creator_type", + "description": "Indicates whether a buyer or seller commented.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "NegotiableQuoteCommentCreatorType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "text", + "description": "The plain text comment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID of a `NegotiableQuoteComment` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "NegotiableQuoteCommentCreatorType", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BUYER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuote", + "description": "Contains details about a negotiable quote.", + "fields": [ + { + "name": "available_payment_methods", + "description": "An array of payment methods that can be applied to the negotiable quote.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AvailablePaymentMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "billing_address", + "description": "The billing address applied to the negotiable quote.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteBillingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "buyer", + "description": "The first and last name of the buyer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteUser", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "comments", + "description": "A list of comments made by the buyer and seller.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteComment", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "Timestamp indicating when the negotiable quote was created.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "The email address of the company user.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "history", + "description": "A list of status and price changes for the negotiable quote.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryEntry", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_virtual", + "description": "Indicates whether the negotiable quote contains only virtual products.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "The list of items in the negotiable quote.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CartItemInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The title assigned to the negotiable quote.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "A set of subtotals and totals applied to the negotiable quote.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CartPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "selected_payment_method", + "description": "The payment method that was applied to the negotiable quote.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SelectedPaymentMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shipping_addresses", + "description": "A list of shipping addresses applied to the negotiable quote.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteShippingAddress", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the negotiable quote.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "NegotiableQuoteStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_quantity", + "description": "The total number of items in the negotiable quote.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID of a `NegotiableQuote` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "Timestamp indicating when the negotiable quote was updated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "NegotiableQuoteStatus", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SUBMITTED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PENDING", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OPEN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDERED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CLOSED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DECLINED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXPIRED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DRAFT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteFilterInput", + "description": "Defines a filter to limit the negotiable quotes to return.", + "fields": null, + "inputFields": [ + { + "name": "ids", + "description": "Filter by the ID of one or more negotiable quotes.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": "Filter by the negotiable quote name.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterMatchTypeInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryEntry", + "description": "Contains details about a change for a negotiable quote.", + "fields": [ + { + "name": "author", + "description": "The person who made a change in the status of the negotiable quote.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteUser", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "change_type", + "description": "An enum that describes the why the entry in the negotiable quote history changed status.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "NegotiableQuoteHistoryEntryChangeType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "changes", + "description": "The set of changes in the negotiable quote.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryChanges", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "Timestamp indicating when the negotiable quote entry was created.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID of a `NegotiableQuoteHistoryEntry` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryChanges", + "description": "Contains a list of changes to a negotiable quote.", + "fields": [ + { + "name": "comment_added", + "description": "The comment provided with a change in the negotiable quote history.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryCommentChange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_changes", + "description": "Lists log entries added by third-party extensions.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteCustomLogChange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expiration", + "description": "The expiration date of the negotiable quote before and after a change in the quote history.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryExpirationChange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products_removed", + "description": "Lists products that were removed as a result of a change in the quote history.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryProductsRemovedChange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "statuses", + "description": "The status before and after a change in the negotiable quote history.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryStatusesChange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total", + "description": "The total amount of the negotiable quote before and after a change in the quote history.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryTotalChange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryStatusChange", + "description": "Lists a new status change applied to a negotiable quote and the previous status.", + "fields": [ + { + "name": "new_status", + "description": "The updated status.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "NegotiableQuoteStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "old_status", + "description": "The previous status. The value will be null for the first history entry in a negotiable quote.", + "args": [], + "type": { + "kind": "ENUM", + "name": "NegotiableQuoteStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryStatusesChange", + "description": "Contains a list of status changes that occurred for the negotiable quote.", + "fields": [ + { + "name": "changes", + "description": "A list of status changes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryStatusChange", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryCommentChange", + "description": "Contains a comment submitted by a seller or buyer.", + "fields": [ + { + "name": "comment", + "description": "A plain text comment submitted by a seller or buyer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryTotalChange", + "description": "Contains a new price and the previous price.", + "fields": [ + { + "name": "new_price", + "description": "The total price as a result of the change.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "old_price", + "description": "The previous total price on the negotiable quote.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryExpirationChange", + "description": "Contains a new expiration date and the previous date.", + "fields": [ + { + "name": "new_expiration", + "description": "The expiration date after the change. The value will be 'null' if not set.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "old_expiration", + "description": "The previous expiration date. The value will be 'null' if not previously set.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryProductsRemovedChange", + "description": "Contains lists of products that have been removed from the catalog and negotiable quote.", + "fields": [ + { + "name": "products_removed_from_catalog", + "description": "A list of product IDs the seller removed from the catalog.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products_removed_from_quote", + "description": "A list of products removed from the negotiable quote by either the buyer or the seller.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteCustomLogChange", + "description": "Contains custom log entries added by third-party extensions.", + "fields": [ + { + "name": "new_value", + "description": "The new entry content.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "old_value", + "description": "The previous entry in the custom log.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the custom log entry.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "NegotiableQuoteHistoryEntryChangeType", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CLOSED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_BY_SYSTEM", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RequestNegotiableQuoteOutput", + "description": "Contains the `NegotiableQuote` object generated when a buyer requests a negotiable quote.", + "fields": [ + { + "name": "quote", + "description": "Details about the negotiable quote.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuote", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "NegotiableQuoteAddressInterface", + "description": "", + "fields": [ + { + "name": "city", + "description": "The company's city or town.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company", + "description": "The company name associated with the shipping/billing address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "The company's country.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteAddressCountry", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstname", + "description": "The first name of the company user.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastname", + "description": "The last name of the company user.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "postcode", + "description": "The company's ZIP or postal code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "region", + "description": "An object containing the region name, region code, and region ID.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteAddressRegion", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "street", + "description": "An array of strings that define the street number and name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "telephone", + "description": "The customer's telephone number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "NegotiableQuoteShippingAddress", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteBillingAddress", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteAddressRegion", + "description": "Defines the company's state or province.", + "fields": [ + { + "name": "code", + "description": "The address region code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The display name of the region.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "region_id", + "description": "The unique ID for a pre-defined region.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteAddressCountry", + "description": "Defines the company's country.", + "fields": [ + { + "name": "code", + "description": "The address country code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The display name of the region.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteShippingAddress", + "description": "", + "fields": [ + { + "name": "available_shipping_methods", + "description": "An array of shipping methods available to the buyer.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AvailableShippingMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "The company's city or town.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company", + "description": "The company name associated with the shipping/billing address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "The company's country.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteAddressCountry", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstname", + "description": "The first name of the company user.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastname", + "description": "The last name of the company user.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "postcode", + "description": "The company's ZIP or postal code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "region", + "description": "An object containing the region name, region code, and region ID.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteAddressRegion", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "selected_shipping_method", + "description": "The selected shipping method.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SelectedShippingMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "street", + "description": "An array of strings that define the street number and name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "telephone", + "description": "The customer's telephone number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "NegotiableQuoteAddressInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteBillingAddress", + "description": "", + "fields": [ + { + "name": "city", + "description": "The company's city or town.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company", + "description": "The company name associated with the shipping/billing address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "The company's country.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteAddressCountry", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstname", + "description": "The first name of the company user.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastname", + "description": "The last name of the company user.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "postcode", + "description": "The company's ZIP or postal code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "region", + "description": "An object containing the region name, region code, and region ID.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteAddressRegion", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "street", + "description": "An array of strings that define the street number and name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "telephone", + "description": "The customer's telephone number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "NegotiableQuoteAddressInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteUser", + "description": "A limited view of a Buyer or Seller in the negotiable quote process.", + "fields": [ + { + "name": "firstname", + "description": "The first name of the buyer or seller making a change.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastname", + "description": "The buyer's or seller's last name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "NegotiableQuoteUidNonFatalResultInterface", + "description": "", + "fields": [ + { + "name": "quote_uid", + "description": "The unique ID of a `NegotiableQuote` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "NegotiableQuoteUidOperationSuccess", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteUidOperationSuccess", + "description": "Contains details about a successful operation on a negotiable quote.", + "fields": [ + { + "name": "quote_uid", + "description": "The unique ID of a `NegotiableQuote` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "NegotiableQuoteUidNonFatalResultInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteInvalidStateError", + "description": "An error indicating that an operation was attempted on a negotiable quote in an invalid state.", + "fields": [ + { + "name": "message", + "description": "The returned error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ErrorInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ItemNote", + "description": "The note object for quote line item.", + "fields": [ + { + "name": "created_at", + "description": "Timestamp that reflects note creation date.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "creator_id", + "description": "ID of the user who submitted a note.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "creator_type", + "description": "Type of teh user who submitted a note.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "negotiable_quote_item_uid", + "description": "The unique ID of a `CartItemInterface` object.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "Note text.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note_uid", + "description": "The unique ID of a `ItemNote` object.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CloseNegotiableQuoteOperationFailure", + "description": "Contains details about a failed close operation on a negotiable quote.", + "fields": [ + { + "name": "errors", + "description": "An array of errors encountered while attempting close the negotiable quote.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "UNION", + "name": "CloseNegotiableQuoteError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quote_uid", + "description": "The unique ID of a `NegotiableQuote` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DeleteNegotiableQuotesInput", + "description": "", + "fields": null, + "inputFields": [ + { + "name": "quote_uids", + "description": "A list of unique IDs for `NegotiableQuote` objects to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeleteNegotiableQuoteOperationFailure", + "description": "Contains details about a failed delete operation on a negotiable quote.", + "fields": [ + { + "name": "errors", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "UNION", + "name": "DeleteNegotiableQuoteError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quote_uid", + "description": "The unique ID of a `NegotiableQuote` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SetNegotiableQuotePaymentMethodInput", + "description": "Defines the payment method of the specified negotiable quote.", + "fields": null, + "inputFields": [ + { + "name": "payment_method", + "description": "The payment method to be assigned to the negotiable quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuotePaymentMethodInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quote_uid", + "description": "The unique ID of a `NegotiableQuote` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ComparableItem", + "description": "Defines an object used to iterate through items for product comparisons.", + "fields": [ + { + "name": "attributes", + "description": "An array of product attributes that can be used to compare products.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductAttribute", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Details about a product in a compare list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID of an item in a compare list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductAttribute", + "description": "Contains a product attribute code and value.", + "fields": [ + { + "name": "code", + "description": "The unique identifier for a product attribute code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The display value of the attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ComparableAttribute", + "description": "Contains an attribute code that is used for product comparisons.", + "fields": [ + { + "name": "code", + "description": "An attribute code that is enabled for product comparisons.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The label of the attribute code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompareList", + "description": "Contains iterable information such as the array of items, the count, and attributes that represent the compare list.", + "fields": [ + { + "name": "attributes", + "description": "An array of attributes that can be used for comparing products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ComparableAttribute", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "item_count", + "description": "The number of items in the compare list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "An array of products to compare.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ComparableItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID assigned to the compare list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CreateCompareListInput", + "description": "Contains an array of product IDs to use for creating a compare list.", + "fields": null, + "inputFields": [ + { + "name": "products", + "description": "An array of product IDs to add to the compare list.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AddProductsToCompareListInput", + "description": "Contains products to add to an existing compare list.", + "fields": null, + "inputFields": [ + { + "name": "products", + "description": "An array of product IDs to add to the compare list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "uid", + "description": "The unique identifier of the compare list to modify.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RemoveProductsFromCompareListInput", + "description": "Defines which products to remove from a compare list.", + "fields": null, + "inputFields": [ + { + "name": "products", + "description": "An array of product IDs to remove from the compare list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "uid", + "description": "The unique identifier of the compare list to modify.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeleteCompareListOutput", + "description": "Contains the results of the request to delete a compare list.", + "fields": [ + { + "name": "result", + "description": "Indicates whether the compare list was successfully deleted.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AssignCompareListToCustomerOutput", + "description": "Contains the results of the request to assign a compare list.", + "fields": [ + { + "name": "compare_list", + "description": "The contents of the customer's compare list.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompareList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "result", + "description": "Indicates whether the compare list was successfully assigned to the customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableProduct", + "description": "Defines basic features of a configurable product and its simple product variants.", + "fields": [ + { + "name": "activity", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "attribute_set_id", + "description": "The attribute set assigned to the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "categories", + "description": "The categories assigned to a product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CategoryInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "category_gear", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "climate", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "collar", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "color", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "configurable_options", + "description": "An array of options for the configurable product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ConfigurableProductOptions", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "configurable_product_options_selection", + "description": "An array of media gallery items and other details about selected configurable product options as well as details about remaining selectable options.", + "args": [ + { + "name": "configurableOptionValueUids", + "description": "", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ConfigurableProductOptionsSelection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country_of_manufacture", + "description": "The product's country of origin.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "Timestamp indicating when the product was created.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "crosssell_products", + "description": "An array of cross-sell products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_attributesV2", + "description": "Product custom attributes.", + "args": [ + { + "name": "filters", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductCustomAttributes", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "eco_collection", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "erin_recommends", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "features_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "format", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "gender", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "gift_message_available", + "description": "Returns a value indicating gift message availability for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_available", + "description": "Returns a value indicating gift wrapping availability for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_price", + "description": "Returns value and currency indicating gift wrapping price for the product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID number assigned to the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `uid` field instead." + }, + { + "name": "image", + "description": "The relative path to the main image on the product page.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_returnable", + "description": "Indicates whether the product can be returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "material", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "max_sale_qty", + "description": "Maximum Qty Allowed in Shopping Cart", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media_gallery", + "description": "An array of media gallery objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "MediaGalleryInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media_gallery_entries", + "description": "An array of MediaGalleryEntry objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaGalleryEntry", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `media_gallery` instead." + }, + { + "name": "meta_description", + "description": "A brief overview of the product for search results listings, maximum 255 characters.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_keyword", + "description": "A comma-separated list of keywords that are visible only to search engines.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_title", + "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "min_sale_qty", + "description": "Minimum Qty Allowed in Shopping Cart", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The product name. Customers use this name to identify the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "new", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "new_from_date", + "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "new_to_date", + "description": "The end date for new product listings.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "only_x_left_in_stock", + "description": "Product stock only x left count", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "An array of options for a customizable product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options_container", + "description": "If the product has multiple options, determines where they appear on the product page.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pattern", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "performance_fabric", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "price", + "description": "Indicates the price of an item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductPrices", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `price_range` for product price information." + }, + { + "name": "price_range", + "description": "The range of prices for the product", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRange", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_tiers", + "description": "An array of `TierPrice` objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TierPrice", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_links", + "description": "An array of `ProductLinks` objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductLinksInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "purpose", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "quantity", + "description": "Amount of available stock", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "related_products", + "description": "An array of related products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "review_count", + "description": "The total count of all the reviews given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reviews", + "description": "The list of products reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sale", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "short_description", + "description": "A short description of the product. Its use depends on the theme.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "size", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "sku", + "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sleeve", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "small_image", + "description": "The relative path to the small image, which is used on catalog pages.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "special_from_date", + "description": "The beginning date that a product has a special price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "special_price", + "description": "The discounted price of the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "special_to_date", + "description": "The end date for a product with a special price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staged", + "description": "Indicates whether the product is staged for a future campaign.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stock_status", + "description": "Stock status of the product", + "args": [], + "type": { + "kind": "ENUM", + "name": "ProductStockStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "strap_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_bottom", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_general", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "swatch_image", + "description": "The file name of a swatch image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "thumbnail", + "description": "The relative path to the product's thumbnail image.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tier_price", + "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." + }, + { + "name": "tier_prices", + "description": "An array of ProductTierPrices objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductTierPrices", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." + }, + { + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type_id", + "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `__typename` instead." + }, + { + "name": "uid", + "description": "The unique ID for a `ProductInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "Timestamp indicating when the product was updated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "upsell_products", + "description": "An array of up-sell products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_key", + "description": "The part of the URL that identifies the product", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_path", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use product's `canonical_url` or url rewrites instead" + }, + { + "name": "url_rewrites", + "description": "URL rewrites list", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRewrite", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_suffix", + "description": "The part of the product URL that is appended after the url key", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variants", + "description": "An array of simple product variants.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ConfigurableVariant", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "websites", + "description": "An array of websites in which the product is available.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Website", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "weight", + "description": "The weight of the item, in units defined by the store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "RoutableInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "PhysicalProductInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "CustomizableProductInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableVariant", + "description": "Contains all the simple product variants of a configurable product.", + "fields": [ + { + "name": "attributes", + "description": "An array of configurable attribute options.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ConfigurableAttributeOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "An array of linked simple products.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SimpleProduct", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableAttributeOption", + "description": "Contains details about a configurable product attribute option.", + "fields": [ + { + "name": "code", + "description": "The ID assigned to the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "A string that describes the configurable attribute option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `ConfigurableAttributeOption` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value_index", + "description": "A unique index number assigned to the configurable product option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableProductOptions", + "description": "Defines configurable attributes for the specified product.", + "fields": [ + { + "name": "attribute_code", + "description": "A string that identifies the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attribute_id", + "description": "The ID assigned to the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `attribute_uid` instead." + }, + { + "name": "attribute_id_v2", + "description": "The ID assigned to the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `attribute_uid` instead." + }, + { + "name": "attribute_uid", + "description": "The unique ID for an `Attribute` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The configurable option ID number assigned by the system.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." + }, + { + "name": "label", + "description": "A displayed string that describes the configurable product option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "A number that indicates the order in which the attribute is displayed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_id", + "description": "This is the same as a product's `id` field.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "`product_id` is not needed and can be obtained from its parent." + }, + { + "name": "uid", + "description": "The unique ID for a `ConfigurableProductOptions` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "use_default", + "description": "Indicates whether the option is the default.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "values", + "description": "An array that defines the `value_index` codes assigned to the configurable product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ConfigurableProductOptionsValues", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableProductOptionsValues", + "description": "Contains the index number assigned to a configurable product option.", + "fields": [ + { + "name": "default_label", + "description": "The label of the product on the default store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The label of the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "store_label", + "description": "The label of the product on the current store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "swatch_data", + "description": "Swatch data for a configurable product option.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "SwatchDataInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `ConfigurableProductOptionsValues` object.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "use_default_value", + "description": "Indicates whether to use the default_label.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value_index", + "description": "A unique index number assigned to the configurable product option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AddConfigurableProductsToCartInput", + "description": "Defines the configurable products to add to the cart.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The ID of the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "cart_items", + "description": "An array of configurable products to add.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ConfigurableProductCartItemInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AddConfigurableProductsToCartOutput", + "description": "Contains details about the cart after adding configurable products.", + "fields": [ + { + "name": "cart", + "description": "The cart after adding products.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ConfigurableProductCartItemInput", + "description": "", + "fields": null, + "inputFields": [ + { + "name": "customizable_options", + "description": "The ID and value of the option.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomizableOptionInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "data", + "description": "The quantity and SKU of the configurable product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartItemInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "parent_sku", + "description": "The SKU of the parent configurable product.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "variant_sku", + "description": "", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableCartItem", + "description": "An implementation for configurable product cart items.", + "fields": [ + { + "name": "available_gift_wrapping", + "description": "The list of available gift wrapping options for the cart item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftWrapping", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "configurable_options", + "description": "An array containing the configuranle options the shopper selected.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedConfigurableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "configured_variant", + "description": "Product details of the cart item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizable_options", + "description": "An array containing the customizable options the shopper selected.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discount", + "description": "Contains discount for quote line item.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errors", + "description": "An array of errors encountered while loading the cart item", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartItemError", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_message", + "description": "The entered gift message for the cart item", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftMessage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping", + "description": "The selected gift wrapping for the cart item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftWrapping", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." + }, + { + "name": "is_available", + "description": "True if requested quantity is less than available stock, false otherwise.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "max_qty", + "description": "Line item max qty in quote template", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "min_qty", + "description": "Line item min qty in quote template", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "not_available_message", + "description": "Message to display when the product is not available with this selected option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note_from_buyer", + "description": "The buyer's quote line item note.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemNote", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note_from_seller", + "description": "The seller's quote line item note.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemNote", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CartItemPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Details about an item in the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of this item in the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CartItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CartItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SelectedConfigurableOption", + "description": "Contains details about a selected configurable option.", + "fields": [ + { + "name": "configurable_product_option_uid", + "description": "The unique ID for a `ConfigurableProductOptions` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "configurable_product_option_value_uid", + "description": "The unique ID for a `ConfigurableProductOptionsValues` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `SelectedConfigurableOption.configurable_product_option_uid` instead." + }, + { + "name": "option_label", + "description": "The display text for the option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value_id", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `SelectedConfigurableOption.configurable_product_option_value_uid` instead." + }, + { + "name": "value_label", + "description": "The display name of the selected configurable option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableWishlistItem", + "description": "A configurable product wish list item.", + "fields": [ + { + "name": "added_at", + "description": "The date and time the item was added to the wish list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "child_sku", + "description": "The SKU of the simple product corresponding to a set of selected configurable options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `ConfigurableWishlistItem.configured_variant.sku` instead." + }, + { + "name": "configurable_options", + "description": "An array of selected configurable options.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedConfigurableOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "configured_variant", + "description": "Product details of the selected variant. The value is null if some options are not configured.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizable_options", + "description": "Custom options selected for the wish list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `WishlistItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Product details of the wish list item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of this wish list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "WishlistItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableProductOptionsSelection", + "description": "Contains metadata corresponding to the selected configurable options.", + "fields": [ + { + "name": "configurable_options", + "description": "An array of all possible configurable options.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ConfigurableProductOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media_gallery", + "description": "Product images and videos corresponding to the specified configurable options selection.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "MediaGalleryInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options_available_for_selection", + "description": "The configurable options available for further selection based on the current selection.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ConfigurableOptionAvailableForSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variant", + "description": "A variant represented by the specified configurable options selection. The value is expected to be null until selections are made for each configurable option.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SimpleProduct", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableOptionAvailableForSelection", + "description": "Describes configurable options that have been selected and can be selected as a result of the previous selections.", + "fields": [ + { + "name": "attribute_code", + "description": "An attribute code that uniquely identifies a configurable option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "option_value_uids", + "description": "An array of selectable option value IDs.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableProductOption", + "description": "Contains details about configurable product options.", + "fields": [ + { + "name": "attribute_code", + "description": "An attribute code that uniquely identifies a configurable option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The display name of the option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID of the configurable option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "values", + "description": "An array of values that are applicable for this option.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ConfigurableProductOptionValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableProductOptionValue", + "description": "Defines a value for a configurable product option.", + "fields": [ + { + "name": "is_available", + "description": "Indicates whether the product is available with this selected option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_use_default", + "description": "Indicates whether the value is the default.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The display name of the value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "swatch", + "description": "The URL assigned to the thumbnail of the swatch image.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "SwatchDataInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID of the value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableOrderItem", + "description": "", + "fields": [ + { + "name": "discounts", + "description": "The final discount information for the product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "eligible_for_return", + "description": "Indicates whether the order item is eligible to be in a return request.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "entered_options", + "description": "The entered option for the base product, such as a logo or image.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderItemOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_message", + "description": "The selected gift message for the order item", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftMessage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping", + "description": "The selected gift wrapping for the order item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftWrapping", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for an `OrderItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parent_sku", + "description": "The SKU of parent product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderItemPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "The ProductInterface object, which contains details about the base product", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price of the base product, including selected options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_type", + "description": "The type of product, such as simple, configurable, etc.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_url_key", + "description": "URL key of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_canceled", + "description": "The number of canceled items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_invoiced", + "description": "The number of invoiced items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_ordered", + "description": "The number of units ordered for this item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_refunded", + "description": "The number of refunded items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_return_requested", + "description": "The requested return quantity of the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_returned", + "description": "The number of returned items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_shipped", + "description": "The number of shipped items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "selected_options", + "description": "The selected options for the base product, such as color or size.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderItemOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the order item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RequisitionLists", + "description": "Defines customer requisition lists.", + "fields": [ + { + "name": "items", + "description": "An array of requisition lists.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "RequisitionList", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Pagination metadata.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The number of returned requisition lists.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RequisitionList", + "description": "Defines the contents of a requisition list.", + "fields": [ + { + "name": "description", + "description": "Optional text that describes the requisition list.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "An array of products added to the requisition list.", + "args": [ + { + "name": "currentPage", + "description": "The page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "pageSize", + "description": "The maximum number of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + } + ], + "type": { + "kind": "OBJECT", + "name": "RequistionListItems", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items_count", + "description": "The number of items in the list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The requisition list name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique requisition list ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "The time of the last modification of the requisition list.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RequistionListItems", + "description": "Contains an array of items added to a requisition list.", + "fields": [ + { + "name": "items", + "description": "An array of items in the requisition list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "RequisitionListItemInterface", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Pagination metadata.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_pages", + "description": "The number of pages returned.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "RequisitionListItemInterface", + "description": "The interface for requisition list items.", + "fields": [ + { + "name": "customizable_options", + "description": "Selected custom options for an item in the requisition list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Details about a requisition list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The amount added.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for the requisition list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SimpleRequisitionListItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VirtualRequisitionListItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DownloadableRequisitionListItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BundleRequisitionListItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableRequisitionListItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardRequisitionListItem", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "SimpleRequisitionListItem", + "description": "Contains details about simple products added to a requisition list.", + "fields": [ + { + "name": "customizable_options", + "description": "Selected custom options for an item in the requisition list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Details about a requisition list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The amount added.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for the requisition list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "RequisitionListItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VirtualRequisitionListItem", + "description": "Contains details about virtual products added to a requisition list.", + "fields": [ + { + "name": "customizable_options", + "description": "Selected custom options for an item in the requisition list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Details about a requisition list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The amount added.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for the requisition list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "RequisitionListItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CreateRequisitionListInput", + "description": "An input object that identifies and describes a new requisition list.", + "fields": null, + "inputFields": [ + { + "name": "description", + "description": "An optional description of the requisition list.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The name assigned to the requisition list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "UpdateRequisitionListInput", + "description": "An input object that defines which requistion list characteristics to update.", + "fields": null, + "inputFields": [ + { + "name": "description", + "description": "The updated description of the requisition list.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The new name of the requisition list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateRequisitionListOutput", + "description": "Output of the request to rename the requisition list.", + "fields": [ + { + "name": "requisition_list", + "description": "The renamed requisition list.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RequisitionList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "UpdateRequisitionListItemsInput", + "description": "Defines which items in a requisition list to update.", + "fields": null, + "inputFields": [ + { + "name": "entered_options", + "description": "An array of customer-entered options.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "EnteredOptionInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "item_id", + "description": "The ID of the requisition list item to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The new quantity of the item.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "selected_options", + "description": "An array of selected option IDs.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateRequisitionListItemsOutput", + "description": "Output of the request to update items in the specified requisition list.", + "fields": [ + { + "name": "requisition_list", + "description": "The requisition list after updating items.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RequisitionList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeleteRequisitionListOutput", + "description": "Indicates whether the request to delete the requisition list was successful.", + "fields": [ + { + "name": "requisition_lists", + "description": "The customer's requisition lists after deleting a requisition list.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RequisitionLists", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "Indicates whether the request to delete the requisition list was successful.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AddProductsToRequisitionListOutput", + "description": "Output of the request to add products to a requisition list.", + "fields": [ + { + "name": "requisition_list", + "description": "The requisition list after adding products.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RequisitionList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeleteRequisitionListItemsOutput", + "description": "Output of the request to remove items from the requisition list.", + "fields": [ + { + "name": "requisition_list", + "description": "The requisition list after removing items.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RequisitionList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AddRequisitionListItemsToCartOutput", + "description": "Output of the request to add items in a requisition list to the cart.", + "fields": [ + { + "name": "add_requisition_list_items_to_cart_user_errors", + "description": "Details about why the attempt to add items to the requistion list was not successful.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AddRequisitionListItemToCartUserError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cart", + "description": "The cart after adding requisition list items.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "Indicates whether the attempt to add items to the requisition list was successful.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AddRequisitionListItemToCartUserError", + "description": "Contains details about why an attempt to add items to the requistion list failed.", + "fields": [ + { + "name": "message", + "description": "A description of the error.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of error that occurred.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AddRequisitionListItemToCartUserErrorType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AddRequisitionListItemToCartUserErrorType", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "OUT_OF_STOCK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNAVAILABLE_SKU", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OPTIONS_UPDATED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOW_QUANTITY", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CopyItemsBetweenRequisitionListsInput", + "description": "An input object that defines the items in a requisition list to be copied.", + "fields": null, + "inputFields": [ + { + "name": "requisitionListItemUids", + "description": "An array of IDs representing products copied from one requisition list to another.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CopyItemsFromRequisitionListsOutput", + "description": "Output of the request to copy items to the destination requisition list.", + "fields": [ + { + "name": "requisition_list", + "description": "The destination requisition list after the items were copied.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RequisitionList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MoveItemsBetweenRequisitionListsInput", + "description": "An input object that defines the items in a requisition list to be moved.", + "fields": null, + "inputFields": [ + { + "name": "requisitionListItemUids", + "description": "An array of IDs representing products moved from one requisition list to another.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MoveItemsBetweenRequisitionListsOutput", + "description": "Output of the request to move items to another requisition list.", + "fields": [ + { + "name": "destination_requisition_list", + "description": "The destination requisition list after moving items.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RequisitionList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "source_requisition_list", + "description": "The source requisition list after moving items.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RequisitionList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RequisitionListFilterInput", + "description": "Defines requisition list filters.", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "Filter by the display name of the requisition list.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterMatchTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "uids", + "description": "Filter requisition lists by one or more requisition list IDs.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateRequisitionListOutput", + "description": "Output of the request to create a requisition list.", + "fields": [ + { + "name": "requisition_list", + "description": "The created requisition list.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RequisitionList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ClearCustomerCartOutput", + "description": "Output of the request to clear the customer cart.", + "fields": [ + { + "name": "cart", + "description": "The cart after clearing items.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "Indicates whether cart was cleared.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RequisitionListItemsInput", + "description": "Defines the items to add.", + "fields": null, + "inputFields": [ + { + "name": "entered_options", + "description": "Entered option IDs.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "EnteredOptionInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "parent_sku", + "description": "For configurable products, the SKU of the parent product.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The quantity of the product to add.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "selected_options", + "description": "Selected option IDs.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sku", + "description": "The product SKU.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ContactUsInput", + "description": "", + "fields": null, + "inputFields": [ + { + "name": "comment", + "description": "The shopper's comment to the merchant.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "The email address of the shopper.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The full name of the shopper.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "telephone", + "description": "The shopper's telephone number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ContactUsOutput", + "description": "Contains the status of the request.", + "fields": [ + { + "name": "status", + "description": "Indicates whether the request was successful.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ApplyStoreCreditToCartInput", + "description": "Defines the input required to run the `applyStoreCreditToCart` mutation.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID that identifies the customer's cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ApplyStoreCreditToCartOutput", + "description": "Defines the possible output for the `applyStoreCreditToCart` mutation.", + "fields": [ + { + "name": "cart", + "description": "The contents of the specified shopping cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RemoveStoreCreditFromCartInput", + "description": "Defines the input required to run the `removeStoreCreditFromCart` mutation.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID that identifies the customer's cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RemoveStoreCreditFromCartOutput", + "description": "Defines the possible output for the `removeStoreCreditFromCart` mutation.", + "fields": [ + { + "name": "cart", + "description": "The contents of the specified shopping cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppliedStoreCredit", + "description": "Contains the applied and current balances.", + "fields": [ + { + "name": "applied_balance", + "description": "The applied store credit balance to the current cart.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "current_balance", + "description": "The current balance remaining on store credit.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "enabled", + "description": "Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerStoreCredit", + "description": "Contains store credit information with balance and history.", + "fields": [ + { + "name": "balance_history", + "description": "Contains the customer's store credit balance history. If the history or store credit feature is disabled, then a null value will be returned.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. This value is optional. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerStoreCreditHistory", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "current_balance", + "description": "The current balance of store credit.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "enabled", + "description": "Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerStoreCreditHistory", + "description": "Lists changes to the amount of store credit available to the customer.", + "fields": [ + { + "name": "items", + "description": "An array containing information about changes to the store credit available to the customer.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerStoreCreditHistoryItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Metadata for pagination rendering.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The number of items returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerStoreCreditHistoryItem", + "description": "Contains store credit history information.", + "fields": [ + { + "name": "action", + "description": "The action that was made on the store credit.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "actual_balance", + "description": "The store credit available to the customer as a result of this action. ", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "balance_change", + "description": "The amount added to or subtracted from the store credit as a result of this action.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "date_time_changed", + "description": "The date and time when the store credit change was made.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderTotal", + "description": "Contains details about the sales total amounts used to calculate the final price.", + "fields": [ + { + "name": "base_grand_total", + "description": "The final base grand total amount in the base currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discounts", + "description": "The applied discounts to the order.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_options", + "description": null, + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftOptionsPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "grand_total", + "description": "The final total amount, including shipping, discounts, and taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "grand_total_excl_tax", + "description": "The grand total of the order, excluding taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shipping_handling", + "description": "Details about the shipping and handling costs for the order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShippingHandling", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotal", + "description": "The subtotal of the order, excluding shipping, discounts, and taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use subtotal_excl_tax field instead" + }, + { + "name": "subtotal_excl_tax", + "description": "The subtotal of the order, excluding taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotal_incl_tax", + "description": "The subtotal of the order, including taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxes", + "description": "The order tax details.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_giftcard", + "description": "The gift card balance applied to the order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_reward_points", + "description": "The total reward points applied to the order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_shipping", + "description": "The shipping amount for the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_store_credit", + "description": "The total store credit applied to the order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_tax", + "description": "The amount of tax applied to the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderAddress", + "description": "Contains detailed information about an order's billing and shipping addresses.", + "fields": [ + { + "name": "city", + "description": "The city or town.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company", + "description": "The customer's company.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country_code", + "description": "The customer's country.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CountryCodeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_attributesV2", + "description": "Custom attributes assigned to the customer address.", + "args": [ + { + "name": "attributeCodes", + "description": "", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fax", + "description": "The fax number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstname", + "description": "The first name of the person associated with the shipping/billing address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastname", + "description": "The family name of the person associated with the shipping/billing address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "middlename", + "description": "The middle name of the person associated with the shipping/billing address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "postcode", + "description": "The customer's ZIP or postal code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "region", + "description": "The state or province name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "region_id", + "description": "The unique ID for a `Region` object of a pre-defined region.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "street", + "description": "An array of strings that define the street number and name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "telephone", + "description": "The telephone number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vat_id", + "description": "The customer's Value-added tax (VAT) number (for corporate customers).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AddDownloadableProductsToCartInput", + "description": "", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The ID of the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "cart_items", + "description": "An array of downloadable products to add.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DownloadableProductCartItemInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DownloadableProductCartItemInput", + "description": "Defines a single downloadable product.", + "fields": null, + "inputFields": [ + { + "name": "customizable_options", + "description": "The ID and value of the option.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomizableOptionInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "data", + "description": "The quantity and SKU of the downloadable product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartItemInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "downloadable_product_links", + "description": "An array of objects containing the link_id of the downloadable product link.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DownloadableProductLinksInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DownloadableProductLinksInput", + "description": "Contains the link ID for the downloadable product.", + "fields": null, + "inputFields": [ + { + "name": "link_id", + "description": "The unique ID of the downloadable product link.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AddDownloadableProductsToCartOutput", + "description": "Contains details about the cart after adding downloadable products.", + "fields": [ + { + "name": "cart", + "description": "The cart after adding products.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DownloadableCartItem", + "description": "An implementation for downloadable product cart items.", + "fields": [ + { + "name": "customizable_options", + "description": "An array containing the customizable options the shopper selected.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discount", + "description": "Contains discount for quote line item.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errors", + "description": "An array of errors encountered while loading the cart item", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartItemError", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." + }, + { + "name": "is_available", + "description": "True if requested quantity is less than available stock, false otherwise.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "links", + "description": "An array containing information about the links for the downloadable product added to the cart.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DownloadableProductLinks", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "max_qty", + "description": "Line item max qty in quote template", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "min_qty", + "description": "Line item min qty in quote template", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "not_available_message", + "description": "Message to display when the product is not available with this selected option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note_from_buyer", + "description": "The buyer's quote line item note.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemNote", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note_from_seller", + "description": "The seller's quote line item note.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemNote", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CartItemPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Details about an item in the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of this item in the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "samples", + "description": "An array containing information about samples of the selected downloadable product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DownloadableProductSamples", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CartItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CartItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DownloadableProduct", + "description": "Defines a product that the shopper downloads.", + "fields": [ + { + "name": "activity", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "attribute_set_id", + "description": "The attribute set assigned to the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "categories", + "description": "The categories assigned to a product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CategoryInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "category_gear", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "climate", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "collar", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "color", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "country_of_manufacture", + "description": "The product's country of origin.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "Timestamp indicating when the product was created.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "crosssell_products", + "description": "An array of cross-sell products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_attributesV2", + "description": "Product custom attributes.", + "args": [ + { + "name": "filters", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductCustomAttributes", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "downloadable_product_links", + "description": "An array containing information about the links for this downloadable product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DownloadableProductLinks", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "downloadable_product_samples", + "description": "An array containing information about samples of this downloadable product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DownloadableProductSamples", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "eco_collection", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "erin_recommends", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "features_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "format", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "gender", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "gift_message_available", + "description": "Returns a value indicating gift message availability for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_available", + "description": "Returns a value indicating gift wrapping availability for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_price", + "description": "Returns value and currency indicating gift wrapping price for the product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID number assigned to the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `uid` field instead." + }, + { + "name": "image", + "description": "The relative path to the main image on the product page.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_returnable", + "description": "Indicates whether the product can be returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "links_purchased_separately", + "description": "A value of 1 indicates that each link in the array must be purchased separately.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "links_title", + "description": "The heading above the list of downloadable products.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "material", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "max_sale_qty", + "description": "Maximum Qty Allowed in Shopping Cart", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media_gallery", + "description": "An array of media gallery objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "MediaGalleryInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media_gallery_entries", + "description": "An array of MediaGalleryEntry objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaGalleryEntry", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `media_gallery` instead." + }, + { + "name": "meta_description", + "description": "A brief overview of the product for search results listings, maximum 255 characters.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_keyword", + "description": "A comma-separated list of keywords that are visible only to search engines.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_title", + "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "min_sale_qty", + "description": "Minimum Qty Allowed in Shopping Cart", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The product name. Customers use this name to identify the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "new", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "new_from_date", + "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "new_to_date", + "description": "The end date for new product listings.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "only_x_left_in_stock", + "description": "Product stock only x left count", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "An array of options for a customizable product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options_container", + "description": "If the product has multiple options, determines where they appear on the product page.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pattern", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "performance_fabric", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "price", + "description": "Indicates the price of an item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductPrices", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `price_range` for product price information." + }, + { + "name": "price_range", + "description": "The range of prices for the product", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRange", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_tiers", + "description": "An array of `TierPrice` objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TierPrice", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_links", + "description": "An array of `ProductLinks` objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductLinksInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "purpose", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "quantity", + "description": "Amount of available stock", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "related_products", + "description": "An array of related products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "review_count", + "description": "The total count of all the reviews given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reviews", + "description": "The list of products reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sale", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "short_description", + "description": "A short description of the product. Its use depends on the theme.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "size", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "sku", + "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sleeve", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "small_image", + "description": "The relative path to the small image, which is used on catalog pages.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "special_from_date", + "description": "The beginning date that a product has a special price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "special_price", + "description": "The discounted price of the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "special_to_date", + "description": "The end date for a product with a special price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staged", + "description": "Indicates whether the product is staged for a future campaign.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stock_status", + "description": "Stock status of the product", + "args": [], + "type": { + "kind": "ENUM", + "name": "ProductStockStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "strap_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_bottom", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_general", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "swatch_image", + "description": "The file name of a swatch image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "thumbnail", + "description": "The relative path to the product's thumbnail image.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tier_price", + "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." + }, + { + "name": "tier_prices", + "description": "An array of ProductTierPrices objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductTierPrices", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." + }, + { + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type_id", + "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `__typename` instead." + }, + { + "name": "uid", + "description": "The unique ID for a `ProductInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "Timestamp indicating when the product was updated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "upsell_products", + "description": "An array of up-sell products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_key", + "description": "The part of the URL that identifies the product", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_path", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use product's `canonical_url` or url rewrites instead" + }, + { + "name": "url_rewrites", + "description": "URL rewrites list", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRewrite", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_suffix", + "description": "The part of the product URL that is appended after the url key", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "websites", + "description": "An array of websites in which the product is available.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Website", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "RoutableInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "CustomizableProductInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DownloadableFileTypeEnum", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FILE", + "description": "", + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" + }, + { + "name": "URL", + "description": "", + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DownloadableProductLinks", + "description": "Defines characteristics of a downloadable product.", + "fields": [ + { + "name": "id", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "This information should not be exposed on frontend." + }, + { + "name": "is_shareable", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "This information should not be exposed on frontend." + }, + { + "name": "link_type", + "description": null, + "args": [], + "type": { + "kind": "ENUM", + "name": "DownloadableFileTypeEnum", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" + }, + { + "name": "number_of_downloads", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "This information should not be exposed on frontend." + }, + { + "name": "price", + "description": "The price of the downloadable product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sample_file", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" + }, + { + "name": "sample_type", + "description": null, + "args": [], + "type": { + "kind": "ENUM", + "name": "DownloadableFileTypeEnum", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" + }, + { + "name": "sample_url", + "description": "The full URL to the downloadable sample.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "A number indicating the sort order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The display name of the link.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `DownloadableProductLinks` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DownloadableProductSamples", + "description": "Defines characteristics of a downloadable product.", + "fields": [ + { + "name": "id", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "This information should not be exposed on frontend." + }, + { + "name": "sample_file", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" + }, + { + "name": "sample_type", + "description": null, + "args": [], + "type": { + "kind": "ENUM", + "name": "DownloadableFileTypeEnum", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "`sample_url` serves to get the downloadable sample" + }, + { + "name": "sample_url", + "description": "The full URL to the downloadable sample.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "A number indicating the sort order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The display name of the sample.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DownloadableOrderItem", + "description": "Defines downloadable product options for `OrderItemInterface`.", + "fields": [ + { + "name": "discounts", + "description": "The final discount information for the product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "downloadable_links", + "description": "A list of downloadable links that are ordered from the downloadable product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DownloadableItemsLinks", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "eligible_for_return", + "description": "Indicates whether the order item is eligible to be in a return request.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "entered_options", + "description": "The entered option for the base product, such as a logo or image.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderItemOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_message", + "description": "The selected gift message for the order item", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftMessage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping", + "description": "The selected gift wrapping for the order item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftWrapping", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for an `OrderItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderItemPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "The ProductInterface object, which contains details about the base product", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price of the base product, including selected options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_type", + "description": "The type of product, such as simple, configurable, etc.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_url_key", + "description": "URL key of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_canceled", + "description": "The number of canceled items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_invoiced", + "description": "The number of invoiced items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_ordered", + "description": "The number of units ordered for this item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_refunded", + "description": "The number of refunded items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_return_requested", + "description": "The requested return quantity of the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_returned", + "description": "The number of returned items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_shipped", + "description": "The number of shipped items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "selected_options", + "description": "The selected options for the base product, such as color or size.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderItemOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the order item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DownloadableInvoiceItem", + "description": "Defines downloadable product options for `InvoiceItemInterface`.", + "fields": [ + { + "name": "discounts", + "description": "Information about the final discount amount for the base product, including discounts on options.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "downloadable_links", + "description": "A list of downloadable links that are invoiced from the downloadable product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DownloadableItemsLinks", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for an `InvoiceItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_item", + "description": "Details about an individual order item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price for the base product including selected options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_invoiced", + "description": "The number of invoiced items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "InvoiceItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DownloadableCreditMemoItem", + "description": "Defines downloadable product options for `CreditMemoItemInterface`.", + "fields": [ + { + "name": "discounts", + "description": "Details about the final discount amount for the base product, including discounts on options.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "downloadable_links", + "description": "A list of downloadable links that are refunded from the downloadable product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DownloadableItemsLinks", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `CreditMemoItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_item", + "description": "The order item the credit memo is applied to.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price for the base product, including selected options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_refunded", + "description": "The number of refunded items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CreditMemoItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DownloadableItemsLinks", + "description": "Defines characteristics of the links for downloadable product.", + "fields": [ + { + "name": "sort_order", + "description": "A number indicating the sort order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The display name of the link.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `DownloadableItemsLinks` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DownloadableWishlistItem", + "description": "A downloadable product wish list item.", + "fields": [ + { + "name": "added_at", + "description": "The date and time the item was added to the wish list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizable_options", + "description": "Custom options selected for the wish list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `WishlistItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "links_v2", + "description": "An array containing information about the selected links.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DownloadableProductLinks", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Product details of the wish list item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of this wish list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "samples", + "description": "An array containing information about the selected samples.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DownloadableProductSamples", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "WishlistItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Company", + "description": "Contains the output schema for a company.", + "fields": [ + { + "name": "acl_resources", + "description": "The list of all resources defined within the company.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyAclResource", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company_admin", + "description": "An object containing information about the company administrator.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "credit", + "description": "Company credit balances and limits.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyCredit", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "credit_history", + "description": "Details about the history of company credit operations.", + "args": [ + { + "name": "filter", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "CompanyCreditHistoryFilterInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pageSize", + "description": "", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyCreditHistory", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "The email address of the company contact.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID of a `Company` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legal_address", + "description": "The address where the company is registered to conduct business.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanyLegalAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legal_name", + "description": "The full legal name of the company.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the company.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_methods", + "description": "The list of payment methods available to a company.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reseller_id", + "description": "The resale number that is assigned to the company for tax reporting purposes.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "role", + "description": "A company role filtered by the unique ID of a `CompanyRole` object.", + "args": [ + { + "name": "id", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyRole", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "roles", + "description": "An object that contains a list of company roles.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default value is 1", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyRoles", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sales_representative", + "description": "An object containing information about the company sales representative.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanySalesRepresentative", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "structure", + "description": "The company structure of teams and customers in depth-first order.", + "args": [ + { + "name": "rootId", + "description": "The ID of the node in the company structure that serves as the root for the query.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "depth", + "description": "The maximum depth that can be reached when listing structure nodes.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "10" + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyStructure", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "team", + "description": "The company team data filtered by the unique ID for a `CompanyTeam` object.", + "args": [ + { + "name": "id", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyTeam", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "user", + "description": "A company user filtered by the unique ID of a `Customer` object.", + "args": [ + { + "name": "id", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "users", + "description": "An object that contains a list of company users based on activity status.", + "args": [ + { + "name": "filter", + "description": "The type of company users to return.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CompanyUsersFilterInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyUsers", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vat_tax_id", + "description": "The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyLegalAddress", + "description": "Contains details about the address where the company is registered to conduct business.", + "fields": [ + { + "name": "city", + "description": "The city where the company is registered to conduct business.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country_code", + "description": "The country code of the company's legal address.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CountryCodeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "postcode", + "description": "The company's postal code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "region", + "description": "An object containing region data for the company.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerAddressRegion", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "street", + "description": "An array of strings that define the company's street address.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "telephone", + "description": "The company's phone number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyAdmin", + "description": "Contains details about the company administrator.", + "fields": [ + { + "name": "email", + "description": "The email address of the company administrator.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstname", + "description": "The company administrator's first name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gender", + "description": "The company administrator's gender (Male - 1, Female - 2, Not Specified - 3).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `CompanyAdmin` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "job_title", + "description": "The job title of the company administrator.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastname", + "description": "The company administrator's last name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanySalesRepresentative", + "description": "Contains details about a company sales representative.", + "fields": [ + { + "name": "email", + "description": "The email address of the company sales representative.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstname", + "description": "The company sales representative's first name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastname", + "description": "The company sales representative's last name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyUsers", + "description": "Contains details about company users.", + "fields": [ + { + "name": "items", + "description": "An array of `CompanyUser` objects that match the specified filter criteria.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Pagination metadata.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The number of objects returned.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyRoles", + "description": "Contains an array of roles.", + "fields": [ + { + "name": "items", + "description": "A list of company roles that match the specified filter criteria.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyRole", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Pagination metadata.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The total number of objects matching the specified filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyRole", + "description": "Contails details about a single role.", + "fields": [ + { + "name": "id", + "description": "The unique ID for a `CompanyRole` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name assigned to the role.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "permissions", + "description": "A list of permission resources defined for a role.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyAclResource", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "users_count", + "description": "The total number of users assigned the specified role.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyAclResource", + "description": "Contains details about the access control list settings of a resource.", + "fields": [ + { + "name": "children", + "description": "An array of sub-resources.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyAclResource", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `CompanyAclResource` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The sort order of an ACL resource.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "text", + "description": "The label assigned to the ACL resource.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "IsCompanyRoleNameAvailableOutput", + "description": "Contains the response of a role name validation query.", + "fields": [ + { + "name": "is_role_name_available", + "description": "Indicates whether the specified company role name is available.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "IsCompanyUserEmailAvailableOutput", + "description": "Contains the response of a company user email validation query.", + "fields": [ + { + "name": "is_email_available", + "description": "Indicates whether the specified email address can be used to create a company user.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "IsCompanyAdminEmailAvailableOutput", + "description": "Contains the response of a company admin email validation query.", + "fields": [ + { + "name": "is_email_available", + "description": "Indicates whether the specified email address can be used to create a company administrator.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "IsCompanyEmailAvailableOutput", + "description": "Contains the response of a company email validation query.", + "fields": [ + { + "name": "is_email_available", + "description": "Indicates whether the specified email address can be used to create a company.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "CompanyStructureEntity", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CompanyTeam", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "CompanyStructure", + "description": "Contains an array of the individual nodes that comprise the company structure.", + "fields": [ + { + "name": "items", + "description": "An array of elements in a company structure.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyStructureItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyTeam", + "description": "Describes a company team.", + "fields": [ + { + "name": "description", + "description": "An optional description of the team.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `CompanyTeam` object.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The display name of the team.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "structure_id", + "description": "ID of the company structure", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyUsersFilterInput", + "description": "Defines the filter for returning a list of company users.", + "fields": null, + "inputFields": [ + { + "name": "status", + "description": "The activity status to filter on.", + "type": { + "kind": "ENUM", + "name": "CompanyUserStatusEnum", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CompanyUserStatusEnum", + "description": "Defines the list of company user status values.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACTIVE", + "description": "Only active users.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INACTIVE", + "description": "Only inactive users.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateCompanyTeamOutput", + "description": "Contains the response to the request to create a company team.", + "fields": [ + { + "name": "team", + "description": "The new company team instance.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyTeam", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateCompanyTeamOutput", + "description": "Contains the response to the request to update a company team.", + "fields": [ + { + "name": "team", + "description": "The updated company team instance.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyTeam", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeleteCompanyTeamOutput", + "description": "Contains the status of the request to delete a company team.", + "fields": [ + { + "name": "success", + "description": "Indicates whether the delete operation succeeded.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyTeamCreateInput", + "description": "Defines the input schema for creating a company team.", + "fields": null, + "inputFields": [ + { + "name": "description", + "description": "An optional description of the team.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The display name of the team.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "target_id", + "description": "The ID of a node within a company's structure. This ID will be the parent of the created team.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyTeamUpdateInput", + "description": "Defines the input schema for updating a company team.", + "fields": null, + "inputFields": [ + { + "name": "description", + "description": "An optional description of the team.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "id", + "description": "The unique ID of the `CompanyTeam` object to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The display name of the team.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateCompanyStructureOutput", + "description": "Contains the response to the request to update the company structure.", + "fields": [ + { + "name": "company", + "description": "The updated company instance.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Company", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyStructureUpdateInput", + "description": "Defines the input schema for updating the company structure.", + "fields": null, + "inputFields": [ + { + "name": "parent_tree_id", + "description": "The ID of a company that will be the new parent.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "tree_id", + "description": "The ID of the company team that is being moved to another parent.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateCompanyOutput", + "description": "Contains the response to the request to create a company.", + "fields": [ + { + "name": "company", + "description": "The new company instance.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Company", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateCompanyOutput", + "description": "Contains the response to the request to update the company.", + "fields": [ + { + "name": "company", + "description": "The updated company instance.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Company", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateCompanyUserOutput", + "description": "Contains the response to the request to create a company user.", + "fields": [ + { + "name": "user", + "description": "The new company user instance.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateCompanyUserOutput", + "description": "Contains the response to the request to update the company user.", + "fields": [ + { + "name": "user", + "description": "The updated company user instance.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeleteCompanyUserOutput", + "description": "Contains the response to the request to delete the company user.", + "fields": [ + { + "name": "success", + "description": "Indicates whether the company user has been deactivated successfully.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateCompanyRoleOutput", + "description": "Contains the response to the request to create a company role.", + "fields": [ + { + "name": "role", + "description": "The new company role instance.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyRole", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateCompanyRoleOutput", + "description": "Contains the response to the request to update the company role.", + "fields": [ + { + "name": "role", + "description": "The updated company role instance.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyRole", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeleteCompanyRoleOutput", + "description": "Contains the response to the request to delete the company role.", + "fields": [ + { + "name": "success", + "description": "SIndicates whether the company role has been deleted successfully.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyCreateInput", + "description": "Defines the input schema for creating a new company.", + "fields": null, + "inputFields": [ + { + "name": "company_admin", + "description": "Defines the company administrator.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyAdminInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "company_email", + "description": "The email address of the company contact.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "company_name", + "description": "The name of the company to create.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "legal_address", + "description": "Defines legal address data of the company.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyLegalAddressCreateInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "legal_name", + "description": "The full legal name of the company.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reseller_id", + "description": "The resale number that is assigned to the company for tax reporting purposes.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "vat_tax_id", + "description": "The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyAdminInput", + "description": "Defines the input schema for creating a company administrator.", + "fields": null, + "inputFields": [ + { + "name": "custom_attributes", + "description": "The company administrator's custom attributes.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeValueInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "The email address of the company administrator.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "firstname", + "description": "The company administrator's first name.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "gender", + "description": "The company administrator's gender (Male - 1, Female - 2, Not Specified - 3).", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "job_title", + "description": "The job title of the company administrator.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lastname", + "description": "The company administrator's last name.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "telephone", + "description": "The phone number of the company administrator.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyLegalAddressCreateInput", + "description": "Defines the input schema for defining a company's legal address.", + "fields": null, + "inputFields": [ + { + "name": "city", + "description": "The city where the company is registered to conduct business.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "country_id", + "description": "The company's country ID. Use the `countries` query to get this value.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCodeEnum", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "postcode", + "description": "The postal code of the company.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "region", + "description": "An object containing the region name and/or region ID where the company is registered to conduct business.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerAddressRegionInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "street", + "description": "An array of strings that define the street address where the company is registered to conduct business.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "telephone", + "description": "The primary phone number of the company.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyUpdateInput", + "description": "Defines the input schema for updating a company.", + "fields": null, + "inputFields": [ + { + "name": "company_email", + "description": "The email address of the company contact.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "company_name", + "description": "The name of the company to update.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "legal_address", + "description": "The legal address data of the company.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CompanyLegalAddressUpdateInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "legal_name", + "description": "The full legal name of the company.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reseller_id", + "description": "The resale number that is assigned to the company for tax reporting purposes.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "vat_tax_id", + "description": "The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyLegalAddressUpdateInput", + "description": "Defines the input schema for updating a company's legal address.", + "fields": null, + "inputFields": [ + { + "name": "city", + "description": "The city where the company is registered to conduct business.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "country_id", + "description": "The unique ID for a `Country` object.", + "type": { + "kind": "ENUM", + "name": "CountryCodeEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "postcode", + "description": "The postal code of the company.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "region", + "description": "An object containing the region name and/or region ID where the company is registered to conduct business.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerAddressRegionInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "street", + "description": "An array of strings that define the street address where the company is registered to conduct business.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "telephone", + "description": "The primary phone number of the company.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyUserCreateInput", + "description": "Defines the input schema for creating a company user.", + "fields": null, + "inputFields": [ + { + "name": "email", + "description": "The company user's email address", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "firstname", + "description": "The company user's first name.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "job_title", + "description": "The company user's job title or function.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lastname", + "description": "The company user's last name.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "role_id", + "description": "The unique ID for a `CompanyRole` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "status", + "description": "Indicates whether the company user is ACTIVE or INACTIVE.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CompanyUserStatusEnum", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "target_id", + "description": "The ID of a node within a company's structure. This ID will be the parent of the created company user.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "telephone", + "description": "The company user's phone number.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyUserUpdateInput", + "description": "Defines the input schema for updating a company user.", + "fields": null, + "inputFields": [ + { + "name": "email", + "description": "The company user's email address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "firstname", + "description": "The company user's first name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "id", + "description": "The unique ID of a `Customer` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "job_title", + "description": "The company user's job title or function.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lastname", + "description": "The company user's last name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "role_id", + "description": "The unique ID for a `CompanyRole` object.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "status", + "description": "Indicates whether the company user is ACTIVE or INACTIVE.", + "type": { + "kind": "ENUM", + "name": "CompanyUserStatusEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "telephone", + "description": "The company user's phone number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyRoleCreateInput", + "description": "Defines the input schema for creating a company role.", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "The name of the role to create.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "permissions", + "description": "A list of resources the role can access.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyRoleUpdateInput", + "description": "Defines the input schema for updating a company role.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The unique ID for a `CompanyRole` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The name of the role to update.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "permissions", + "description": "A list of resources the role can access.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "UserCompaniesInput", + "description": "Defines the input for returning matching companies the customer is assigned to.", + "fields": null, + "inputFields": [ + { + "name": "currentPage", + "description": "Specifies which page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pageSize", + "description": "Specifies the maximum number of results to return at once. This attribute is optional.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sort", + "description": "Defines the sorting of the results.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompaniesSortInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UserCompaniesOutput", + "description": "An object that contains a list of companies customer is assigned to.", + "fields": [ + { + "name": "items", + "description": "An array of companies customer is assigned to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyBasicInfo", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Provides navigation for the query response.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompaniesSortInput", + "description": "Specifies which field to sort on, and whether to return the results in ascending or descending order.", + "fields": null, + "inputFields": [ + { + "name": "field", + "description": "The field for sorting the results.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CompaniesSortFieldEnum", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "order", + "description": "Indicates whether to return results in ascending or descending order.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CompaniesSortFieldEnum", + "description": "The fields available for sorting the customer companies.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NAME", + "description": "The name of the company.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyBasicInfo", + "description": "The minimal required information to identify and display the company.", + "fields": [ + { + "name": "id", + "description": "The unique ID of a `Company` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legal_name", + "description": "The full legal name of the company.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the company.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyInvitationInput", + "description": "Defines the input schema for accepting the company invitation.", + "fields": null, + "inputFields": [ + { + "name": "code", + "description": "The invitation code.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "role_id", + "description": "The company role id.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "user", + "description": "Company user attributes in the invitation.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyInvitationUserInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyInvitationUserInput", + "description": "Company user attributes in the invitation.", + "fields": null, + "inputFields": [ + { + "name": "company_id", + "description": "The company unique identifier.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customer_id", + "description": "The customer unique identifier.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "job_title", + "description": "The job title of a company user.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "status", + "description": "Indicates whether the company user is ACTIVE or INACTIVE.", + "type": { + "kind": "ENUM", + "name": "CompanyUserStatusEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "telephone", + "description": "The phone number of the company user.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyInvitationOutput", + "description": "The result of accepting the company invitation.", + "fields": [ + { + "name": "success", + "description": "Indicates whether the customer was added to the company successfully.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyStructureItem", + "description": "Defines an individual node in the company structure.", + "fields": [ + { + "name": "entity", + "description": "A union of `CompanyTeam` and `Customer` objects.", + "args": [], + "type": { + "kind": "UNION", + "name": "CompanyStructureEntity", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `CompanyStructureItem` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parent_id", + "description": "The ID of the parent item in the company hierarchy.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerSegmentStorefront", + "description": "Customer segment details", + "fields": [ + { + "name": "uid", + "description": "The unique ID for a `CustomerSegment` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AddBundleProductsToCartInput", + "description": "Defines the bundle products to add to the cart.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The ID of the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "cart_items", + "description": "An array of bundle products to add.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "BundleProductCartItemInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "BundleProductCartItemInput", + "description": "Defines a single bundle product.", + "fields": null, + "inputFields": [ + { + "name": "bundle_options", + "description": "A mandatory array of options for the bundle product, including each chosen option and specified quantity.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "BundleOptionInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "customizable_options", + "description": "The ID and value of the option.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomizableOptionInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "data", + "description": "The quantity and SKU of the bundle product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartItemInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "BundleOptionInput", + "description": "Defines the input for a bundle option.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the option.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The number of the selected item to add to the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "An array with the chosen value of the option.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AddBundleProductsToCartOutput", + "description": "Contains details about the cart after adding bundle products.", + "fields": [ + { + "name": "cart", + "description": "The cart after adding products.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BundleCartItem", + "description": "An implementation for bundle product cart items.", + "fields": [ + { + "name": "available_gift_wrapping", + "description": "The list of available gift wrapping options for the cart item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftWrapping", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "bundle_options", + "description": "An array containing the bundle options the shopper selected.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedBundleOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizable_options", + "description": "An array containing the customizable options the shopper selected.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discount", + "description": "Contains discount for quote line item.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errors", + "description": "An array of errors encountered while loading the cart item", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartItemError", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_message", + "description": "The entered gift message for the cart item", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftMessage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping", + "description": "The selected gift wrapping for the cart item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftWrapping", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." + }, + { + "name": "is_available", + "description": "True if requested quantity is less than available stock, false otherwise.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "max_qty", + "description": "Line item max qty in quote template", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "min_qty", + "description": "Line item min qty in quote template", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "not_available_message", + "description": "Message to display when the product is not available with this selected option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note_from_buyer", + "description": "The buyer's quote line item note.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemNote", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note_from_seller", + "description": "The seller's quote line item note.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemNote", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CartItemPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Details about an item in the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of this item in the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CartItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CartItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SelectedBundleOption", + "description": "Contains details about a selected bundle option.", + "fields": [ + { + "name": "id", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" + }, + { + "name": "label", + "description": "The display name of the selected bundle product option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of selected bundle product option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `SelectedBundleOption` object", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "values", + "description": "An array of selected bundle option values.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedBundleOptionValue", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SelectedBundleOptionValue", + "description": "Contains details about a value for a selected bundle option.", + "fields": [ + { + "name": "id", + "description": "Use `uid` instead", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The display name of the value for the selected bundle product option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "original_price", + "description": "The original price of the value for the selected bundle product option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price of the value for the selected bundle product option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use priceV2 instead." + }, + { + "name": "priceV2", + "description": "The price of the value for the selected bundle product option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of the value for the selected bundle product option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `SelectedBundleOptionValue` object", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceDetails", + "description": "Can be used to retrieve the main price details in case of bundle product", + "fields": [ + { + "name": "discount_percentage", + "description": "The percentage of discount applied to the main product price", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "main_final_price", + "description": "The final price after applying the discount to the main product", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "main_price", + "description": "The regular price of the main product", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BundleItem", + "description": "Defines an individual item within a bundle product.", + "fields": [ + { + "name": "option_id", + "description": "An ID assigned to each type of item in a bundle product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" + }, + { + "name": "options", + "description": "An array of additional options for this bundle item.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BundleItemOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "A number indicating the sequence order of this item compared to the other bundle items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_range", + "description": "The range of prices for the product", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRange", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "required", + "description": "Indicates whether the item must be included in the bundle.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The SKU of the bundle product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The display name of the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The input type that the customer uses to select the item. Examples include radio button and checkbox.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `BundleItem` object.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BundleItemOption", + "description": "Defines the characteristics that comprise a specific bundle item and its options.", + "fields": [ + { + "name": "can_change_quantity", + "description": "Indicates whether the customer can change the number of items for this option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID assigned to the bundled item option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" + }, + { + "name": "is_default", + "description": "Indicates whether this option is the default option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The text that identifies the bundled item option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "When a bundle item contains multiple options, the relative position of this option compared to the other options.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price of the selected option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_type", + "description": "One of FIXED, PERCENT, or DYNAMIC.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PriceTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Contains details about this product option.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "qty", + "description": "Indicates the quantity of this specific bundle item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `quantity` instead." + }, + { + "name": "quantity", + "description": "The quantity of this specific bundle item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `BundleItemOption` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BundleProduct", + "description": "Defines basic features of a bundle product and contains multiple BundleItems.", + "fields": [ + { + "name": "activity", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "attribute_set_id", + "description": "The attribute set assigned to the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "categories", + "description": "The categories assigned to a product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CategoryInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "category_gear", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "climate", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "collar", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "color", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "country_of_manufacture", + "description": "The product's country of origin.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "Timestamp indicating when the product was created.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "crosssell_products", + "description": "An array of cross-sell products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_attributesV2", + "description": "Product custom attributes.", + "args": [ + { + "name": "filters", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductCustomAttributes", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "dynamic_price", + "description": "Indicates whether the bundle product has a dynamic price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "dynamic_sku", + "description": "Indicates whether the bundle product has a dynamic SKU.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "dynamic_weight", + "description": "Indicates whether the bundle product has a dynamically calculated weight.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "eco_collection", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "erin_recommends", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "features_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "format", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "gender", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "gift_message_available", + "description": "Returns a value indicating gift message availability for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_available", + "description": "Returns a value indicating gift wrapping availability for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_price", + "description": "Returns value and currency indicating gift wrapping price for the product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID number assigned to the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `uid` field instead." + }, + { + "name": "image", + "description": "The relative path to the main image on the product page.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_returnable", + "description": "Indicates whether the product can be returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "An array containing information about individual bundle items.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BundleItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "material", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "max_sale_qty", + "description": "Maximum Qty Allowed in Shopping Cart", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media_gallery", + "description": "An array of media gallery objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "MediaGalleryInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media_gallery_entries", + "description": "An array of MediaGalleryEntry objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaGalleryEntry", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `media_gallery` instead." + }, + { + "name": "meta_description", + "description": "A brief overview of the product for search results listings, maximum 255 characters.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_keyword", + "description": "A comma-separated list of keywords that are visible only to search engines.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_title", + "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "min_sale_qty", + "description": "Minimum Qty Allowed in Shopping Cart", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The product name. Customers use this name to identify the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "new", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "new_from_date", + "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "new_to_date", + "description": "The end date for new product listings.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "only_x_left_in_stock", + "description": "Product stock only x left count", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "An array of options for a customizable product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options_container", + "description": "If the product has multiple options, determines where they appear on the product page.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pattern", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "performance_fabric", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "price", + "description": "Indicates the price of an item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductPrices", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `price_range` for product price information." + }, + { + "name": "price_details", + "description": "The price details of the main product", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceDetails", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_range", + "description": "The range of prices for the product", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRange", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_tiers", + "description": "An array of `TierPrice` objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TierPrice", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_view", + "description": "One of PRICE_RANGE or AS_LOW_AS.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PriceViewEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_links", + "description": "An array of `ProductLinks` objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductLinksInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "purpose", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "quantity", + "description": "Amount of available stock", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "related_products", + "description": "An array of related products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "review_count", + "description": "The total count of all the reviews given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reviews", + "description": "The list of products reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sale", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "ship_bundle_items", + "description": "Indicates whether to ship bundle items together or individually.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ShipBundleItemsEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "short_description", + "description": "A short description of the product. Its use depends on the theme.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "size", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "sku", + "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sleeve", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "small_image", + "description": "The relative path to the small image, which is used on catalog pages.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "special_from_date", + "description": "The beginning date that a product has a special price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "special_price", + "description": "The discounted price of the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "special_to_date", + "description": "The end date for a product with a special price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staged", + "description": "Indicates whether the product is staged for a future campaign.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stock_status", + "description": "Stock status of the product", + "args": [], + "type": { + "kind": "ENUM", + "name": "ProductStockStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "strap_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_bottom", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_general", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "swatch_image", + "description": "The file name of a swatch image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "thumbnail", + "description": "The relative path to the product's thumbnail image.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tier_price", + "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." + }, + { + "name": "tier_prices", + "description": "An array of ProductTierPrices objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductTierPrices", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." + }, + { + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type_id", + "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `__typename` instead." + }, + { + "name": "uid", + "description": "The unique ID for a `ProductInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "Timestamp indicating when the product was updated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "upsell_products", + "description": "An array of up-sell products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_key", + "description": "The part of the URL that identifies the product", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_path", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use product's `canonical_url` or url rewrites instead" + }, + { + "name": "url_rewrites", + "description": "URL rewrites list", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRewrite", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_suffix", + "description": "The part of the product URL that is appended after the url key", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "websites", + "description": "An array of websites in which the product is available.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Website", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "weight", + "description": "The weight of the item, in units defined by the store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "RoutableInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "PhysicalProductInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "CustomizableProductInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceViewEnum", + "description": "Defines whether a bundle product's price is displayed as the lowest possible value or as a range.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRICE_RANGE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AS_LOW_AS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ShipBundleItemsEnum", + "description": "Defines whether bundle items must be shipped together.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TOGETHER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SEPARATELY", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BundleOrderItem", + "description": "Defines bundle product options for `OrderItemInterface`.", + "fields": [ + { + "name": "bundle_options", + "description": "A list of bundle options that are assigned to the bundle product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemSelectedBundleOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discounts", + "description": "The final discount information for the product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "eligible_for_return", + "description": "Indicates whether the order item is eligible to be in a return request.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "entered_options", + "description": "The entered option for the base product, such as a logo or image.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderItemOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_message", + "description": "The selected gift message for the order item", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftMessage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping", + "description": "The selected gift wrapping for the order item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftWrapping", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for an `OrderItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parent_sku", + "description": "The SKU of parent product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderItemPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "The ProductInterface object, which contains details about the base product", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price of the base product, including selected options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_type", + "description": "The type of product, such as simple, configurable, etc.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_url_key", + "description": "URL key of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_canceled", + "description": "The number of canceled items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_invoiced", + "description": "The number of invoiced items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_ordered", + "description": "The number of units ordered for this item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_refunded", + "description": "The number of refunded items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_return_requested", + "description": "The requested return quantity of the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_returned", + "description": "The number of returned items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_shipped", + "description": "The number of shipped items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "selected_options", + "description": "The selected options for the base product, such as color or size.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderItemOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the order item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BundleInvoiceItem", + "description": "Defines bundle product options for `InvoiceItemInterface`.", + "fields": [ + { + "name": "bundle_options", + "description": "A list of bundle options that are assigned to an invoiced bundle product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemSelectedBundleOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discounts", + "description": "Information about the final discount amount for the base product, including discounts on options.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for an `InvoiceItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_item", + "description": "Details about an individual order item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price for the base product including selected options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_invoiced", + "description": "The number of invoiced items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "InvoiceItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BundleShipmentItem", + "description": "Defines bundle product options for `ShipmentItemInterface`.", + "fields": [ + { + "name": "bundle_options", + "description": "A list of bundle options that are assigned to a shipped product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemSelectedBundleOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `ShipmentItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_item", + "description": "The order item associated with the shipment item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price for the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_shipped", + "description": "The number of shipped items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ShipmentItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BundleCreditMemoItem", + "description": "Defines bundle product options for `CreditMemoItemInterface`.", + "fields": [ + { + "name": "bundle_options", + "description": "A list of bundle options that are assigned to a bundle product that is part of a credit memo.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemSelectedBundleOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discounts", + "description": "Details about the final discount amount for the base product, including discounts on options.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `CreditMemoItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_item", + "description": "The order item the credit memo is applied to.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price for the base product, including selected options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_refunded", + "description": "The number of refunded items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CreditMemoItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ItemSelectedBundleOption", + "description": "A list of options of the selected bundle product.", + "fields": [ + { + "name": "id", + "description": "The unique ID for a `ItemSelectedBundleOption` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." + }, + { + "name": "label", + "description": "The label of the option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `ItemSelectedBundleOption` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "values", + "description": "A list of products that represent the values of the parent option.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemSelectedBundleOptionValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ItemSelectedBundleOptionValue", + "description": "A list of values for the selected bundle product.", + "fields": [ + { + "name": "id", + "description": "The unique ID for a `ItemSelectedBundleOptionValue` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." + }, + { + "name": "price", + "description": "The price of the child bundle product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the child bundle product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the child bundle product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The number of this bundle product that were ordered.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `ItemSelectedBundleOptionValue` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BundleWishlistItem", + "description": "Defines bundle product options for `WishlistItemInterface`.", + "fields": [ + { + "name": "added_at", + "description": "The date and time the item was added to the wish list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "bundle_options", + "description": "An array containing information about the selected bundle items.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedBundleOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizable_options", + "description": "Custom options selected for the wish list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `WishlistItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Product details of the wish list item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of this wish list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "WishlistItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Currency", + "description": "", + "fields": [ + { + "name": "available_currency_codes", + "description": "An array of three-letter currency codes accepted by the store, such as USD and EUR.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "base_currency_code", + "description": "The base currency set for the store, such as USD.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "base_currency_symbol", + "description": "The symbol for the specified base currency, such as $.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "default_display_currecy_code", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Symbol was missed. Use `default_display_currency_code`." + }, + { + "name": "default_display_currecy_symbol", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Symbol was missed. Use `default_display_currency_code`." + }, + { + "name": "default_display_currency_code", + "description": "The currency that is displayed by default, such as USD.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "default_display_currency_symbol", + "description": "The currency symbol that is displayed by default, such as $.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "exchange_rates", + "description": "An array of exchange rates for currencies defined in the store.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ExchangeRate", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ExchangeRate", + "description": "Lists the exchange rate.", + "fields": [ + { + "name": "currency_to", + "description": "Specifies the store’s default currency to exchange to.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rate", + "description": "The exchange rate for the store’s default currency.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Country", + "description": "", + "fields": [ + { + "name": "available_regions", + "description": "An array of regions within a particular country.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Region", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "full_name_english", + "description": "The name of the country in English.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "full_name_locale", + "description": "The name of the country in the current locale.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `Country` object.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "three_letter_abbreviation", + "description": "The three-letter abbreviation of the country, such as USA.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "two_letter_abbreviation", + "description": "The two-letter abbreviation of the country, such as US.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Region", + "description": "", + "fields": [ + { + "name": "code", + "description": "The two-letter code for the region, such as TX for Texas.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `Region` object.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the region, such as Texas.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerDownloadableProducts", + "description": "Contains a list of downloadable products.", + "fields": [ + { + "name": "items", + "description": "An array of purchased downloadable items.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerDownloadableProduct", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerDownloadableProduct", + "description": "Contains details about a single downloadable product.", + "fields": [ + { + "name": "date", + "description": "The date and time the purchase was made.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "download_url", + "description": "The fully qualified URL to the download file.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_increment_id", + "description": "The unique ID assigned to the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "remaining_downloads", + "description": "The remaining number of times the customer can download the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DownloadableRequisitionListItem", + "description": "Contains details about downloadable products added to a requisition list.", + "fields": [ + { + "name": "customizable_options", + "description": "Selected custom options for an item in the requisition list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "links", + "description": "An array of links for downloadable products in the requisition list.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DownloadableProductLinks", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Details about a requisition list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of the product added to the requisition list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "samples", + "description": "An array of links to downloadable product samples.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DownloadableProductSamples", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID of an item in a requisition list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "RequisitionListItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BundleRequisitionListItem", + "description": "Contains details about bundle products added to a requisition list.", + "fields": [ + { + "name": "bundle_options", + "description": "An array of selected options for a bundle product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedBundleOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizable_options", + "description": "Selected custom options for an item in the requisition list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Details about a requisition list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of the product added to the requisition list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID of an item in a requisition list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "RequisitionListItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ApplyGiftCardToCartInput", + "description": "Defines the input required to run the `applyGiftCardToCart` mutation.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID that identifies the customer's cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "gift_card_code", + "description": "The gift card code to be applied to the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ApplyGiftCardToCartOutput", + "description": "Defines the possible output for the `applyGiftCardToCart` mutation.", + "fields": [ + { + "name": "cart", + "description": "Describes the contents of the specified shopping cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RemoveGiftCardFromCartInput", + "description": "Defines the input required to run the `removeGiftCardFromCart` mutation.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID that identifies the customer's cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "gift_card_code", + "description": "The gift card code to be removed to the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RemoveGiftCardFromCartOutput", + "description": "Defines the possible output for the `removeGiftCardFromCart` mutation.", + "fields": [ + { + "name": "cart", + "description": "The contents of the specified shopping cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppliedGiftCard", + "description": "Contains an applied gift card with applied and remaining balance.", + "fields": [ + { + "name": "applied_balance", + "description": "The amount applied to the current cart.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "The gift card account code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "current_balance", + "description": "The remaining balance on the gift card.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expiration_date", + "description": "The expiration date of the gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "GiftCardAccountInput", + "description": "Contains the gift card code.", + "fields": null, + "inputFields": [ + { + "name": "gift_card_code", + "description": "The applied gift card code.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardAccount", + "description": "Contains details about the gift card account.", + "fields": [ + { + "name": "balance", + "description": "The balance remaining on the gift card.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "The gift card account code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expiration_date", + "description": "The expiration date of the gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerOrder", + "description": "Contains details about each of the customer's orders.", + "fields": [ + { + "name": "applied_coupons", + "description": "Coupons applied to the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppliedCoupon", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "applied_gift_cards", + "description": "An array of gift cards applied to the order.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ApplyGiftCardToOrder", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "available_actions", + "description": "List of available order actions.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "OrderActionType", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "billing_address", + "description": "The billing address for the order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "carrier", + "description": "The shipping carrier for the order delivery.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "comments", + "description": "Comments about the order.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SalesCommentItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `order_date` field instead." + }, + { + "name": "credit_memos", + "description": "A list of credit memos.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CreditMemo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer_info", + "description": "Returns customer information from order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderCustomerInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "Order customer email.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_message", + "description": "The entered gift message for the order", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftMessage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_receipt_included", + "description": "Indicates whether the customer requested a gift receipt for the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping", + "description": "The selected gift wrapping for the order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftWrapping", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "grand_total", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `totals.grand_total` field instead." + }, + { + "name": "id", + "description": "The unique ID for a `CustomerOrder` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "increment_id", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `id` field instead." + }, + { + "name": "invoices", + "description": "A list of invoices for the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Invoice", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_virtual", + "description": "`TRUE` if the order is virtual", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "An array containing the items purchased in this order.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items_eligible_for_return", + "description": "A list of order items eligible to be in a return request.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "number", + "description": "The order number.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_date", + "description": "The date the order was placed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_number", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use the `number` field instead." + }, + { + "name": "order_status_change_date", + "description": "The date the order status was last updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_methods", + "description": "Payment details for the order.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderPaymentMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "printed_card_included", + "description": "Indicates whether the customer requested a printed card for the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returns", + "description": "Return requests associated with this order.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "OBJECT", + "name": "Returns", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shipments", + "description": "A list of shipments for the order.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderShipment", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shipping_address", + "description": "The shipping address for the order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shipping_method", + "description": "The delivery method for the order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The current status of the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "token", + "description": "The token that can be used to retrieve the order using order query.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total", + "description": "Details about the calculated totals for this order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderTotal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ApplyGiftCardToOrder", + "description": "Contains applied gift cards with gift card code and amount.", + "fields": [ + { + "name": "applied_balance", + "description": "The gift card amount applied to the current order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "The gift card account code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftMessage", + "description": "Contains the text of a gift message, its sender, and recipient", + "fields": [ + { + "name": "from", + "description": "Sender name", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "Gift message text", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "to", + "description": "Recipient name", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "GiftMessageInput", + "description": "Defines a gift message.", + "fields": null, + "inputFields": [ + { + "name": "from", + "description": "The name of the sender.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "message", + "description": "The text of the gift message.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "to", + "description": "The name of the recepient.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SalesItemInterface", + "description": "", + "fields": [ + { + "name": "gift_message", + "description": "The entered gift message for the order item", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftMessage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "description": "Order item details.", + "fields": [ + { + "name": "discounts", + "description": "The final discount information for the product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "eligible_for_return", + "description": "Indicates whether the order item is eligible to be in a return request.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "entered_options", + "description": "The entered option for the base product, such as a logo or image.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderItemOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_message", + "description": "The selected gift message for the order item", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftMessage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping", + "description": "The selected gift wrapping for the order item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftWrapping", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for an `OrderItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderItemPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "The ProductInterface object, which contains details about the base product", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price of the base product, including selected options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_type", + "description": "The type of product, such as simple, configurable, etc.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_url_key", + "description": "URL key of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_canceled", + "description": "The number of canceled items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_invoiced", + "description": "The number of invoiced items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_ordered", + "description": "The number of units ordered for this item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_refunded", + "description": "The number of refunded items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_return_requested", + "description": "The requested return quantity of the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_returned", + "description": "The number of returned items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_shipped", + "description": "The number of shipped items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "selected_options", + "description": "The selected options for the base product, such as color or size.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderItemOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the order item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "ConfigurableOrderItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DownloadableOrderItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BundleOrderItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardOrderItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OrderItem", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "WishlistOutput", + "description": "Deprecated: Use the `Wishlist` type instead.", + "fields": [ + { + "name": "items", + "description": "An array of items in the customer's wish list", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "WishlistItem", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use the `Wishlist.items` field instead." + }, + { + "name": "items_count", + "description": "The number of items in the wish list.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `Wishlist.items_count` field instead." + }, + { + "name": "name", + "description": "When multiple wish lists are enabled, the name the customer assigns to the wishlist.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "This field is related to Commerce functionality and is always `null` in Open Source." + }, + { + "name": "sharing_code", + "description": "An encrypted code that links to the wish list.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `Wishlist.sharing_code` field instead." + }, + { + "name": "updated_at", + "description": "The time of the last modification to the wish list.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `Wishlist.updated_at` field instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Wishlist", + "description": "Contains a customer wish list.", + "fields": [ + { + "name": "id", + "description": "The unique ID for a `Wishlist` object.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "WishlistItem", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use the `items_v2` field instead." + }, + { + "name": "items_count", + "description": "The number of items in the wish list.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items_v2", + "description": "An array of items in the customer's wish list.", + "args": [ + { + "name": "currentPage", + "description": "", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "pageSize", + "description": "", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + } + ], + "type": { + "kind": "OBJECT", + "name": "WishlistItems", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the wish list.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sharing_code", + "description": "An encrypted code that Magento uses to link to the wish list.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "The time of the last modification to the wish list.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "visibility", + "description": "Indicates whether the wish list is public or private.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "WishlistVisibilityEnum", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "WishlistItemInterface", + "description": "The interface for wish list items.", + "fields": [ + { + "name": "added_at", + "description": "The date and time the item was added to the wish list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizable_options", + "description": "Custom options selected for the wish list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `WishlistItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Product details of the wish list item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of this wish list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SimpleWishlistItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VirtualWishlistItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableWishlistItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DownloadableWishlistItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BundleWishlistItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardWishlistItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GroupedProductWishlistItem", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "WishlistItems", + "description": "Contains an array of items in a wish list.", + "fields": [ + { + "name": "items", + "description": "A list of items in the wish list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "WishlistItemInterface", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Contains pagination metadata.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "WishlistItem", + "description": "Contains details about a wish list item.", + "fields": [ + { + "name": "added_at", + "description": "The time when the customer added the item to the wish list.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The customer's comment about this item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `WishlistItem` object.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Details about the wish list item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "qty", + "description": "The quantity of this wish list item", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AddWishlistItemsToCartOutput", + "description": "Contains the resultant wish list and any error information.", + "fields": [ + { + "name": "add_wishlist_items_to_cart_user_errors", + "description": "An array of errors encountered while adding products to the customer's cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "WishlistCartUserInputError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "Indicates whether the attempt to add items to the customer's cart was successful.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "wishlist", + "description": "Contains the wish list with all items that were successfully added.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Wishlist", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "WishlistCartUserInputError", + "description": "Contains details about errors encountered when a customer added wish list items to the cart.", + "fields": [ + { + "name": "code", + "description": "An error code that describes the error encountered.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "WishlistCartUserInputErrorType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "A localized error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "wishlistId", + "description": "The unique ID of the `Wishlist` object containing an error.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "wishlistItemId", + "description": "The unique ID of the wish list item containing an error.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "WishlistCartUserInputErrorType", + "description": "A list of possible error types.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRODUCT_NOT_FOUND", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REQUIRED_PARAMETER_MISSING", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_SALABLE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INSUFFICIENT_STOCK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNDEFINED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "WishlistItemInput", + "description": "Defines the items to add to a wish list.", + "fields": null, + "inputFields": [ + { + "name": "entered_options", + "description": "An array of options that the customer entered.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "EnteredOptionInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "parent_sku", + "description": "For complex product types, the SKU of the parent product.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The amount or number of items to add.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "selected_options", + "description": "An array of strings corresponding to options the customer selected.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sku", + "description": "The SKU of the product to add. For complex product types, specify the child product SKU.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AddProductsToWishlistOutput", + "description": "Contains the customer's wish list and any errors encountered.", + "fields": [ + { + "name": "user_errors", + "description": "An array of errors encountered while adding products to a wish list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "WishListUserInputError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "wishlist", + "description": "Contains the wish list with all items that were successfully added.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Wishlist", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RemoveProductsFromWishlistOutput", + "description": "Contains the customer's wish list and any errors encountered.", + "fields": [ + { + "name": "user_errors", + "description": "An array of errors encountered while deleting products from a wish list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "WishListUserInputError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "wishlist", + "description": "Contains the wish list with after items were successfully deleted.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Wishlist", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "WishlistItemUpdateInput", + "description": "Defines updates to items in a wish list.", + "fields": null, + "inputFields": [ + { + "name": "description", + "description": "Customer-entered comments about the item.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "entered_options", + "description": "An array of options that the customer entered.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "EnteredOptionInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The new amount or number of this item.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "selected_options", + "description": "An array of strings corresponding to options the customer selected.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "wishlist_item_id", + "description": "The unique ID for a `WishlistItemInterface` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateProductsInWishlistOutput", + "description": "Contains the customer's wish list and any errors encountered.", + "fields": [ + { + "name": "user_errors", + "description": "An array of errors encountered while updating products in a wish list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "WishListUserInputError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "wishlist", + "description": "Contains the wish list with all items that were successfully updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Wishlist", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "WishListUserInputError", + "description": "An error encountered while performing operations with WishList.", + "fields": [ + { + "name": "code", + "description": "A wish list-specific error code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "WishListUserInputErrorType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "A localized error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "WishListUserInputErrorType", + "description": "A list of possible error types.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRODUCT_NOT_FOUND", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNDEFINED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardProduct", + "description": "Defines properties of a gift card.", + "fields": [ + { + "name": "activity", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "allow_message", + "description": "Indicates whether the customer can provide a message to accompany the gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "allow_open_amount", + "description": "Indicates whether shoppers have the ability to set the value of the gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attribute_set_id", + "description": "The attribute set assigned to the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "categories", + "description": "The categories assigned to a product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CategoryInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "category_gear", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "climate", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "collar", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "color", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "country_of_manufacture", + "description": "The product's country of origin.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "Timestamp indicating when the product was created.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "crosssell_products", + "description": "An array of cross-sell products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_attributesV2", + "description": "Product custom attributes.", + "args": [ + { + "name": "filters", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductCustomAttributes", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "eco_collection", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "erin_recommends", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "features_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "format", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "gender", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "gift_card_options", + "description": "An array of customizable gift card options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_message_available", + "description": "Returns a value indicating gift message availability for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_available", + "description": "Returns a value indicating gift wrapping availability for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_price", + "description": "Returns value and currency indicating gift wrapping price for the product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftcard_amounts", + "description": "An array that contains information about the values and ID of a gift card.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftCardAmounts", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftcard_type", + "description": "An enumeration that specifies the type of gift card.", + "args": [], + "type": { + "kind": "ENUM", + "name": "GiftCardTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID number assigned to the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `uid` field instead." + }, + { + "name": "image", + "description": "The relative path to the main image on the product page.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_redeemable", + "description": "Indicates whether the customer can redeem the value on the card for cash.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_returnable", + "description": "Indicates whether the product can be returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lifetime", + "description": "The number of days after purchase until the gift card expires. A null value means there is no limit.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "material", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "max_sale_qty", + "description": "Maximum Qty Allowed in Shopping Cart", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media_gallery", + "description": "An array of media gallery objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "MediaGalleryInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media_gallery_entries", + "description": "An array of MediaGalleryEntry objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaGalleryEntry", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `media_gallery` instead." + }, + { + "name": "message_max_length", + "description": "The maximum number of characters the gift message can contain.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_description", + "description": "A brief overview of the product for search results listings, maximum 255 characters.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_keyword", + "description": "A comma-separated list of keywords that are visible only to search engines.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_title", + "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "min_sale_qty", + "description": "Minimum Qty Allowed in Shopping Cart", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The product name. Customers use this name to identify the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "new", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "new_from_date", + "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "new_to_date", + "description": "The end date for new product listings.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "only_x_left_in_stock", + "description": "Product stock only x left count", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "open_amount_max", + "description": "The maximum acceptable value of an open amount gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "open_amount_min", + "description": "The minimum acceptable value of an open amount gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "An array of options for a customizable product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CustomizableOptionInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options_container", + "description": "If the product has multiple options, determines where they appear on the product page.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pattern", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "performance_fabric", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "price", + "description": "Indicates the price of an item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductPrices", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `price_range` for product price information." + }, + { + "name": "price_range", + "description": "The range of prices for the product", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRange", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_tiers", + "description": "An array of `TierPrice` objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TierPrice", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_links", + "description": "An array of `ProductLinks` objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductLinksInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "purpose", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "quantity", + "description": "Amount of available stock", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "related_products", + "description": "An array of related products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "review_count", + "description": "The total count of all the reviews given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reviews", + "description": "The list of products reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sale", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "short_description", + "description": "A short description of the product. Its use depends on the theme.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "size", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "sku", + "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sleeve", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "small_image", + "description": "The relative path to the small image, which is used on catalog pages.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "special_from_date", + "description": "The beginning date that a product has a special price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "special_price", + "description": "The discounted price of the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "special_to_date", + "description": "The end date for a product with a special price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staged", + "description": "Indicates whether the product is staged for a future campaign.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stock_status", + "description": "Stock status of the product", + "args": [], + "type": { + "kind": "ENUM", + "name": "ProductStockStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "strap_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_bottom", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_general", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "swatch_image", + "description": "The file name of a swatch image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "thumbnail", + "description": "The relative path to the product's thumbnail image.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tier_price", + "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." + }, + { + "name": "tier_prices", + "description": "An array of ProductTierPrices objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductTierPrices", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." + }, + { + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type_id", + "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `__typename` instead." + }, + { + "name": "uid", + "description": "The unique ID for a `ProductInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "Timestamp indicating when the product was updated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "upsell_products", + "description": "An array of up-sell products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_key", + "description": "The part of the URL that identifies the product", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_path", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use product's `canonical_url` or url rewrites instead" + }, + { + "name": "url_rewrites", + "description": "URL rewrites list", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRewrite", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_suffix", + "description": "The part of the product URL that is appended after the url key", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "websites", + "description": "An array of websites in which the product is available.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Website", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "weight", + "description": "The weight of the item, in units defined by the store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "PhysicalProductInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "CustomizableProductInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "RoutableInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardAmounts", + "description": "Contains the value of a gift card, the website that generated the card, and related information.", + "fields": [ + { + "name": "attribute_id", + "description": "An internal attribute ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `GiftCardAmounts` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value_id", + "description": "An ID that is assigned to each unique gift card amount.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" + }, + { + "name": "website_id", + "description": "The ID of the website that generated the gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "website_value", + "description": "The value of the gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "GiftCardTypeEnum", + "description": "Specifies the gift card type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "VIRTUAL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PHYSICAL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMBINED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardOrderItem", + "description": "", + "fields": [ + { + "name": "discounts", + "description": "The final discount information for the product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "eligible_for_return", + "description": "Indicates whether the order item is eligible to be in a return request.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "entered_options", + "description": "The entered option for the base product, such as a logo or image.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderItemOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_card", + "description": "Selected gift card properties for an order item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftCardItem", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_message", + "description": "The selected gift message for the order item", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftMessage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping", + "description": "The selected gift wrapping for the order item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftWrapping", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for an `OrderItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderItemPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "The ProductInterface object, which contains details about the base product", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price of the base product, including selected options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_type", + "description": "The type of product, such as simple, configurable, etc.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_url_key", + "description": "URL key of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_canceled", + "description": "The number of canceled items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_invoiced", + "description": "The number of invoiced items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_ordered", + "description": "The number of units ordered for this item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_refunded", + "description": "The number of refunded items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_return_requested", + "description": "The requested return quantity of the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_returned", + "description": "The number of returned items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_shipped", + "description": "The number of shipped items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "selected_options", + "description": "The selected options for the base product, such as color or size.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderItemOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the order item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardInvoiceItem", + "description": "", + "fields": [ + { + "name": "discounts", + "description": "Information about the final discount amount for the base product, including discounts on options.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_card", + "description": "Selected gift card properties for an invoice item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftCardItem", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for an `InvoiceItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_item", + "description": "Details about an individual order item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price for the base product including selected options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_invoiced", + "description": "The number of invoiced items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "InvoiceItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardCreditMemoItem", + "description": "", + "fields": [ + { + "name": "discounts", + "description": "Details about the final discount amount for the base product, including discounts on options.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_card", + "description": "Selected gift card properties for a credit memo item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftCardItem", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `CreditMemoItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_item", + "description": "The order item the credit memo is applied to.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price for the base product, including selected options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_refunded", + "description": "The number of refunded items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CreditMemoItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardShipmentItem", + "description": "", + "fields": [ + { + "name": "gift_card", + "description": "Selected gift card properties for a shipment item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftCardItem", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `ShipmentItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_item", + "description": "The order item associated with the shipment item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price for the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_shipped", + "description": "The number of shipped items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ShipmentItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardItem", + "description": "Contains details about a gift card.", + "fields": [ + { + "name": "message", + "description": "The message from the sender to the recipient.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "recipient_email", + "description": "The email address of the receiver of a virtual gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "recipient_name", + "description": "The name of the receiver of a physical or virtual gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sender_email", + "description": "The email address of the sender of a virtual gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sender_name", + "description": "The name of the sender of a physical or virtual gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardCartItem", + "description": "Contains details about a gift card that has been added to a cart.", + "fields": [ + { + "name": "amount", + "description": "The amount and currency of the gift card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "available_gift_wrapping", + "description": "The list of available gift wrapping options for the cart item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftWrapping", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizable_options", + "description": "An array of customizations applied to the gift card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discount", + "description": "Contains discount for quote line item.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errors", + "description": "An array of errors encountered while loading the cart item", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartItemError", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_message", + "description": "The entered gift message data for the gift card cart item", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftMessage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping", + "description": "The selected gift wrapping option for the cart item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftWrapping", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." + }, + { + "name": "is_available", + "description": "True if requested quantity is less than available stock, false otherwise.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "max_qty", + "description": "Line item max qty in quote template", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The message from the sender to the recipient.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "min_qty", + "description": "Line item min qty in quote template", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "not_available_message", + "description": "Message to display when the product is not available with this selected option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note_from_buyer", + "description": "The buyer's quote line item note.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemNote", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note_from_seller", + "description": "The seller's quote line item note.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ItemNote", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CartItemPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Details about an item in the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of this item in the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "recipient_email", + "description": "The email address of the person receiving the gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "recipient_name", + "description": "The name of the person receiving the gift card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sender_email", + "description": "The email address of the sender.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sender_name", + "description": "The name of the sender.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `CartItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CartItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardWishlistItem", + "description": "A single gift card added to a wish list.", + "fields": [ + { + "name": "added_at", + "description": "The date and time the item was added to the wish list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizable_options", + "description": "Custom options selected for the wish list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_card_options", + "description": "Details about a gift card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftCardOptions", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `WishlistItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Product details of the wish list item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of this wish list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "WishlistItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardOptions", + "description": "Contains details about the sender, recipient, and amount of a gift card.", + "fields": [ + { + "name": "amount", + "description": "The amount and currency of the gift card.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_giftcard_amount", + "description": "The custom amount and currency of the gift card.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "A message to the recipient.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "recipient_email", + "description": "The email address of the person receiving the gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "recipient_name", + "description": "The name of the person receiving the gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sender_email", + "description": "The email address of the person sending the gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sender_name", + "description": "The name of the person sending the gift card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCartAttributeValue", + "description": "Gift card custom attribute value containing array data.", + "fields": [ + { + "name": "code", + "description": "The attribute code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "Array of gift card attribute option values.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftRegistrySearchResult", + "description": "Contains the results of a gift registry search.", + "fields": [ + { + "name": "event_date", + "description": "The date of the event.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "event_title", + "description": "The title given to the event.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_registry_uid", + "description": "The URL key of the gift registry.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "location", + "description": "The location of the event.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the gift registry owner.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of event being held.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "GiftRegistryDynamicAttributeInput", + "description": "Defines a dynamic attribute.", + "fields": null, + "inputFields": [ + { + "name": "code", + "description": "A unique key for an additional attribute of the event.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "A string that describes a dynamic attribute.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ShareGiftRegistrySenderInput", + "description": "Defines the sender of an invitation to view a gift registry.", + "fields": null, + "inputFields": [ + { + "name": "message", + "description": "A brief message from the sender.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The sender of the gift registry invitation.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ShareGiftRegistryInviteeInput", + "description": "Defines a gift registry invitee.", + "fields": null, + "inputFields": [ + { + "name": "email", + "description": "The email address of the gift registry invitee.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The name of the gift registry invitee.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AddGiftRegistryItemInput", + "description": "Defines an item to add to the gift registry.", + "fields": null, + "inputFields": [ + { + "name": "entered_options", + "description": "An array of options the customer has entered.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "EnteredOptionInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "note", + "description": "A brief note about the item.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "parent_sku", + "description": "For complex product types, the SKU of the parent product.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The quantity of the product to add.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "selected_options", + "description": "An array of strings corresponding to options the customer has selected.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sku", + "description": "The SKU of the product to add to the gift registry.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CreateGiftRegistryInput", + "description": "Defines a new gift registry.", + "fields": null, + "inputFields": [ + { + "name": "dynamic_attributes", + "description": "Additional attributes specified as a code-value pair.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "GiftRegistryDynamicAttributeInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "event_name", + "description": "The name of the event.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "gift_registry_type_uid", + "description": "The ID of the selected event type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "message", + "description": "A message describing the event.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "privacy_settings", + "description": "Indicates whether the registry is PRIVATE or PUBLIC.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "GiftRegistryPrivacySettings", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "registrants", + "description": "The list of people who receive notifications about the registry.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AddGiftRegistryRegistrantInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "shipping_address", + "description": "The shipping address for all gift registry items.", + "type": { + "kind": "INPUT_OBJECT", + "name": "GiftRegistryShippingAddressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "status", + "description": "Indicates whether the registry is ACTIVE or INACTIVE.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "GiftRegistryStatus", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "UpdateGiftRegistryItemInput", + "description": "Defines updates to an item in a gift registry.", + "fields": null, + "inputFields": [ + { + "name": "gift_registry_item_uid", + "description": "The unique ID of a `giftRegistryItem` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "note", + "description": "The updated description of the item.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The updated quantity of the gift registry item.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "UpdateGiftRegistryInput", + "description": "Defines updates to a `GiftRegistry` object.", + "fields": null, + "inputFields": [ + { + "name": "dynamic_attributes", + "description": "Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "GiftRegistryDynamicAttributeInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "event_name", + "description": "The updated name of the event.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "message", + "description": "The updated message describing the event.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "privacy_settings", + "description": "Indicates whether the gift registry is PRIVATE or PUBLIC.", + "type": { + "kind": "ENUM", + "name": "GiftRegistryPrivacySettings", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "shipping_address", + "description": "The updated shipping address for all gift registry items.", + "type": { + "kind": "INPUT_OBJECT", + "name": "GiftRegistryShippingAddressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "status", + "description": "Indicates whether the gift registry is ACTIVE or INACTIVE.", + "type": { + "kind": "ENUM", + "name": "GiftRegistryStatus", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AddGiftRegistryRegistrantInput", + "description": "Defines a new registrant.", + "fields": null, + "inputFields": [ + { + "name": "dynamic_attributes", + "description": "Additional attributes specified as a code-value pair.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "GiftRegistryDynamicAttributeInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "The email address of the registrant.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "firstname", + "description": "The first name of the registrant.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lastname", + "description": "The last name of the registrant.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "GiftRegistryShippingAddressInput", + "description": "Defines a shipping address for a gift registry. Specify either `address_data` or the `address_id`. If both are provided, validation will fail.", + "fields": null, + "inputFields": [ + { + "name": "address_data", + "description": "Defines the shipping address for this gift registry.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerAddressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "address_id", + "description": "The ID assigned to this customer address.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customer_address_uid", + "description": "The unique ID assigned to this customer address.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "UpdateGiftRegistryRegistrantInput", + "description": "Defines updates to an existing registrant.", + "fields": null, + "inputFields": [ + { + "name": "dynamic_attributes", + "description": "As a result of the update, only the values of provided attributes will be affected. If the attribute is missing in the request, its value will not be changed.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "GiftRegistryDynamicAttributeInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "The updated email address of the registrant.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "firstname", + "description": "The updated first name of the registrant.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "gift_registry_registrant_uid", + "description": "The unique ID of a `giftRegistryRegistrant` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lastname", + "description": "The updated last name of the registrant.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "GiftRegistryOutputInterface", + "description": "Contains the customer's gift registry.", + "fields": [ + { + "name": "gift_registry", + "description": "The gift registry.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftRegistry", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "GiftRegistryOutput", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MoveCartItemsToGiftRegistryOutput", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "GiftRegistryOutput", + "description": "Contains details about the gift registry.", + "fields": [ + { + "name": "gift_registry", + "description": "The gift registry.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftRegistry", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "GiftRegistryOutputInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "GiftRegistryItemUserErrorInterface", + "description": "Contains the status and any errors that encountered with the customer's gift register item.", + "fields": [ + { + "name": "status", + "description": "Indicates whether the attempt to move the cart items to the gift registry was successful.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "user_errors", + "description": "An array of errors encountered while moving items from the cart to the gift registry.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftRegistryItemsUserError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "GiftRegistryItemUserErrors", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MoveCartItemsToGiftRegistryOutput", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "GiftRegistryItemUserErrors", + "description": "Contains error information.", + "fields": [ + { + "name": "status", + "description": "Indicates whether the attempt to move the cart items to the gift registry was successful.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "user_errors", + "description": "An array of errors encountered while moving items from the cart to the gift registry.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftRegistryItemsUserError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "GiftRegistryItemUserErrorInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftRegistryItemsUserError", + "description": "Contains details about an error that occurred when processing a gift registry item.", + "fields": [ + { + "name": "code", + "description": "An error code that describes the error encountered.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "GiftRegistryItemsUserErrorType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_registry_item_uid", + "description": "The unique ID of the gift registry item containing an error.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_registry_uid", + "description": "The unique ID of the `GiftRegistry` object containing an error.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "A localized error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_uid", + "description": "The unique ID of the product containing an error.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "GiftRegistryItemsUserErrorType", + "description": "Defines the error type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "OUT_OF_STOCK", + "description": "Used for handling out of stock products.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_FOUND", + "description": "Used for exceptions like EntityNotFound.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNDEFINED", + "description": "Used for other exceptions, such as database connection failures.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MoveCartItemsToGiftRegistryOutput", + "description": "Contains the customer's gift registry and any errors encountered.", + "fields": [ + { + "name": "gift_registry", + "description": "The gift registry.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftRegistry", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "Indicates whether the attempt to move the cart items to the gift registry was successful.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "user_errors", + "description": "An array of errors encountered while moving items from the cart to the gift registry.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftRegistryItemsUserError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "GiftRegistryOutputInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "GiftRegistryItemUserErrorInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RemoveGiftRegistryOutput", + "description": "Contains the results of a request to delete a gift registry.", + "fields": [ + { + "name": "success", + "description": "Indicates whether the gift registry was successfully deleted.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RemoveGiftRegistryItemsOutput", + "description": "Contains the results of a request to remove an item from a gift registry.", + "fields": [ + { + "name": "gift_registry", + "description": "The gift registry after removing items.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftRegistry", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateGiftRegistryItemsOutput", + "description": "Contains the results of a request to update gift registry items.", + "fields": [ + { + "name": "gift_registry", + "description": "The gift registry after updating updating items.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftRegistry", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShareGiftRegistryOutput", + "description": "Contains the results of a request to share a gift registry.", + "fields": [ + { + "name": "is_shared", + "description": "Indicates whether the gift registry was successfully shared.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateGiftRegistryOutput", + "description": "Contains the results of a request to create a gift registry.", + "fields": [ + { + "name": "gift_registry", + "description": "The newly-created gift registry.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftRegistry", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateGiftRegistryOutput", + "description": "Contains the results of a request to update a gift registry.", + "fields": [ + { + "name": "gift_registry", + "description": "The updated gift registry.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftRegistry", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AddGiftRegistryRegistrantsOutput", + "description": "Contains the results of a request to add registrants.", + "fields": [ + { + "name": "gift_registry", + "description": "The gift registry after adding registrants.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftRegistry", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateGiftRegistryRegistrantsOutput", + "description": "Contains the results a request to update registrants.", + "fields": [ + { + "name": "gift_registry", + "description": "The gift registry after updating registrants.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftRegistry", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RemoveGiftRegistryRegistrantsOutput", + "description": "Contains the results of a request to delete a registrant.", + "fields": [ + { + "name": "gift_registry", + "description": "The gift registry after deleting registrants.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftRegistry", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftRegistry", + "description": "Contains details about a gift registry.", + "fields": [ + { + "name": "created_at", + "description": "The date on which the gift registry was created. Only the registry owner can access this attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "dynamic_attributes", + "description": "An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftRegistryDynamicAttribute", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "event_name", + "description": "The name of the event.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "An array of products added to the gift registry.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "GiftRegistryItemInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The message text the customer entered to describe the event.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "owner_name", + "description": "The customer who created the gift registry.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privacy_settings", + "description": "An enum that states whether the gift registry is PRIVATE or PUBLIC. Only the registry owner can access this attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "GiftRegistryPrivacySettings", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "registrants", + "description": "Contains details about each registrant for the event.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftRegistryRegistrant", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shipping_address", + "description": "Contains the customer's shipping address. Only the registry owner can access this attribute.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "An enum that states whether the gift registry is ACTIVE or INACTIVE. Only the registry owner can access this attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "GiftRegistryStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of gift registry.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftRegistryType", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID assigned to the gift registry.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftRegistryType", + "description": "Contains details about a gift registry type.", + "fields": [ + { + "name": "dynamic_attributes_metadata", + "description": "An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "GiftRegistryDynamicAttributeMetadataInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The label assigned to the gift registry type on the Admin.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID assigned to the gift registry type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "GiftRegistryDynamicAttributeMetadataInterface", + "description": "", + "fields": [ + { + "name": "attribute_group", + "description": "Indicates which group the dynamic attribute a member of.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "The internal ID of the dynamic attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "input_type", + "description": "The selected input type for this dynamic attribute. The value can be one of several static or custom types.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_required", + "description": "Indicates whether the dynamic attribute is required.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The display name of the dynamic attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The order in which to display the dynamic attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "GiftRegistryDynamicAttributeMetadata", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "GiftRegistryDynamicAttributeMetadata", + "description": "", + "fields": [ + { + "name": "attribute_group", + "description": "Indicates which group the dynamic attribute a member of.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "The internal ID of the dynamic attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "input_type", + "description": "The selected input type for this dynamic attribute. The value can be one of several static or custom types.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_required", + "description": "Indicates whether the dynamic attribute is required.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The display name of the dynamic attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The order in which to display the dynamic attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "GiftRegistryDynamicAttributeMetadataInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "GiftRegistryStatus", + "description": "Defines the status of the gift registry.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACTIVE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INACTIVE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "GiftRegistryPrivacySettings", + "description": "Defines the privacy setting of the gift registry.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRIVATE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PUBLIC", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftRegistryRegistrant", + "description": "Contains details about a registrant.", + "fields": [ + { + "name": "dynamic_attributes", + "description": "An array of dynamic attributes assigned to the registrant.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftRegistryRegistrantDynamicAttribute", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "The email address of the registrant. Only the registry owner can access this attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstname", + "description": "The first name of the registrant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastname", + "description": "The last name of the registrant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID assigned to the registrant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "GiftRegistryDynamicAttributeInterface", + "description": "", + "fields": [ + { + "name": "code", + "description": "The internal ID of the dynamic attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The display name of the dynamic attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "A corresponding value for the code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "GiftRegistryRegistrantDynamicAttribute", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftRegistryDynamicAttribute", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "GiftRegistryRegistrantDynamicAttribute", + "description": "", + "fields": [ + { + "name": "code", + "description": "The internal ID of the dynamic attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The display name of the dynamic attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "A corresponding value for the code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "GiftRegistryDynamicAttributeInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftRegistryDynamicAttribute", + "description": "", + "fields": [ + { + "name": "code", + "description": "The internal ID of the dynamic attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "group", + "description": "Indicates which group the dynamic attribute is a member of.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "GiftRegistryDynamicAttributeGroup", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The display name of the dynamic attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "A corresponding value for the code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "GiftRegistryDynamicAttributeInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "GiftRegistryDynamicAttributeGroup", + "description": "Defines the group type of a gift registry dynamic attribute.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "EVENT_INFORMATION", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRIVACY_SETTINGS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REGISTRANT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GENERAL_INFORMATION", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DETAILED_INFORMATION", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING_ADDRESS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "GiftRegistryItemInterface", + "description": "", + "fields": [ + { + "name": "created_at", + "description": "The date the product was added to the gift registry.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "A brief message about the gift registry item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Details about the gift registry item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The requested quantity of the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_fulfilled", + "description": "The fulfilled quantity of the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID of a gift registry item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "GiftRegistryItem", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "GiftRegistryItem", + "description": "", + "fields": [ + { + "name": "created_at", + "description": "The date the product was added to the gift registry.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "A brief message about the gift registry item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Details about the gift registry item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The requested quantity of the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_fulfilled", + "description": "The fulfilled quantity of the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID of a gift registry item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "GiftRegistryItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftWrapping", + "description": "Contains details about the selected or available gift wrapping options.", + "fields": [ + { + "name": "design", + "description": "The name of the gift wrapping design.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `GiftWrapping` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `uid` instead" + }, + { + "name": "image", + "description": "The preview image for a gift wrapping option.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftWrappingImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The gift wrapping price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `GiftWrapping` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftWrappingImage", + "description": "Points to an image associated with a gift wrapping option.", + "fields": [ + { + "name": "label", + "description": "The gift wrapping preview image label.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The gift wrapping preview image URL.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftOptionsPrices", + "description": "Contains prices for gift wrapping options.", + "fields": [ + { + "name": "gift_wrapping_for_items", + "description": "Price of the gift wrapping for all individual order items.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_for_items_incl_tax", + "description": "Price of the gift wrapping for all individual order items including tax.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_for_order", + "description": "Price of the gift wrapping for the whole order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_for_order_incl_tax", + "description": "Price of the gift wrapping for the whole order including tax.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "printed_card", + "description": "Price for the printed card.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "printed_card_incl_tax", + "description": "Price for the printed card including tax.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SetGiftOptionsOnCartInput", + "description": "Defines the gift options applied to the cart.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID that identifies the shopper's cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "gift_message", + "description": "Gift message details for the cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "GiftMessageInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "gift_receipt_included", + "description": "Whether customer requested gift receipt for the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "gift_wrapping_id", + "description": "The unique ID for a `GiftWrapping` object to be used for the cart.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "printed_card_included", + "description": "Whether customer requested printed card for the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SetGiftOptionsOnCartOutput", + "description": "Contains the cart after gift options have been applied.", + "fields": [ + { + "name": "cart", + "description": "The modified cart object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductTierPrices", + "description": "Deprecated. Use `TierPrice` instead. Defines a tier price, which is a quantity discount offered to a specific customer group.", + "fields": [ + { + "name": "customer_group_id", + "description": "The ID of the customer group.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Not relevant for the storefront." + }, + { + "name": "percentage_value", + "description": "The percentage discount of the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `TierPrice.discount` instead." + }, + { + "name": "qty", + "description": "The number of items that must be purchased to qualify for tier pricing.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `TierPrice.quantity` instead." + }, + { + "name": "value", + "description": "The price of the fixed price item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `TierPrice.final_price` instead." + }, + { + "name": "website_id", + "description": "The ID assigned to the website.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Not relevant for the storefront." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TierPrice", + "description": "Defines a price based on the quantity purchased.", + "fields": [ + { + "name": "discount", + "description": "The price discount that this tier represents.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductDiscount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "final_price", + "description": "The price of the product at this tier.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The minimum number of items that must be purchased to qualify for this price tier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GroupedProduct", + "description": "Defines a grouped product, which consists of simple standalone products that are presented as a group.", + "fields": [ + { + "name": "activity", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "attribute_set_id", + "description": "The attribute set assigned to the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "canonical_url", + "description": "The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "categories", + "description": "The categories assigned to a product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CategoryInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "category_gear", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "climate", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "collar", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "color", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "country_of_manufacture", + "description": "The product's country of origin.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "Timestamp indicating when the product was created.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "crosssell_products", + "description": "An array of cross-sell products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_attributesV2", + "description": "Product custom attributes.", + "args": [ + { + "name": "filters", + "description": "", + "type": { + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductCustomAttributes", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "Detailed information about the product. The value can include simple HTML tags.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "eco_collection", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "erin_recommends", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "features_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "format", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "gender", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "gift_message_available", + "description": "Returns a value indicating gift message availability for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_available", + "description": "Returns a value indicating gift wrapping availability for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping_price", + "description": "Returns value and currency indicating gift wrapping price for the product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID number assigned to the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `uid` field instead." + }, + { + "name": "image", + "description": "The relative path to the main image on the product page.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_returnable", + "description": "Indicates whether the product can be returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "An array containing grouped product items.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GroupedProductItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "manufacturer", + "description": "A number representing the product's manufacturer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "material", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "max_sale_qty", + "description": "Maximum Qty Allowed in Shopping Cart", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media_gallery", + "description": "An array of media gallery objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "MediaGalleryInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media_gallery_entries", + "description": "An array of MediaGalleryEntry objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaGalleryEntry", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `media_gallery` instead." + }, + { + "name": "meta_description", + "description": "A brief overview of the product for search results listings, maximum 255 characters.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_keyword", + "description": "A comma-separated list of keywords that are visible only to search engines.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "meta_title", + "description": "A string that is displayed in the title bar and tab of the browser and in search results lists.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "min_sale_qty", + "description": "Minimum Qty Allowed in Shopping Cart", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The product name. Customers use this name to identify the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "new", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "new_from_date", + "description": "The beginning date for new product listings, and determines if the product is featured as a new product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "new_to_date", + "description": "The end date for new product listings.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "only_x_left_in_stock", + "description": "Product stock only x left count", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options_container", + "description": "If the product has multiple options, determines where they appear on the product page.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pattern", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "performance_fabric", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "price", + "description": "Indicates the price of an item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductPrices", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `price_range` for product price information." + }, + { + "name": "price_range", + "description": "The range of prices for the product", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRange", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_tiers", + "description": "An array of `TierPrice` objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TierPrice", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_links", + "description": "An array of `ProductLinks` objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductLinksInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "purpose", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "quantity", + "description": "Amount of available stock", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rating_summary", + "description": "The average of all the ratings given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "redirect_code", + "description": "Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "related_products", + "description": "An array of related products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "relative_url", + "description": "The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "review_count", + "description": "The total count of all the reviews given to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reviews", + "description": "The list of products reviews.", + "args": [ + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sale", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "short_description", + "description": "A short description of the product. Its use depends on the theme.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "size", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "sku", + "description": "A number or code assigned to a product to identify the product, options, price, and manufacturer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sleeve", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "small_image", + "description": "The relative path to the small image, which is used on catalog pages.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "special_from_date", + "description": "The beginning date that a product has a special price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "special_price", + "description": "The discounted price of the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "special_to_date", + "description": "The end date for a product with a special price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staged", + "description": "Indicates whether the product is staged for a future campaign.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stock_status", + "description": "Stock status of the product", + "args": [], + "type": { + "kind": "ENUM", + "name": "ProductStockStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "strap_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_bags", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_bottom", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "style_general", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the `custom_attributes` field instead." + }, + { + "name": "swatch_image", + "description": "The file name of a swatch image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "thumbnail", + "description": "The relative path to the product's thumbnail image.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tier_price", + "description": "The price when tier pricing is in effect and the items purchased threshold has been reached.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." + }, + { + "name": "tier_prices", + "description": "An array of ProductTierPrices objects.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductTierPrices", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `price_tiers` for product tier price information." + }, + { + "name": "type", + "description": "One of PRODUCT, CATEGORY, or CMS_PAGE.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRewriteEntityTypeEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type_id", + "description": "One of simple, virtual, bundle, downloadable, grouped, or configurable.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `__typename` instead." + }, + { + "name": "uid", + "description": "The unique ID for a `ProductInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "Timestamp indicating when the product was updated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "upsell_products", + "description": "An array of up-sell products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_key", + "description": "The part of the URL that identifies the product", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_path", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use product's `canonical_url` or url rewrites instead" + }, + { + "name": "url_rewrites", + "description": "URL rewrites list", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRewrite", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url_suffix", + "description": "The part of the product URL that is appended after the url key", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "websites", + "description": "An array of websites in which the product is available.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Website", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "The field should not be used on the storefront." + }, + { + "name": "weight", + "description": "The weight of the item, in units defined by the store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "RoutableInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "PhysicalProductInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GroupedProductItem", + "description": "Contains information about an individual grouped product item.", + "fields": [ + { + "name": "position", + "description": "The relative position of this item compared to the other group items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Details about this product option.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "qty", + "description": "The quantity of this grouped product item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GroupedProductWishlistItem", + "description": "A grouped product wish list item.", + "fields": [ + { + "name": "added_at", + "description": "The date and time the item was added to the wish list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizable_options", + "description": "Custom options selected for the wish list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `WishlistItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Product details of the wish list item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of this wish list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "WishlistItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AreaInput", + "description": "AreaInput defines the parameters which will be used for filter by specified location.", + "fields": null, + "inputFields": [ + { + "name": "radius", + "description": "The radius for the search in KM.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "search_term", + "description": "The country code where search must be performed. Required parameter together with region, city or postcode.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PickupLocationFilterInput", + "description": "PickupLocationFilterInput defines the list of attributes and filters for the search.", + "fields": null, + "inputFields": [ + { + "name": "city", + "description": "Filter by city.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "country_id", + "description": "Filter by country.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": "Filter by pickup location name.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pickup_location_code", + "description": "Filter by pickup location code.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "postcode", + "description": "Filter by postcode.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "region", + "description": "Filter by region.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "region_id", + "description": "Filter by region id.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "street", + "description": "Filter by street.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterTypeInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PickupLocationSortInput", + "description": "PickupLocationSortInput specifies attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order.", + "fields": null, + "inputFields": [ + { + "name": "city", + "description": "City where pickup location is placed.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "contact_name", + "description": "Name of the contact person.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "country_id", + "description": "Id of the country in two letters.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "description", + "description": "Description of the pickup location.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "distance", + "description": "Distance to the address, requested by distance filter. Applicable only with distance filter. If distance sort order is present, all other sort orders will be ignored.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "email", + "description": "Contact email of the pickup location.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fax", + "description": "Contact fax of the pickup location.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "latitude", + "description": "Geographic latitude where pickup location is placed.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "longitude", + "description": "Geographic longitude where pickup location is placed.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The pickup location name. Customer use this to identify the pickup location.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "phone", + "description": "Contact phone number of the pickup location.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pickup_location_code", + "description": "A code assigned to pickup location to identify the source.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "postcode", + "description": "Postcode where pickup location is placed.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "region", + "description": "Name of the region.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "region_id", + "description": "Id of the region.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "street", + "description": "Street where pickup location is placed.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PickupLocations", + "description": "Top level object returned in a pickup locations search.", + "fields": [ + { + "name": "items", + "description": "An array of pickup locations that match the specific search request.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PickupLocation", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "An object that includes the page_info and currentPage values specified in the query.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The number of products returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PickupLocation", + "description": "Defines Pickup Location information.", + "fields": [ + { + "name": "city", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "contact_name", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country_id", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fax", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "latitude", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "longitude", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pickup_location_code", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "postcode", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "region", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "region_id", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "street", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductInfoInput", + "description": "Product Information used for Pickup Locations search.", + "fields": null, + "inputFields": [ + { + "name": "sku", + "description": "Product SKU.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "GenerateCustomerTokenAsAdminInput", + "description": "Identifies which customer requires remote shopping assistance.", + "fields": null, + "inputFields": [ + { + "name": "customer_email", + "description": "The email address of the customer requesting remote shopping assistance.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GenerateCustomerTokenAsAdminOutput", + "description": "Contains the generated customer token.", + "fields": [ + { + "name": "customer_token", + "description": "The generated customer token.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ApplyCouponsToCartInput", + "description": "Apply coupons to the cart.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "coupon_codes", + "description": "An array of valid coupon codes.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "type", + "description": "`replace` to replace the existing coupon(s) or `append` to add the coupon to the coupon(s) list.", + "type": { + "kind": "ENUM", + "name": "ApplyCouponsStrategy", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RemoveCouponsFromCartInput", + "description": "Remove coupons from the cart.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "coupon_codes", + "description": "An array of coupon codes to be removed from the quote. If coupon_codes is empty all coupons will be removed from the quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ApplyCouponsStrategy", + "description": "The strategy to apply coupons to the cart.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "APPEND", + "description": "Append new coupons keeping the coupons that have been applied before.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REPLACE", + "description": "Remove all the coupons from the cart and apply only new provided coupons.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReorderItemsOutput", + "description": "Contains the cart and any errors after adding products.", + "fields": [ + { + "name": "cart", + "description": "Detailed information about the customer's cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userInputErrors", + "description": "An array of reordering errors.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutUserInputError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutUserInputError", + "description": "An error encountered while adding an item to the cart.", + "fields": [ + { + "name": "code", + "description": "An error code that is specific to Checkout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CheckoutUserInputErrorCodes", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "A localized error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "path", + "description": "The path to the input field that caused an error. See the GraphQL specification about path errors for details: http://spec.graphql.org/draft/#sec-Errors", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerOrdersFilterInput", + "description": "Identifies the filter to use for filtering orders.", + "fields": null, + "inputFields": [ + { + "name": "grand_total", + "description": "Filters by order base grand total value.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterRangeTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "number", + "description": "Filters by order number.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterStringTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "order_date", + "description": "Filters by order created_at time.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterRangeTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "status", + "description": "Filters by order status.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerOrderSortInput", + "description": "CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order.", + "fields": null, + "inputFields": [ + { + "name": "sort_direction", + "description": "This enumeration indicates whether to return results in ascending or descending order", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sort_field", + "description": "Specifies the field to use for sorting", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CustomerOrderSortableField", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerOrderSortableField", + "description": "Specifies the field to use for sorting", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NUMBER", + "description": "Sorts customer orders by number", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED_AT", + "description": "Sorts customer orders by created_at field", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerOrders", + "description": "The collection of orders that match the conditions defined in the filter.", + "fields": [ + { + "name": "date_of_first_order", + "description": "Date of the first order placed in the store", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "An array of customer orders.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerOrder", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Contains pagination metadata.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The total count of customer orders.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderCustomerInfo", + "description": "", + "fields": [ + { + "name": "firstname", + "description": "First name of the customer", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastname", + "description": "Last name of the customer", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "middlename", + "description": "Middle name of the customer", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prefix", + "description": "Prefix of the customer", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "suffix", + "description": "Suffix of the customer", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderItem", + "description": "", + "fields": [ + { + "name": "discounts", + "description": "The final discount information for the product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "eligible_for_return", + "description": "Indicates whether the order item is eligible to be in a return request.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "entered_options", + "description": "The entered option for the base product, such as a logo or image.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderItemOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_message", + "description": "The selected gift message for the order item", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftMessage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_wrapping", + "description": "The selected gift wrapping for the order item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftWrapping", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for an `OrderItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "Contains details about the price of the item, including taxes and discounts.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderItemPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "The ProductInterface object, which contains details about the base product", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price of the base product, including selected options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_type", + "description": "The type of product, such as simple, configurable, etc.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_url_key", + "description": "URL key of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_canceled", + "description": "The number of canceled items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_invoiced", + "description": "The number of invoiced items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_ordered", + "description": "The number of units ordered for this item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_refunded", + "description": "The number of refunded items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_return_requested", + "description": "The requested return quantity of the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_returned", + "description": "The number of returned items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_shipped", + "description": "The number of shipped items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "selected_options", + "description": "The selected options for the base product, such as color or size.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderItemOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the order item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderItemPrices", + "description": "", + "fields": [ + { + "name": "discounts", + "description": "An array of discounts to be applied to the cart item.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fixed_product_taxes", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FixedProductTax", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "original_price", + "description": "The original price of the item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "original_price_including_tax", + "description": "The original price of the item including tax.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "original_row_total", + "description": "The value of the original price multiplied by the quantity of the item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "original_row_total_including_tax", + "description": "The value of the original price multiplied by the quantity of the item including tax.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price_including_tax", + "description": "The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "row_total", + "description": "The value of the price multiplied by the quantity of the item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "row_total_including_tax", + "description": "The value of `row_total` plus the tax applied to the item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_item_discount", + "description": "The total of all discounts applied to the item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderItemOption", + "description": "Represents order item options like selected or entered.", + "fields": [ + { + "name": "label", + "description": "The name of the option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TaxItem", + "description": "Contains tax item details.", + "fields": [ + { + "name": "amount", + "description": "The amount of tax applied to the item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rate", + "description": "The rate used to calculate the tax.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "A title that describes the tax.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Invoice", + "description": "Contains invoice details.", + "fields": [ + { + "name": "comments", + "description": "Comments on the invoice.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SalesCommentItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `Invoice` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "Invoiced product details.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "InvoiceItemInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "number", + "description": "Sequential invoice number.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total", + "description": "Invoice total amount details.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "InvoiceTotal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "InvoiceItemInterface", + "description": "Contains detailes about invoiced items.", + "fields": [ + { + "name": "discounts", + "description": "Information about the final discount amount for the base product, including discounts on options.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for an `InvoiceItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_item", + "description": "Details about an individual order item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price for the base product including selected options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_invoiced", + "description": "The number of invoiced items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "DownloadableInvoiceItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BundleInvoiceItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardInvoiceItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "InvoiceItem", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "InvoiceItem", + "description": "", + "fields": [ + { + "name": "discounts", + "description": "Information about the final discount amount for the base product, including discounts on options.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for an `InvoiceItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_item", + "description": "Details about an individual order item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price for the base product including selected options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_invoiced", + "description": "The number of invoiced items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "InvoiceItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InvoiceTotal", + "description": "Contains price details from an invoice.", + "fields": [ + { + "name": "base_grand_total", + "description": "The final base grand total amount in the base currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discounts", + "description": "The applied discounts to the invoice.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "grand_total", + "description": "The final total amount, including shipping, discounts, and taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shipping_handling", + "description": "Details about the shipping and handling costs for the invoice.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShippingHandling", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotal", + "description": "The subtotal of the invoice, excluding shipping, discounts, and taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxes", + "description": "The invoice tax details.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_shipping", + "description": "The shipping amount for the invoice.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_tax", + "description": "The amount of tax applied to the invoice.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShippingHandling", + "description": "Contains details about shipping and handling costs.", + "fields": [ + { + "name": "amount_excluding_tax", + "description": "The shipping amount, excluding tax.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "amount_including_tax", + "description": "The shipping amount, including tax.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discounts", + "description": "The applied discounts to the shipping.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShippingDiscount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxes", + "description": "Details about taxes applied for shipping.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_amount", + "description": "The total amount for shipping.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShippingDiscount", + "description": "Defines an individual shipping discount. This discount can be applied to shipping.", + "fields": [ + { + "name": "amount", + "description": "The amount of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderShipment", + "description": "Contains order shipment details.", + "fields": [ + { + "name": "comments", + "description": "Comments added to the shipment.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SalesCommentItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `OrderShipment` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "An array of items included in the shipment.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ShipmentItemInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "number", + "description": "The sequential credit shipment number.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tracking", + "description": "An array of shipment tracking details.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShipmentTracking", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SalesCommentItem", + "description": "Contains details about a comment.", + "fields": [ + { + "name": "message", + "description": "The text of the message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "timestamp", + "description": "The timestamp of the comment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "ShipmentItemInterface", + "description": "Order shipment item details.", + "fields": [ + { + "name": "id", + "description": "The unique ID for a `ShipmentItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_item", + "description": "The order item associated with the shipment item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price for the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_shipped", + "description": "The number of shipped items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "BundleShipmentItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardShipmentItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShipmentItem", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "ShipmentItem", + "description": "", + "fields": [ + { + "name": "id", + "description": "The unique ID for a `ShipmentItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_item", + "description": "The order item associated with the shipment item.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price for the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_shipped", + "description": "The number of shipped items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ShipmentItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShipmentTracking", + "description": "Contains order shipment tracking details.", + "fields": [ + { + "name": "carrier", + "description": "The shipping carrier for the order delivery.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "number", + "description": "The tracking number of the order shipment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The shipment tracking title.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderPaymentMethod", + "description": "Contains details about the payment method used to pay for the order.", + "fields": [ + { + "name": "additional_data", + "description": "Additional data per payment method type.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "KeyValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The label that describes the payment method.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The payment method code that indicates how the order was paid for.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreditMemo", + "description": "Contains credit memo details.", + "fields": [ + { + "name": "comments", + "description": "Comments on the credit memo.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SalesCommentItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `CreditMemo` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "An array containing details about refunded items.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CreditMemoItemInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "number", + "description": "The sequential credit memo number.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total", + "description": "Details about the total refunded amount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CreditMemoTotal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "CreditMemoItemInterface", + "description": "Credit memo item details.", + "fields": [ + { + "name": "discounts", + "description": "Details about the final discount amount for the base product, including discounts on options.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `CreditMemoItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_item", + "description": "The order item the credit memo is applied to.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price for the base product, including selected options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_refunded", + "description": "The number of refunded items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "DownloadableCreditMemoItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BundleCreditMemoItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardCreditMemoItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CreditMemoItem", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "CreditMemoItem", + "description": "", + "fields": [ + { + "name": "discounts", + "description": "Details about the final discount amount for the base product, including discounts on options.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for a `CreditMemoItemInterface` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_item", + "description": "The order item the credit memo is applied to.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "The name of the base product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sale_price", + "description": "The sale price for the base product, including selected options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_sku", + "description": "The SKU of the base product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity_refunded", + "description": "The number of refunded items.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CreditMemoItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreditMemoTotal", + "description": "Contains credit memo price details.", + "fields": [ + { + "name": "adjustment", + "description": "An adjustment manually applied to the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "base_grand_total", + "description": "The final base grand total amount in the base currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discounts", + "description": "The applied discounts to the credit memo.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "grand_total", + "description": "The final total amount, including shipping, discounts, and taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shipping_handling", + "description": "Details about the shipping and handling costs for the credit memo.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShippingHandling", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotal", + "description": "The subtotal of the invoice, excluding shipping, discounts, and taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxes", + "description": "The credit memo tax details.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_shipping", + "description": "The shipping amount for the credit memo.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_tax", + "description": "The amount of tax applied to the credit memo.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "KeyValue", + "description": "Contains a key-value pair.", + "fields": [ + { + "name": "name", + "description": "The name part of the key/value pair.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value part of the key/value pair.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CheckoutUserInputErrorCodes", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "REORDER_NOT_AVAILABLE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_NOT_FOUND", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_SALABLE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INSUFFICIENT_STOCK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNDEFINED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ScopeTypeEnum", + "description": "This enumeration defines the scope type for customer orders.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "GLOBAL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WEBSITE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STORE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "OrderTokenInput", + "description": "Input to retrieve an order based on token.", + "fields": null, + "inputFields": [ + { + "name": "token", + "description": "Order token.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "OrderInformationInput", + "description": "Input to retrieve an order based on details.", + "fields": null, + "inputFields": [ + { + "name": "email", + "description": "Order billing address email.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lastname", + "description": "Order billing address lastname.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "number", + "description": "Order number.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "postcode", + "description": "Order billing address postcode", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "GuestOrderInformationInput", + "description": "Input to retrieve an order based on details.", + "fields": null, + "inputFields": [ + { + "name": "email", + "description": "Order billing address email.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lastname", + "description": "Order billing address lastname.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "number", + "description": "Order number.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "OrderActionType", + "description": "The list of available order actions.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "REORDER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCEL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RETURN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DuplicateNegotiableQuoteInput", + "description": "Identifies a quote to be duplicated", + "fields": null, + "inputFields": [ + { + "name": "duplicated_quote_uid", + "description": "ID for the newly duplicated quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quote_uid", + "description": "ID of the quote to be duplicated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DuplicateNegotiableQuoteOutput", + "description": "Contains the newly created negotiable quote.", + "fields": [ + { + "name": "quote", + "description": "Negotiable Quote resulting from duplication operation.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuote", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplate", + "description": "Contains details about a negotiable quote template.", + "fields": [ + { + "name": "buyer", + "description": "The first and last name of the buyer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteUser", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "comments", + "description": "A list of comments made by the buyer and seller.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteComment", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expiration_date", + "description": "The expiration period of the negotiable quote template.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "history", + "description": "A list of status and price changes for the negotiable quote template.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryEntry", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_min_max_qty_used", + "description": "Indicates whether the minimum and maximum quantity settings are used.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_virtual", + "description": "Indicates whether the negotiable quote template contains only virtual products.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "The list of items in the negotiable quote template.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CartItemInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "max_order_commitment", + "description": "Commitment for maximum orders", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "min_order_commitment", + "description": "Commitment for minimum orders", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The title assigned to the negotiable quote template.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "notifications", + "description": "A list of notifications for the negotiable quote template.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "QuoteTemplateNotificationMessage", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "A set of subtotals and totals applied to the negotiable quote template.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CartPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reference_document_links", + "description": "A list of reference document links for the negotiable quote template.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteReferenceDocumentLink", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shipping_addresses", + "description": "A list of shipping addresses applied to the negotiable quote template.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteShippingAddress", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the negotiable quote template.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "template_id", + "description": "The unique ID of a `NegotiableQuoteTemplate` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_quantity", + "description": "The total number of items in the negotiable quote template.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplateGridItem", + "description": "Contains data for a negotiable quote template in a grid.", + "fields": [ + { + "name": "activated_at", + "description": "The date and time the negotiable quote template was activated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company_name", + "description": "Company name the quote template is assigned to", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expiration_date", + "description": "The expiration period of the negotiable quote template.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_min_max_qty_used", + "description": "Indicates whether the minimum and maximum quantity settings are used.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "last_shared_at", + "description": "The date and time the negotiable quote template was last shared.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "max_order_commitment", + "description": "Commitment for maximum orders", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "min_negotiated_grand_total", + "description": "The minimum negotiated grand total of the negotiable quote template.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "min_order_commitment", + "description": "Commitment for minimum orders", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The title assigned to the negotiable quote template.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders_placed", + "description": "The number of orders placed for the negotiable quote template.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sales_rep_name", + "description": "The first and last name of the sales representative.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "state", + "description": "State of the negotiable quote template.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the negotiable quote template.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "submitted_by", + "description": "The first and last name of the buyer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "template_id", + "description": "The unique ID of a `NegotiableQuoteTemplate` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplatesOutput", + "description": "Contains a list of negotiable templates that match the specified filter.", + "fields": [ + { + "name": "items", + "description": "A list of negotiable quote templates", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplateGridItem", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Contains pagination metadata", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_fields", + "description": "Contains the default sort field and all available sort fields.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SortFields", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The number of negotiable quote templates returned", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateNegotiableQuoteTemplateItemsQuantityOutput", + "description": "Contains the updated negotiable quote template.", + "fields": [ + { + "name": "quote_template", + "description": "The updated negotiable quote template.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplate", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GenerateNegotiableQuoteFromTemplateOutput", + "description": "Contains the generated negotiable quote id.", + "fields": [ + { + "name": "negotiable_quote_uid", + "description": "The unique ID of a generated `NegotiableQuote` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeleteNegotiableQuoteTemplateOutput", + "description": "Contains details about a failed delete operation on a negotiable quote template.", + "fields": [ + { + "name": "error_message", + "description": "A message that describes the error.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "Flag to mark whether the delete operation was successful.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "QuoteTemplateNotificationMessage", + "description": "Contains a notification message for a negotiable quote template.", + "fields": [ + { + "name": "message", + "description": "The notification message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of notification message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteReferenceDocumentLink", + "description": "Contains a reference document link for a negotiable quote template.", + "fields": [ + { + "name": "document_identifier", + "description": "The identifier of the reference document.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "document_name", + "description": "The title of the reference document.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "link_id", + "description": "The unique ID of a reference document link.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reference_document_url", + "description": "The URL of the reference document.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteTemplateFilterInput", + "description": "Defines a filter to limit the negotiable quotes to return.", + "fields": null, + "inputFields": [ + { + "name": "state", + "description": "Filter by state of one or more negotiable quote templates.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "status", + "description": "Filter by status of one or more negotiable quote templates.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteTemplateSortInput", + "description": "Defines the field to use to sort a list of negotiable quotes.", + "fields": null, + "inputFields": [ + { + "name": "sort_direction", + "description": "Whether to return results in ascending or descending order.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sort_field", + "description": "The specified sort field.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "NegotiableQuoteTemplateSortableField", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RequestNegotiableQuoteTemplateInput", + "description": "Defines properties of a negotiable quote template request.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The cart ID of the quote to create the new negotiable quote template from.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteTemplateReferenceDocumentLinkInput", + "description": "Defines the reference document link to add to a negotiable quote template.", + "fields": null, + "inputFields": [ + { + "name": "document_identifier", + "description": "The identifier of the reference document.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "document_name", + "description": "The title of the reference document.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "link_id", + "description": "The unique ID of a `NegotiableQuoteReferenceDocumentLink` object.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reference_document_url", + "description": "The URL of the reference document.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "UpdateNegotiableQuoteTemplateQuantitiesInput", + "description": "Specifies the items to update.", + "fields": null, + "inputFields": [ + { + "name": "items", + "description": "An array of items to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteTemplateItemQuantityInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "template_id", + "description": "The unique ID of a `NegotiableQuoteTemplate` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteTemplateItemQuantityInput", + "description": "Specifies the updated quantity of an item.", + "fields": null, + "inputFields": [ + { + "name": "item_id", + "description": "The unique ID of a `CartItemInterface` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "max_qty", + "description": "The new max quantity of the negotiable quote template item. Only used if is_min_max_qty_used is true on the template.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "min_qty", + "description": "The new min quantity of the negotiable quote template item. Only used if is_min_max_qty_used is true on the template.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The new quantity of the negotiable quote item.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SetNegotiableQuoteTemplateShippingAddressInput", + "description": "Defines the shipping address to assign to the negotiable quote template.", + "fields": null, + "inputFields": [ + { + "name": "shipping_address", + "description": "A shipping adadress to apply to the negotiable quote template.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteTemplateShippingAddressInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "template_id", + "description": "The unique ID of a `NegotiableQuote` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteTemplateShippingAddressInput", + "description": "Defines shipping addresses for the negotiable quote template.", + "fields": null, + "inputFields": [ + { + "name": "address", + "description": "A shipping address.", + "type": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteAddressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customer_address_uid", + "description": "An ID from the company user's address book that uniquely identifies the address to be used for shipping.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customer_notes", + "description": "Text provided by the company user.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubmitNegotiableQuoteTemplateForReviewInput", + "description": "Specifies the quote template properties to update.", + "fields": null, + "inputFields": [ + { + "name": "comment", + "description": "A comment for the seller to review.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "max_order_commitment", + "description": "Commitment for maximum orders", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "min_order_commitment", + "description": "Commitment for minimum orders", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The title assigned to the negotiable quote template.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reference_document_links", + "description": "An array of reference document links to add to the negotiable quote template.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteTemplateReferenceDocumentLinkInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "template_id", + "description": "The unique ID of a `NegotiableQuoteTemplate` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AcceptNegotiableQuoteTemplateInput", + "description": "Specifies the quote template id to accept quote template.", + "fields": null, + "inputFields": [ + { + "name": "template_id", + "description": "The unique ID of a `NegotiableQuoteTemplate` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "OpenNegotiableQuoteTemplateInput", + "description": "Specifies the quote template id to open quote template.", + "fields": null, + "inputFields": [ + { + "name": "template_id", + "description": "The unique ID of a `NegotiableQuoteTemplate` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "GenerateNegotiableQuoteFromTemplateInput", + "description": "Specifies the template id, from which to generate quote from.", + "fields": null, + "inputFields": [ + { + "name": "template_id", + "description": "The unique ID of a `NegotiableQuoteTemplate` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RemoveNegotiableQuoteTemplateItemsInput", + "description": "Defines the items to remove from the specified negotiable quote.", + "fields": null, + "inputFields": [ + { + "name": "item_uids", + "description": "An array of IDs indicating which items to remove from the negotiable quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "template_id", + "description": "The unique ID of a `NegotiableQuoteTemplate` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CancelNegotiableQuoteTemplateInput", + "description": "Specifies the quote template id of the quote template to cancel", + "fields": null, + "inputFields": [ + { + "name": "cancellation_comment", + "description": "A comment to provide reason of cancellation.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "template_id", + "description": "The unique ID of a `NegotiableQuoteTemplate` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DeleteNegotiableQuoteTemplateInput", + "description": "Specifies the quote template id of the quote template to delete", + "fields": null, + "inputFields": [ + { + "name": "template_id", + "description": "The unique ID of a `NegotiableQuoteTemplate` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "QuoteTemplateLineItemNoteInput", + "description": "Sets quote item note.", + "fields": null, + "inputFields": [ + { + "name": "item_id", + "description": "The unique ID of a `CartLineItem` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "note", + "description": "The note text to be added.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "templateId", + "description": "The unique ID of a `NegotiableQuoteTemplate` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "NegotiableQuoteTemplateSortableField", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TEMPLATE_ID", + "description": "Sorts negotiable quote templates by template id.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LAST_SHARED_AT", + "description": "Sorts negotiable quote templates by the date they were last shared.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyCreditHistory", + "description": "Contains details about prior company credit operations.", + "fields": [ + { + "name": "items", + "description": "An array of company credit operations.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyCreditOperation", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Metadata for pagination rendering.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The number of the company credit operations matching the specified filter.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyCreditOperation", + "description": "Contains details about a single company credit operation.", + "fields": [ + { + "name": "amount", + "description": "The amount of the company credit operation.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "balance", + "description": "The credit balance as a result of the operation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyCredit", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_reference_number", + "description": "The purchase order number associated with the company credit operation.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "date", + "description": "The date the operation occurred.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of the company credit operation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CompanyCreditOperationType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_by", + "description": "The company user that submitted the company credit operation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyCreditOperationUser", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyCreditOperationUser", + "description": "Defines the administrator or company user that submitted a company credit operation.", + "fields": [ + { + "name": "name", + "description": "The name of the company user submitting the company credit operation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of the company user submitting the company credit operation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CompanyCreditOperationUserType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyCredit", + "description": "Contains company credit balances and limits.", + "fields": [ + { + "name": "available_credit", + "description": "The sum of the credit limit and the outstanding balance. If the company has exceeded the credit limit, the amount is as a negative value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "credit_limit", + "description": "The amount of credit extended to the company.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "outstanding_balance", + "description": "The amount reimbursed, less the total due from all orders placed using the Payment on Account payment method. The amount can be a positive or negative value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CompanyCreditOperationType", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ALLOCATION", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PURCHASE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REIMBURSEMENT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REFUND", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REVERT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CompanyCreditOperationUserType", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CUSTOMER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ADMIN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyCreditHistoryFilterInput", + "description": "Defines a filter for narrowing the results of a credit history search.", + "fields": null, + "inputFields": [ + { + "name": "custom_reference_number", + "description": "The purchase order number associated with the company credit operation.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "operation_type", + "description": "The type of the company credit operation.", + "type": { + "kind": "ENUM", + "name": "CompanyCreditOperationType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "updated_by", + "description": "The name of the person submitting the company credit operation.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscribeEmailToNewsletterOutput", + "description": "Contains the result of the `subscribeEmailToNewsletter` operation.", + "fields": [ + { + "name": "status", + "description": "The status of the subscription request.", + "args": [], + "type": { + "kind": "ENUM", + "name": "SubscriptionStatusesEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SubscriptionStatusesEnum", + "description": "Indicates the status of the request.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NOT_ACTIVE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIBED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNSUBSCRIBED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNCONFIRMED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CancellationReason", + "description": "", + "fields": [ + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CancelOrderInput", + "description": "Defines the order to cancel.", + "fields": null, + "inputFields": [ + { + "name": "order_id", + "description": "The unique ID of an `Order` type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "reason", + "description": "Cancellation reason.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ConfirmCancelOrderInput", + "description": "", + "fields": null, + "inputFields": [ + { + "name": "confirmation_key", + "description": "Confirmation Key to cancel the order.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "order_id", + "description": "The unique ID of an `Order` type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "GuestOrderCancelInput", + "description": "Input to retrieve a guest order based on token.", + "fields": null, + "inputFields": [ + { + "name": "reason", + "description": "Cancellation reason.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "token", + "description": "Order token.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CancelOrderOutput", + "description": "Contains the updated customer order and error message if any.", + "fields": [ + { + "name": "error", + "description": "Error encountered while cancelling the order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errorV2", + "description": null, + "args": [], + "type": { + "kind": "OBJECT", + "name": "CancelOrderError", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "Updated customer order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CancelOrderError", + "description": "", + "fields": [ + { + "name": "code", + "description": "An error code that is specific to cancel order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CancelOrderErrorCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "A localized error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CancelOrderErrorCode", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ORDER_CANCELLATION_DISABLED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNDEFINED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNAUTHORISED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDER_NOT_FOUND", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PARTIAL_ORDER_ITEM_SHIPPED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_ORDER_STATUS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AddProductsToNewCartOutput", + "description": "Contains details about the cart after adding products to it.", + "fields": [ + { + "name": "cart", + "description": "The cart after products have been added.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "user_errors", + "description": "Contains errors encountered while adding an item to the cart.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartUserInputError", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SetCartAsInactiveOutput", + "description": "Sets the cart as inactive", + "fields": [ + { + "name": "error", + "description": "The error message returned after failing to set the cart as inactive", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "success", + "description": "Indicates whether the cart was set as inactive", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GetPaymentSDKOutput", + "description": "Gets the payment SDK URLs and values", + "fields": [ + { + "name": "sdkParams", + "description": "The payment SDK parameters", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentSDKParamsItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentSDKParamsItem", + "description": "", + "fields": [ + { + "name": "code", + "description": "The payment method code used in the order", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "params", + "description": "The payment SDK parameters", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SDKParams", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentOrderOutput", + "description": "Contains the payment order details", + "fields": [ + { + "name": "id", + "description": "PayPal order ID", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mp_order_id", + "description": "The order ID generated by Payment Services", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_source_details", + "description": "Details about the card used on the order", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PaymentSourceDetails", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the payment order", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentSourceDetails", + "description": "", + "fields": [ + { + "name": "card", + "description": "Details about the card used on the order", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Card", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Card", + "description": "", + "fields": [ + { + "name": "bin_details", + "description": "Card bin details", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CardBin", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "card_expiry_month", + "description": "Expiration month of the card", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "card_expiry_year", + "description": "Expiration year of the card", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "last_digits", + "description": "Last four digits of the card", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Name on the card", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CardBin", + "description": "", + "fields": [ + { + "name": "bin", + "description": "Card bin number", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CreatePaymentOrderInput", + "description": "Contains payment order details that are used while processing the payment order", + "fields": null, + "inputFields": [ + { + "name": "cartId", + "description": "The customer cart ID", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "location", + "description": "Defines the origin location for that payment request", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PaymentLocation", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "methodCode", + "description": "The code for the payment method used in the order", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "paymentSource", + "description": "The identifiable payment source for the payment method", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "vaultIntent", + "description": "Indicates whether the payment information should be vaulted", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompleteOrderInput", + "description": "Update the quote and complete the order", + "fields": null, + "inputFields": [ + { + "name": "cartId", + "description": "The customer cart ID", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "id", + "description": "PayPal order ID", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SyncPaymentOrderInput", + "description": "Synchronizes the payment order details", + "fields": null, + "inputFields": [ + { + "name": "cartId", + "description": "The customer cart ID", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "id", + "description": "PayPal order ID", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreatePaymentOrderOutput", + "description": "Contains payment order details that are used while processing the payment order", + "fields": [ + { + "name": "amount", + "description": "The amount of the payment order", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currency_code", + "description": "The currency of the payment order", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "PayPal order ID", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mp_order_id", + "description": "The order ID generated by Payment Services", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the payment order", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PaymentLocation", + "description": "Defines the origin location for that payment request", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRODUCT_DETAIL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MINICART", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CART", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CHECKOUT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "START_OF_CHECKOUT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ADMIN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentConfigOutput", + "description": "Retrieves the payment configuration for a given location", + "fields": [ + { + "name": "apple_pay", + "description": "ApplePay payment method configuration", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ApplePayConfig", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fastlane", + "description": "Fastlane payment method configuration", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FastlaneConfig", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "google_pay", + "description": "GooglePay payment method configuration", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GooglePayConfig", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hosted_fields", + "description": "Hosted fields payment method configuration", + "args": [], + "type": { + "kind": "OBJECT", + "name": "HostedFieldsConfig", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "smart_buttons", + "description": "Smart Buttons payment method configuration", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SmartButtonsConfig", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "PaymentConfigItem", + "description": "Contains payment fields that are common to all types of payment methods.", + "fields": [ + { + "name": "code", + "description": "The payment method code as defined in the payment gateway", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_visible", + "description": "Indicates whether the payment method is displayed", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_intent", + "description": "Defines the payment intent (Authorize or Capture", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sdk_params", + "description": "The PayPal parameters required to load the JS SDK", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SDKParams", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The relative order the payment method is displayed on the checkout page", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The name displayed for the payment method", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "PaymentCommonConfig", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "HostedFieldsConfig", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SmartButtonsConfig", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ApplePayConfig", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GooglePayConfig", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "FastlaneConfig", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "PaymentCommonConfig", + "description": "", + "fields": [ + { + "name": "code", + "description": "The payment method code as defined in the payment gateway", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_visible", + "description": "Indicates whether the payment method is displayed", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_intent", + "description": "Defines the payment intent (Authorize or Capture", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sdk_params", + "description": "The PayPal parameters required to load the JS SDK", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SDKParams", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The relative order the payment method is displayed on the checkout page", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The name displayed for the payment method", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "PaymentConfigItem", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "HostedFieldsConfig", + "description": "", + "fields": [ + { + "name": "cc_vault_code", + "description": "Vault payment method code", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "The payment method code as defined in the payment gateway", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_vault_enabled", + "description": "Card vault enabled", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_visible", + "description": "Indicates whether the payment method is displayed", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_intent", + "description": "Defines the payment intent (Authorize or Capture", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_source", + "description": "The payment source for the payment method", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requires_card_details", + "description": "Card and bin details required", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sdk_params", + "description": "The PayPal parameters required to load the JS SDK", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SDKParams", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The relative order the payment method is displayed on the checkout page", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "three_ds", + "description": "Whether 3DS is activated; true if 3DS mode is not OFF.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use 'three_ds_mode' instead." + }, + { + "name": "three_ds_mode", + "description": "3DS mode", + "args": [], + "type": { + "kind": "ENUM", + "name": "ThreeDSMode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The name displayed for the payment method", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "PaymentConfigItem", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ThreeDSMode", + "description": "3D Secure mode.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "OFF", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCA_WHEN_REQUIRED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCA_ALWAYS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SmartButtonsConfig", + "description": "", + "fields": [ + { + "name": "app_switch_when_available", + "description": "Indicated whether to use App Switch on enabled mobile devices", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "button_styles", + "description": "The styles for the PayPal Smart Button configuration", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ButtonStyles", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "The payment method code as defined in the payment gateway", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "display_message", + "description": "Indicates whether to display the PayPal Pay Later message", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "display_venmo", + "description": "Indicates whether to display Venmo", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_visible", + "description": "Indicates whether the payment method is displayed", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message_styles", + "description": "Contains details about the styles for the PayPal Pay Later message", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MessageStyles", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_intent", + "description": "Defines the payment intent (Authorize or Capture", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sdk_params", + "description": "The PayPal parameters required to load the JS SDK", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SDKParams", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The relative order the payment method is displayed on the checkout page", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The name displayed for the payment method", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "PaymentConfigItem", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ApplePayConfig", + "description": "", + "fields": [ + { + "name": "button_styles", + "description": "The styles for the ApplePay Smart Button configuration", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ButtonStyles", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "The payment method code as defined in the payment gateway", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_visible", + "description": "Indicates whether the payment method is displayed", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_intent", + "description": "Defines the payment intent (Authorize or Capture", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_source", + "description": "The payment source for the payment method", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sdk_params", + "description": "The PayPal parameters required to load the JS SDK", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SDKParams", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The relative order the payment method is displayed on the checkout page", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The name displayed for the payment method", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "PaymentConfigItem", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GooglePayConfig", + "description": "", + "fields": [ + { + "name": "button_styles", + "description": "The styles for the GooglePay Button configuration", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GooglePayButtonStyles", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "The payment method code as defined in the payment gateway", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_visible", + "description": "Indicates whether the payment method is displayed", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_intent", + "description": "Defines the payment intent (Authorize or Capture", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_source", + "description": "The payment source for the payment method", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sdk_params", + "description": "The PayPal parameters required to load the JS SDK", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SDKParams", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The relative order the payment method is displayed on the checkout page", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "three_ds_mode", + "description": "3DS mode", + "args": [], + "type": { + "kind": "ENUM", + "name": "ThreeDSMode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The name displayed for the payment method", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "PaymentConfigItem", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FastlaneConfig", + "description": "", + "fields": [ + { + "name": "code", + "description": "The payment method code as defined in the payment gateway", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_visible", + "description": "Indicates whether the payment method is displayed", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_intent", + "description": "Defines the payment intent (Authorize or Capture", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_source", + "description": "The payment source for the payment method", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sdk_params", + "description": "The PayPal parameters required to load the JS SDK", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SDKParams", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The relative order the payment method is displayed on the checkout page", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "three_ds_mode", + "description": "3DS mode", + "args": [], + "type": { + "kind": "ENUM", + "name": "ThreeDSMode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The name displayed for the payment method", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "PaymentConfigItem", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ButtonStyles", + "description": "", + "fields": [ + { + "name": "color", + "description": "The button color", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "height", + "description": "The button height in pixels", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The button label", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "layout", + "description": "The button layout", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shape", + "description": "The button shape", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tagline", + "description": "Indicates whether the tagline is displayed", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "use_default_height", + "description": "Defines if the button uses default height. If the value is false, the value of height is used", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GooglePayButtonStyles", + "description": "", + "fields": [ + { + "name": "color", + "description": "The button color", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "height", + "description": "The button height in pixels", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The button type", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MessageStyles", + "description": "", + "fields": [ + { + "name": "layout", + "description": "The message layout", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "logo", + "description": "The message logo", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MessageStyleLogo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MessageStyleLogo", + "description": "", + "fields": [ + { + "name": "type", + "description": "The type of logo for the PayPal Pay Later messaging", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SDKParams", + "description": "Defines the name and value of a SDK parameter", + "fields": [ + { + "name": "name", + "description": "The name of the SDK parameter", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the SDK parameter", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "VaultMethodInput", + "description": "Vault payment inputs", + "fields": null, + "inputFields": [ + { + "name": "payment_source", + "description": "The payment source for the payment method", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "payments_order_id", + "description": "The payment services order ID", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "paypal_order_id", + "description": "PayPal order ID", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "public_hash", + "description": "The public hash of the token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SmartButtonMethodInput", + "description": "Smart button payment inputs", + "fields": null, + "inputFields": [ + { + "name": "payment_source", + "description": "The payment source for the payment method", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "payments_order_id", + "description": "The payment services order ID", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "paypal_order_id", + "description": "PayPal order ID", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ApplePayMethodInput", + "description": "Apple Pay inputs", + "fields": null, + "inputFields": [ + { + "name": "payment_source", + "description": "The payment source for the payment method", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "payments_order_id", + "description": "The payment services order ID", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "paypal_order_id", + "description": "PayPal order ID", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "GooglePayMethodInput", + "description": "Google Pay inputs", + "fields": null, + "inputFields": [ + { + "name": "payment_source", + "description": "The payment source for the payment method", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "payments_order_id", + "description": "The payment services order ID", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "paypal_order_id", + "description": "PayPal order ID", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "HostedFieldsInput", + "description": "Hosted Fields payment inputs", + "fields": null, + "inputFields": [ + { + "name": "cardBin", + "description": "Card bin number", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cardExpiryMonth", + "description": "Expiration month of the card", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cardExpiryYear", + "description": "Expiration year of the card", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cardLast4", + "description": "Last four digits of the card", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "holderName", + "description": "Name on the card", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "is_active_payment_token_enabler", + "description": "Indicates whether details about the shopper's credit/debit card should be tokenized for later usage. Required only if Vault is enabled for the Payment Services payment integration.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "payment_source", + "description": "The payment source for the payment method", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "payments_order_id", + "description": "The payment services order ID", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "paypal_order_id", + "description": "PayPal order ID", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FastlaneMethodInput", + "description": "Fastlane Payment inputs", + "fields": null, + "inputFields": [ + { + "name": "payment_source", + "description": "The payment source for the payment method", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "paypal_fastlane_token", + "description": "The single use token from Fastlane", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CreateVaultCardSetupTokenInput", + "description": "Describe the variables needed to create a vault card setup token", + "fields": null, + "inputFields": [ + { + "name": "setup_token", + "description": "The setup token information", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "VaultSetupTokenInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "three_ds_mode", + "description": "The 3DS mode", + "type": { + "kind": "ENUM", + "name": "ThreeDSMode", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "VaultSetupTokenInput", + "description": "The payment source information", + "fields": null, + "inputFields": [ + { + "name": "payment_source", + "description": "The payment source information", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PaymentSourceInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PaymentSourceInput", + "description": "The payment source information", + "fields": null, + "inputFields": [ + { + "name": "card", + "description": "The card payment source information", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CardPaymentSourceInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CardPaymentSourceInput", + "description": "The card payment source information", + "fields": null, + "inputFields": [ + { + "name": "billing_address", + "description": "The billing address of the card", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "BillingAddressPaymentSourceInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The name on the cardholder", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "BillingAddressPaymentSourceInput", + "description": "The billing address information", + "fields": null, + "inputFields": [ + { + "name": "address_line_1", + "description": "The first line of the address", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "address_line_2", + "description": "The second line of the address", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "city", + "description": "The city of the address", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "country_code", + "description": "The country of the address", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "postal_code", + "description": "The postal code of the address", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "region", + "description": "The region of the address", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateVaultCardSetupTokenOutput", + "description": "The setup token id information", + "fields": [ + { + "name": "setup_token", + "description": "The setup token id", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CreateVaultCardPaymentTokenInput", + "description": "Describe the variables needed to create a vault payment token", + "fields": null, + "inputFields": [ + { + "name": "card_description", + "description": "Description of the vaulted card", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "setup_token_id", + "description": "The setup token obtained by the createVaultCardSetupToken endpoint", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateVaultCardPaymentTokenOutput", + "description": "The vault token id and information about the payment source", + "fields": [ + { + "name": "payment_source", + "description": "The payment source information", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentSourceOutput", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vault_token_id", + "description": "The vault payment token information", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentSourceOutput", + "description": "The payment source information", + "fields": [ + { + "name": "card", + "description": "The card payment source information", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CardPaymentSourceOutput", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CardPaymentSourceOutput", + "description": "The card payment source information", + "fields": [ + { + "name": "brand", + "description": "The brand of the card", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expiry", + "description": "The expiry of the card", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "last_digits", + "description": "The last digits of the card", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VaultConfigOutput", + "description": "Retrieves the vault configuration", + "fields": [ + { + "name": "credit_card", + "description": "Credit card vault method configuration", + "args": [], + "type": { + "kind": "OBJECT", + "name": "VaultCreditCardConfig", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VaultCreditCardConfig", + "description": "", + "fields": [ + { + "name": "is_vault_enabled", + "description": "Is vault enabled", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sdk_params", + "description": "The parameters required to load the Paypal JS SDK", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SDKParams", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "three_ds_mode", + "description": "3DS mode", + "args": [], + "type": { + "kind": "ENUM", + "name": "ThreeDSMode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PaypalExpressTokenInput", + "description": "Defines the attributes required to receive a payment token for Express Checkout and Payments Standard payment methods.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID that identifies the customer's cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "code", + "description": "The payment method code.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "express_button", + "description": "Indicates whether the buyer selected the quick checkout button. The default value is false.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "urls", + "description": "A set of relative URLs that PayPal uses in response to various actions during the authorization process.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PaypalExpressUrlsInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "use_paypal_credit", + "description": "Indicates whether the buyer clicked the PayPal credit button. The default value is false.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaypalExpressToken", + "description": "Deprecated. Use `PaypalExpressTokenOutput` instead.", + "fields": [ + { + "name": "paypal_urls", + "description": "A set of URLs that allow the buyer to authorize payment and adjust checkout details.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PaypalExpressUrlList", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `PaypalExpressTokenOutput.paypal_urls` instead." + }, + { + "name": "token", + "description": "The token returned by PayPal.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `PaypalExpressTokenOutput.token` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaypalExpressTokenOutput", + "description": "Contains the token returned by PayPal and a set of URLs that allow the buyer to authorize payment and adjust checkout details. Applies to Express Checkout and Payments Standard payment methods.", + "fields": [ + { + "name": "paypal_urls", + "description": "A set of URLs that allow the buyer to authorize payment and adjust checkout details.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PaypalExpressUrlList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "token", + "description": "The token returned by PayPal.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PayflowLinkToken", + "description": "Contains information used to generate PayPal iframe for transaction. Applies to Payflow Link and Payments Advanced payment methods.", + "fields": [ + { + "name": "mode", + "description": "The mode for the Payflow transaction.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PayflowLinkMode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paypal_url", + "description": "The PayPal URL used for requesting a Payflow form.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "secure_token", + "description": "The secure token generated by PayPal.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "secure_token_id", + "description": "The secure token ID generated by PayPal.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "HostedProUrl", + "description": "Contains the secure URL used for the Payments Pro Hosted Solution payment method.", + "fields": [ + { + "name": "secure_form_url", + "description": "The secure URL generated by PayPal.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "HostedProUrlInput", + "description": "Contains the required input to request the secure URL for Payments Pro Hosted Solution payment.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID that identifies the shopper's cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "HostedProInput", + "description": "Contains a set of relative URLs that PayPal uses in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Payments Pro Hosted Solution payment method.", + "fields": null, + "inputFields": [ + { + "name": "cancel_url", + "description": "The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. For example, if the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "return_url", + "description": "The relative URL of the final confirmation page that PayPal redirects to upon payment success. For example, if the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PaypalExpressInput", + "description": "Contains required input for Express Checkout and Payments Standard payments.", + "fields": null, + "inputFields": [ + { + "name": "payer_id", + "description": "The unique ID of the PayPal user.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "token", + "description": "The token returned by the `createPaypalExpressToken` mutation.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PayflowExpressInput", + "description": "Contains required input for Payflow Express Checkout payments.", + "fields": null, + "inputFields": [ + { + "name": "payer_id", + "description": "The unique ID of the PayPal user.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "token", + "description": "The token returned by the createPaypalExpressToken mutation.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PaypalExpressUrlsInput", + "description": "Contains a set of relative URLs that PayPal uses in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Express Checkout and Payments Standard payment methods.", + "fields": null, + "inputFields": [ + { + "name": "cancel_url", + "description": "The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. If the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "pending_url", + "description": "The relative URL of the page that PayPal redirects to when the payment has been put on hold for additional review. This condition mostly applies to ACH transactions, and is not applicable to most PayPal solutions. If the full URL to this page is https://www.example.com/paypal/action/success_pending.html, the relative URL is paypal/action/success_pending.html.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "return_url", + "description": "The relative URL of the final confirmation page that PayPal redirects to upon payment success. If the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "success_url", + "description": "The relative URL of the order confirmation page that PayPal redirects to when the payment is successful and additional confirmation is not needed. Not applicable to most PayPal solutions. If the full URL to this page is https://www.example.com/paypal/action/success.html, the relative URL is paypal/action/success.html.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaypalExpressUrlList", + "description": "Contains a set of URLs that allow the buyer to authorize payment and adjust checkout details for Express Checkout and Payments Standard transactions.", + "fields": [ + { + "name": "edit", + "description": "The PayPal URL that allows the buyer to edit their checkout details.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "start", + "description": "The URL to the PayPal login page.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PayflowLinkInput", + "description": "A set of relative URLs that PayPal uses in response to various actions during the authorization process. Adobe Commerce prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Payflow Link and Payments Advanced payment methods.", + "fields": null, + "inputFields": [ + { + "name": "cancel_url", + "description": "The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. If the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "error_url", + "description": "The relative URL of the transaction error page that PayPal redirects to upon payment error. If the full URL to this page is https://www.example.com/paypal/action/error.html, the relative URL is paypal/action/error.html.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "return_url", + "description": "The relative URL of the order confirmation page that PayPal redirects to when the payment is successful and additional confirmation is not needed. If the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PayflowLinkTokenInput", + "description": "Contains information required to fetch payment token information for the Payflow Link and Payments Advanced payment methods.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID that identifies the customer's cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PayflowLinkMode", + "description": "Indicates the mode for payment. Applies to the Payflow Link and Payments Advanced payment methods.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TEST", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LIVE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PayflowProTokenInput", + "description": "Contains input required to fetch payment token information for the Payflow Pro and Payments Pro payment methods.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID that identifies the shopper's cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "urls", + "description": "A set of relative URLs that PayPal uses for callback.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PayflowProUrlInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PayflowProInput", + "description": "Contains input for the Payflow Pro and Payments Pro payment methods.", + "fields": null, + "inputFields": [ + { + "name": "cc_details", + "description": "Required input for credit card related information.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CreditCardDetailsInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "is_active_payment_token_enabler", + "description": "Indicates whether details about the shopper's credit/debit card should be tokenized for later usage. Required only if Vault is enabled for the PayPal Payflow Pro payment integration.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CreditCardDetailsInput", + "description": "Required fields for Payflow Pro and Payments Pro credit card payments.", + "fields": null, + "inputFields": [ + { + "name": "cc_exp_month", + "description": "The credit card expiration month.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "cc_exp_year", + "description": "The credit card expiration year.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "cc_last_4", + "description": "The last 4 digits of the credit card.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "cc_type", + "description": "The credit card type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PayflowProUrlInput", + "description": "Contains a set of relative URLs that PayPal uses in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for the Payflow Pro and Payment Pro payment methods.", + "fields": null, + "inputFields": [ + { + "name": "cancel_url", + "description": "The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. If the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "error_url", + "description": "The relative URL of the transaction error page that PayPal redirects to upon payment error. If the full URL to this page is https://www.example.com/paypal/action/error.html, the relative URL is paypal/action/error.html.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "return_url", + "description": "The relative URL of the final confirmation page that PayPal redirects to upon payment success. If the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PayflowProToken", + "description": "Contains the secure information used to authorize transaction. Applies to Payflow Pro and Payments Pro payment methods.", + "fields": [ + { + "name": "response_message", + "description": "The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "result", + "description": "A non-zero value if any errors occurred.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "result_code", + "description": "The RESULT returned by PayPal. A value of `0` indicates the transaction was approved.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "secure_token", + "description": "A secure token generated by PayPal.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "secure_token_id", + "description": "A secure token ID generated by PayPal.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreatePayflowProTokenOutput", + "description": "Contains the secure information used to authorize transaction. Applies to Payflow Pro and Payments Pro payment methods.", + "fields": [ + { + "name": "response_message", + "description": "The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "result", + "description": "A non-zero value if any errors occurred.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "result_code", + "description": "The RESULT returned by PayPal. A value of `0` indicates the transaction was approved.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "secure_token", + "description": "A secure token generated by PayPal.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "secure_token_id", + "description": "A secure token ID generated by PayPal.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PayflowProResponseInput", + "description": "Input required to complete payment. Applies to Payflow Pro and Payments Pro payment methods.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID that identifies the shopper's cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "paypal_payload", + "description": "The payload returned from PayPal.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PayflowProResponseOutput", + "description": "", + "fields": [ + { + "name": "cart", + "description": "The cart with the updated selected payment method.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "VaultTokenInput", + "description": "Contains required input for payment methods with Vault support.", + "fields": null, + "inputFields": [ + { + "name": "public_hash", + "description": "The public hash of the payment token.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AddPurchaseOrderCommentInput", + "description": "Contains the comment to be added to a purchase order.", + "fields": null, + "inputFields": [ + { + "name": "comment", + "description": "Comment text.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "purchase_order_uid", + "description": "The unique ID of a purchase order.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AddPurchaseOrderCommentOutput", + "description": "Contains the successfully added comment.", + "fields": [ + { + "name": "comment", + "description": "The purchase order comment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PurchaseOrderComment", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PurchaseOrder", + "description": "Contains details about a purchase order.", + "fields": [ + { + "name": "approval_flow", + "description": "The approval flows for each applied rules.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PurchaseOrderRuleApprovalFlow", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "available_actions", + "description": "Purchase order actions available to the customer. Can be used to display action buttons on the client.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PurchaseOrderAction", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "comments", + "description": "The set of comments applied to the purchase order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PurchaseOrderComment", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "The date the purchase order was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_by", + "description": "The company user who created the purchase order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "history_log", + "description": "The log of the events related to the purchase order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PurchaseOrderHistoryItem", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "number", + "description": "The purchase order number.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "The reference to the order placed based on the purchase order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quote", + "description": "The quote related to the purchase order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The current status of the purchase order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PurchaseOrderStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "A unique identifier for the purchase order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "The date the purchase order was last updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PurchaseOrdersActionInput", + "description": "Defines which purchase orders to act on.", + "fields": null, + "inputFields": [ + { + "name": "purchase_order_uids", + "description": "An array of purchase order UIDs.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PurchaseOrdersActionOutput", + "description": "Returns a list of updated purchase orders and any error messages.", + "fields": [ + { + "name": "errors", + "description": "An array of error messages encountered while performing the operation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PurchaseOrderActionError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "purchase_orders", + "description": "A list of purchase orders.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PurchaseOrder", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PurchaseOrderActionError", + "description": "Contains details about a failed action.", + "fields": [ + { + "name": "message", + "description": "The returned error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The error type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PurchaseOrderErrorType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PurchaseOrderErrorType", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NOT_FOUND", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OPERATION_NOT_APPLICABLE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COULD_NOT_SAVE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_VALID_DATA", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNDEFINED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PurchaseOrderAction", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "REJECT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCEL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VALIDATE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APPROVE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PLACE_ORDER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PurchaseOrderStatus", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PENDING", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APPROVAL_REQUIRED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APPROVED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDER_IN_PROGRESS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDER_PLACED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDER_FAILED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REJECTED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCELED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APPROVED_PENDING_PAYMENT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PurchaseOrderComment", + "description": "Contains details about a comment.", + "fields": [ + { + "name": "author", + "description": "The user who left the comment.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "The date and time when the comment was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "text", + "description": "The text of the comment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "A unique identifier of the comment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PurchaseOrderHistoryItem", + "description": "Contains details about a status change.", + "fields": [ + { + "name": "activity", + "description": "The activity type of the event.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "The date and time when the event happened.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The message representation of the event.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "A unique identifier of the purchase order history item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PurchaseOrdersFilterInput", + "description": "Defines the criteria to use to filter the list of purchase orders.", + "fields": null, + "inputFields": [ + { + "name": "company_purchase_orders", + "description": "Include only purchase orders made by subordinate company users.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "created_date", + "description": "Filter by the creation date of the purchase order.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterRangeTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "require_my_approval", + "description": "Include only purchase orders that are waiting for the customer’s approval.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "status", + "description": "Filter by the status of the purchase order.", + "type": { + "kind": "ENUM", + "name": "PurchaseOrderStatus", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PurchaseOrders", + "description": "Contains a list of purchase orders.", + "fields": [ + { + "name": "items", + "description": "Purchase orders matching the search criteria.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PurchaseOrder", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Page information of search result's current page.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "Total number of purchase orders found matching the search criteria.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PlacePurchaseOrderInput", + "description": "Specifies the quote to be converted to a purchase order.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The unique ID of a `Cart` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PlaceOrderForPurchaseOrderInput", + "description": "Specifies the purchase order to convert to an order.", + "fields": null, + "inputFields": [ + { + "name": "purchase_order_uid", + "description": "The unique ID of a purchase order.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PlacePurchaseOrderOutput", + "description": "Contains the results of the request to place a purchase order.", + "fields": [ + { + "name": "purchase_order", + "description": "Placed purchase order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PurchaseOrder", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PlaceOrderForPurchaseOrderOutput", + "description": "Contains the results of the request to place an order.", + "fields": [ + { + "name": "order", + "description": "Placed order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerOrder", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AddPurchaseOrderItemsToCartInput", + "description": "Defines the purchase order and cart to act on.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The ID to assign to the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "purchase_order_uid", + "description": "Purchase order unique ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "replace_existing_cart_items", + "description": "Replace existing cart or merge items.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "UpdatePurchaseOrderApprovalRuleInput", + "description": "Defines the changes to be made to an approval rule.", + "fields": null, + "inputFields": [ + { + "name": "applies_to", + "description": "An updated list of company user role IDs to which this purchase order approval rule should be applied. When an empty array is provided, the rule is applied to all user roles in the system, including those created in the future.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "approvers", + "description": "An updated list of B2B user roles that can approve this purchase order approval rule.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "condition", + "description": "The updated condition of the purchase order approval rule.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CreatePurchaseOrderApprovalRuleConditionInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "description", + "description": "The updated approval rule description.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The updated approval rule name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "status", + "description": "The updated status of the purchase order approval rule.", + "type": { + "kind": "ENUM", + "name": "PurchaseOrderApprovalRuleStatus", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "uid", + "description": "Unique identifier for the purchase order approval rule.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PurchaseOrderApprovalRuleInput", + "description": "Defines a new purchase order approval rule.", + "fields": null, + "inputFields": [ + { + "name": "applies_to", + "description": "A list of company user role IDs to which this purchase order approval rule should be applied. When an empty array is provided, the rule is applied to all user roles in the system, including those created in the future.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "approvers", + "description": "A list of B2B user roles that can approve this purchase order approval rule.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "condition", + "description": "The condition of the purchase order approval rule.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CreatePurchaseOrderApprovalRuleConditionInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "description", + "description": "A summary of the purpose of the purchase order approval rule.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The purchase order approval rule name.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "status", + "description": "The status of the purchase order approval rule.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PurchaseOrderApprovalRuleStatus", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CreatePurchaseOrderApprovalRuleConditionInput", + "description": "Defines a set of conditions that apply to a rule.", + "fields": null, + "inputFields": [ + { + "name": "amount", + "description": "The amount to be compared in a purchase order approval rule. This field is mutually exclusive with condition quantity.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CreatePurchaseOrderApprovalRuleConditionAmountInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "attribute", + "description": "The type of approval rule.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PurchaseOrderApprovalRuleType", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "operator", + "description": "Defines how to evaluate an amount or quantity in a purchase order.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PurchaseOrderApprovalRuleConditionOperator", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CreatePurchaseOrderApprovalRuleConditionAmountInput", + "description": "Specifies the amount and currency to evaluate.", + "fields": null, + "inputFields": [ + { + "name": "currency", + "description": "Purchase order approval rule condition amount currency.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyEnum", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "Purchase order approval rule condition amount value.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PurchaseOrderApprovalRuleMetadata", + "description": "Contains metadata that can be used to render rule edit forms.", + "fields": [ + { + "name": "available_applies_to", + "description": "A list of B2B user roles that the rule can be applied to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyRole", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "available_condition_currencies", + "description": "A list of currencies that can be used to create approval rules based on amounts, for example shipping cost rules.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AvailableCurrency", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "available_requires_approval_from", + "description": "A list of B2B user roles that can be specified as approvers for the approval rules.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyRole", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AvailableCurrency", + "description": "Defines the code and symbol of a currency that can be used for purchase orders.", + "fields": [ + { + "name": "code", + "description": "3-letter currency code, for example USD.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyEnum", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "symbol", + "description": "Currency symbol, for example $.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PurchaseOrderApprovalRules", + "description": "Contains the approval rules that the customer can see.", + "fields": [ + { + "name": "items", + "description": "A list of purchase order approval rules visible to the customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PurchaseOrderApprovalRule", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Result pagination details.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The total number of purchase order approval rules visible to the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PurchaseOrderApprovalRule", + "description": "Contains details about a purchase order approval rule.", + "fields": [ + { + "name": "applies_to_roles", + "description": "The name of the user(s) affected by the the purchase order approval rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyRole", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "approver_roles", + "description": "The name of the user who needs to approve purchase orders that trigger the approval rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyRole", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "condition", + "description": "Condition which triggers the approval rule.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "PurchaseOrderApprovalRuleConditionInterface", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "The date the purchase order rule was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_by", + "description": "The name of the user who created the purchase order approval rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "Description of the purchase order approval rule.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the purchase order approval rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the purchase order approval rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PurchaseOrderApprovalRuleStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique identifier for the purchase order approval rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "The date the purchase order rule was last updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "PurchaseOrderApprovalRuleConditionInterface", + "description": "Purchase order rule condition details.", + "fields": [ + { + "name": "attribute", + "description": "The type of purchase order approval rule.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PurchaseOrderApprovalRuleType", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "operator", + "description": "The operator to be used for evaluating the approval rule condition.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PurchaseOrderApprovalRuleConditionOperator", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "PurchaseOrderApprovalRuleConditionAmount", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PurchaseOrderApprovalRuleConditionQuantity", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "PurchaseOrderApprovalRuleConditionAmount", + "description": "Contains approval rule condition details, including the amount to be evaluated.", + "fields": [ + { + "name": "amount", + "description": "The amount to be be used for evaluation of the approval rule condition.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attribute", + "description": "The type of purchase order approval rule.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PurchaseOrderApprovalRuleType", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "operator", + "description": "The operator to be used for evaluating the approval rule condition.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PurchaseOrderApprovalRuleConditionOperator", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "PurchaseOrderApprovalRuleConditionInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PurchaseOrderApprovalRuleConditionQuantity", + "description": "Contains approval rule condition details, including the quantity to be evaluated.", + "fields": [ + { + "name": "attribute", + "description": "The type of purchase order approval rule.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PurchaseOrderApprovalRuleType", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "operator", + "description": "The operator to be used for evaluating the approval rule condition.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PurchaseOrderApprovalRuleConditionOperator", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity to be used for evaluation of the approval rule condition.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "PurchaseOrderApprovalRuleConditionInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PurchaseOrderApprovalRuleConditionOperator", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "MORE_THAN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MORE_THAN_OR_EQUAL_TO", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN_OR_EQUAL_TO", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PurchaseOrderApprovalRuleStatus", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ENABLED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISABLED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PurchaseOrderApprovalRuleType", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "GRAND_TOTAL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING_INCL_TAX", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NUMBER_OF_SKUS", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PurchaseOrderRuleApprovalFlow", + "description": "Contains details about approval roles applied to the purchase order and status changes.", + "fields": [ + { + "name": "events", + "description": "The approval flow event related to the rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PurchaseOrderApprovalFlowEvent", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rule_name", + "description": "The name of the applied rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PurchaseOrderApprovalFlowEvent", + "description": "Contains details about a single event in the approval flow of the purchase order.", + "fields": [ + { + "name": "message", + "description": "A formatted message.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The approver name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "role", + "description": "The approver role.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status related to the event.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PurchaseOrderApprovalFlowItemStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "The date and time the event was updated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PurchaseOrderApprovalFlowItemStatus", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PENDING", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APPROVED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REJECTED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ValidatePurchaseOrdersInput", + "description": "Defines the purchase orders to be validated.", + "fields": null, + "inputFields": [ + { + "name": "purchase_order_uids", + "description": "An array of the purchase order IDs.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ValidatePurchaseOrdersOutput", + "description": "Contains the results of validation attempts.", + "fields": [ + { + "name": "errors", + "description": "An array of error messages encountered while performing the operation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ValidatePurchaseOrderError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "purchase_orders", + "description": "An array of the purchase orders in the request.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PurchaseOrder", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ValidatePurchaseOrderError", + "description": "Contains details about a failed validation attempt.", + "fields": [ + { + "name": "message", + "description": "The returned error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "Error type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ValidatePurchaseOrderErrorType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ValidatePurchaseOrderErrorType", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NOT_FOUND", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OPERATION_NOT_APPLICABLE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COULD_NOT_SAVE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_VALID_DATA", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNDEFINED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DeletePurchaseOrderApprovalRuleInput", + "description": "Specifies the IDs of the approval rules to delete.", + "fields": null, + "inputFields": [ + { + "name": "approval_rule_uids", + "description": "An array of purchase order approval rule IDs.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeletePurchaseOrderApprovalRuleOutput", + "description": "Contains any errors encountered while attempting to delete approval rules.", + "fields": [ + { + "name": "errors", + "description": "An array of error messages encountered while performing the operation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeletePurchaseOrderApprovalRuleError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeletePurchaseOrderApprovalRuleError", + "description": "Contains details about an error that occurred when deleting an approval rule .", + "fields": [ + { + "name": "message", + "description": "The text of the error message.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The error type.", + "args": [], + "type": { + "kind": "ENUM", + "name": "DeletePurchaseOrderApprovalRuleErrorType", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DeletePurchaseOrderApprovalRuleErrorType", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNDEFINED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_FOUND", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ClearCartInput", + "description": "Assigns a specific `cart_id` to the empty cart.", + "fields": null, + "inputFields": [ + { + "name": "uid", + "description": "The unique ID of a `Cart` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ClearCartOutput", + "description": "Output of the request to clear the customer cart.", + "fields": [ + { + "name": "cart", + "description": "The cart after clear cart items.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errors", + "description": "An array of errors encountered while clearing the cart item", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ClearCartError", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ClearCartError", + "description": "Contains details about errors encountered when a customer clear cart.", + "fields": [ + { + "name": "message", + "description": "A localized error message", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "A cart-specific error type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ClearCartErrorType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ClearCartErrorType", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NOT_FOUND", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNAUTHORISED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INACTIVE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNDEFINED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ReCaptchaFormEnum", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PLACE_ORDER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONTACT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_LOGIN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_FORGOT_PASSWORD", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_CREATE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_EDIT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NEWSLETTER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_REVIEW", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SENDFRIEND", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BRAINTREE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RESEND_CONFIRMATION_EMAIL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ReCaptchaTypeEmum", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVISIBLE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RECAPTCHA", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RECAPTCHA_V3", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReCaptchaConfigOutput", + "description": "", + "fields": [ + { + "name": "configurations", + "description": "Configuration details for reCaptcha type", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ReCaptchaConfiguration", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_enabled", + "description": "Indicates whether reCaptcha type is enabled", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReCaptchaConfiguration", + "description": "Contains reCAPTCHA form configuration details.", + "fields": [ + { + "name": "badge_position", + "description": "The position of the invisible reCAPTCHA badge on each page.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "language_code", + "description": "A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minimum_score", + "description": "The minimum score that identifies a user interaction as a potential risk.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "re_captcha_type", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ReCaptchaTypeEmum", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "technical_failure_message", + "description": "The message that appears when reCaptcha fails.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "theme", + "description": "Theme to be used to render reCaptcha.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "validation_failure_message", + "description": "The message that appears to the user if validation fails.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "website_key", + "description": "The website key generated when the Google reCAPTCHA account was registered.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReCaptchaConfigurationV3", + "description": "Contains reCAPTCHA V3-Invisible configuration details.", + "fields": [ + { + "name": "badge_position", + "description": "The position of the invisible reCAPTCHA badge on each page.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "failure_message", + "description": "The message that appears to the user if validation fails.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "forms", + "description": "A list of forms on the storefront that have been configured to use reCAPTCHA V3.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ReCaptchaFormEnum", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_enabled", + "description": "Return whether recaptcha is enabled or not", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "language_code", + "description": "A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minimum_score", + "description": "The minimum score that identifies a user interaction as a potential risk.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "theme", + "description": "Theme to be used to render reCaptcha.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "website_key", + "description": "The website key generated when the Google reCAPTCHA account was registered.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ConfigurableRequisitionListItem", + "description": "Contains details about configurable products added to a requisition list.", + "fields": [ + { + "name": "configurable_options", + "description": "Selected configurable options for an item in the requisition list.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedConfigurableOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizable_options", + "description": "Selected custom options for an item in the requisition list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Details about a requisition list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of the product added to the requisition list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID of an item in a requisition list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "RequisitionListItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductReviews", + "description": "Contains an array of product reviews.", + "fields": [ + { + "name": "items", + "description": "An array of product reviews.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReview", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Metadata for pagination rendering.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductReview", + "description": "Contains details of a product review.", + "fields": [ + { + "name": "average_rating", + "description": "The average of all ratings for this product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "The date the review was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nickname", + "description": "The customer's nickname. Defaults to the customer name, if logged in.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "The reviewed product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ratings_breakdown", + "description": "An array of ratings by rating category, such as quality, price, and value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviewRating", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "summary", + "description": "The summary (title) of the review.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "text", + "description": "The review text.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductReviewRating", + "description": "Contains data about a single aspect of a product review.", + "fields": [ + { + "name": "name", + "description": "The label assigned to an aspect of a product that is being rated, such as quality or price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The rating value given by customer. By default, possible values range from 1 to 5.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductReviewRatingsMetadata", + "description": "Contains an array of metadata about each aspect of a product review.", + "fields": [ + { + "name": "items", + "description": "An array of product reviews sorted by position.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviewRatingMetadata", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductReviewRatingMetadata", + "description": "Contains details about a single aspect of a product review.", + "fields": [ + { + "name": "id", + "description": "An encoded rating ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The label assigned to an aspect of a product that is being rated, such as quality or price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "values", + "description": "List of product review ratings sorted by position.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReviewRatingValueMetadata", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductReviewRatingValueMetadata", + "description": "Contains details about a single value in a product review.", + "fields": [ + { + "name": "value", + "description": "A ratings scale, such as the number of stars awarded.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value_id", + "description": "An encoded rating value ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateProductReviewOutput", + "description": "Contains the completed product review.", + "fields": [ + { + "name": "review", + "description": "Product review details.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductReview", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CreateProductReviewInput", + "description": "Defines a new product review.", + "fields": null, + "inputFields": [ + { + "name": "nickname", + "description": "The customer's nickname. Defaults to the customer name, if logged in.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "ratings", + "description": "The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductReviewRatingInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "sku", + "description": "The SKU of the reviewed product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "summary", + "description": "The summary (title) of the review.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "text", + "description": "The review text.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductReviewRatingInput", + "description": "Contains the reviewer's rating for a single aspect of a review.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "An encoded rating ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value_id", + "description": "An encoded rating value ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RewardPoints", + "description": "Contains details about a customer's reward points.", + "fields": [ + { + "name": "balance", + "description": "The current balance of reward points.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RewardPointsAmount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "balance_history", + "description": "The balance history of reward points. If the ability for customers to view the balance history has been disabled in the Admin, this field will be set to null.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "RewardPointsBalanceHistoryItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "exchange_rates", + "description": "The current exchange rates for reward points.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RewardPointsExchangeRates", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscription_status", + "description": "The subscription status of emails related to reward points.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RewardPointsSubscriptionStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RewardPointsAmount", + "description": "", + "fields": [ + { + "name": "money", + "description": "The reward points amount in store currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "points", + "description": "The reward points amount in points.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RewardPointsExchangeRates", + "description": "Lists the reward points exchange rates. The values depend on the customer group.", + "fields": [ + { + "name": "earning", + "description": "How many points are earned for a given amount spent.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RewardPointsRate", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "redemption", + "description": "How many points must be redeemed to get a given amount of currency discount at the checkout.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RewardPointsRate", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RewardPointsRate", + "description": "Contains details about customer's reward points rate.", + "fields": [ + { + "name": "currency_amount", + "description": "The money value for the exchange rate. For earnings, this is the amount spent to earn the specified points. For redemption, this is the amount of money the number of points represents.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "points", + "description": "The number of points for an exchange rate. For earnings, this is the number of points earned. For redemption, this is the number of points needed for redemption.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RewardPointsSubscriptionStatus", + "description": "Indicates whether the customer subscribes to reward points emails.", + "fields": [ + { + "name": "balance_updates", + "description": "Indicates whether the customer subscribes to 'Reward points balance updates' emails.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "RewardPointsSubscriptionStatusesEnum", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "points_expiration_notifications", + "description": "Indicates whether the customer subscribes to 'Reward points expiration notifications' emails.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "RewardPointsSubscriptionStatusesEnum", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "RewardPointsSubscriptionStatusesEnum", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SUBSCRIBED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_SUBSCRIBED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RewardPointsBalanceHistoryItem", + "description": "Contain details about the reward points transaction.", + "fields": [ + { + "name": "balance", + "description": "The award points balance after the completion of the transaction.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RewardPointsAmount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "change_reason", + "description": "The reason the balance changed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "date", + "description": "The date of the transaction.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "points_change", + "description": "The number of points added or deducted in the transaction.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ApplyRewardPointsToCartOutput", + "description": "Contains the customer cart.", + "fields": [ + { + "name": "cart", + "description": "The customer cart after reward points are applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RemoveRewardPointsFromCartOutput", + "description": "Contains the customer cart.", + "fields": [ + { + "name": "cart", + "description": "The customer cart after reward points are removed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RequestGuestReturnInput", + "description": "Contains information needed to start a return request.", + "fields": null, + "inputFields": [ + { + "name": "comment_text", + "description": "Text the buyer entered that describes the reason for the refund request.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "contact_email", + "description": "The email address the buyer enters to receive notifications about the status of the return.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "items", + "description": "An array of items to be returned.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RequestReturnItemInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "token", + "description": "Order token.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RequestReturnInput", + "description": "Contains information needed to start a return request.", + "fields": null, + "inputFields": [ + { + "name": "comment_text", + "description": "Text the buyer entered that describes the reason for the refund request.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "contact_email", + "description": "The email address the buyer enters to receive notifications about the status of the return.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "items", + "description": "An array of items to be returned.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RequestReturnItemInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "order_uid", + "description": "The unique ID for a `Order` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RequestReturnItemInput", + "description": "Contains details about an item to be returned.", + "fields": null, + "inputFields": [ + { + "name": "entered_custom_attributes", + "description": "Details about a custom attribute that was entered.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "EnteredCustomAttributeInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "order_item_uid", + "description": "The unique ID for a `OrderItemInterface` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity_to_return", + "description": "The quantity of the item to be returned.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "selected_custom_attributes", + "description": "An array of selected custom option IDs associated with the item to be returned. For example, the IDs for the selected color and size of a configurable product.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SelectedCustomAttributeInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "EnteredCustomAttributeInput", + "description": "Contains details about a custom text attribute that the buyer entered.", + "fields": null, + "inputFields": [ + { + "name": "attribute_code", + "description": "A string that identifies the entered custom attribute.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The text or other entered value.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SelectedCustomAttributeInput", + "description": "Contains details about an attribute the buyer selected.", + "fields": null, + "inputFields": [ + { + "name": "attribute_code", + "description": "A string that identifies the selected attribute.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The unique ID for a selected custom attribute value.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RequestReturnOutput", + "description": "Contains the response to a return request.", + "fields": [ + { + "name": "return", + "description": "Details about a single return request.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Return", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returns", + "description": "An array of return requests.", + "args": [ + { + "name": "pageSize", + "description": "Specifies the maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "Specifies which page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "OBJECT", + "name": "Returns", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AddReturnCommentInput", + "description": "Defines a return comment.", + "fields": null, + "inputFields": [ + { + "name": "comment_text", + "description": "The text added to the return request.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "return_uid", + "description": "The unique ID for a `Return` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AddReturnCommentOutput", + "description": "Contains details about the return request.", + "fields": [ + { + "name": "return", + "description": "The modified return.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Return", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AddReturnTrackingInput", + "description": "Defines tracking information to be added to the return.", + "fields": null, + "inputFields": [ + { + "name": "carrier_uid", + "description": "The unique ID for a `ReturnShippingCarrier` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "return_uid", + "description": "The unique ID for a `Returns` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "tracking_number", + "description": "The shipping tracking number for this return request.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AddReturnTrackingOutput", + "description": "Contains the response after adding tracking information.", + "fields": [ + { + "name": "return", + "description": "Details about the modified return.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Return", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "return_shipping_tracking", + "description": "Details about shipping for a return.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ReturnShippingTracking", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RemoveReturnTrackingInput", + "description": "Defines the tracking information to delete.", + "fields": null, + "inputFields": [ + { + "name": "return_shipping_tracking_uid", + "description": "The unique ID for a `ReturnShippingTracking` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RemoveReturnTrackingOutput", + "description": "Contains the response after deleting tracking information.", + "fields": [ + { + "name": "return", + "description": "Contains details about the modified return.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Return", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Returns", + "description": "Contains a list of customer return requests.", + "fields": [ + { + "name": "items", + "description": "A list of return requests.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Return", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Pagination metadata.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The total number of return requests.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Return", + "description": "Contains details about a return.", + "fields": [ + { + "name": "available_shipping_carriers", + "description": "A list of shipping carriers available for returns.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnShippingCarrier", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "comments", + "description": "A list of comments posted for the return request.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnComment", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "The date the return was requested.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer", + "description": "Data from the customer who created the return request.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnCustomer", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "A list of items being returned.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "number", + "description": "A human-readable return number.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "The order associated with the return.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shipping", + "description": "Shipping information for the return.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ReturnShipping", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the return request.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ReturnStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `Return` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnCustomer", + "description": "The customer information for the return.", + "fields": [ + { + "name": "email", + "description": "The email address of the customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstname", + "description": "The first name of the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastname", + "description": "The last name of the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnItem", + "description": "Contains details about a product being returned.", + "fields": [ + { + "name": "custom_attributes", + "description": "Return item custom attributes that are visible on the storefront.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnCustomAttribute", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use custom_attributesV2 instead." + }, + { + "name": "custom_attributesV2", + "description": "Custom attributes that are visible on the storefront.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_item", + "description": "Provides access to the product being returned, including information about selected and entered options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "OrderItemInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of the item the merchant authorized to be returned.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "request_quantity", + "description": "The quantity of the item requested to be returned.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The return status of the item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ReturnItemStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `ReturnItem` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnItemAttributeMetadata", + "description": "Return Item attribute metadata.", + "fields": [ + { + "name": "code", + "description": "The unique identifier for an attribute code. This value should be in lowercase letters without spaces.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "default_value", + "description": "Default attribute value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "entity_type", + "description": "The type of entity that defines the attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AttributeEntityTypeEnum", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "frontend_class", + "description": "The frontend class of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "frontend_input", + "description": "The frontend input type of the attribute.", + "args": [], + "type": { + "kind": "ENUM", + "name": "AttributeFrontendInputEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "input_filter", + "description": "The template used for the input of the attribute (e.g., 'date').", + "args": [], + "type": { + "kind": "ENUM", + "name": "InputFilterEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_required", + "description": "Whether the attribute value is required.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_unique", + "description": "Whether the attribute value must be unique.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The label assigned to the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "multiline_count", + "description": "The number of lines of the attribute value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "Attribute options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CustomAttributeOptionInterface", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The position of the attribute in the form.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "validate_rules", + "description": "The validation rules of the attribute value.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ValidationRule", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CustomAttributeMetadataInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnCustomAttribute", + "description": "Contains details about a `ReturnCustomerAttribute` object.", + "fields": [ + { + "name": "label", + "description": "A description of the attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `ReturnCustomAttribute` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "A JSON-encoded value of the attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnComment", + "description": "Contains details about a return comment.", + "fields": [ + { + "name": "author_name", + "description": "The name or author who posted the comment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "The date and time the comment was posted.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "text", + "description": "The contents of the comment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `ReturnComment` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnShipping", + "description": "Contains details about the return shipping address.", + "fields": [ + { + "name": "address", + "description": "The merchant-defined return shipping address.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ReturnShippingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tracking", + "description": "The unique ID for a `ReturnShippingTracking` object. If a single UID is specified, the array contains a single tracking record. Otherwise, array contains all tracking information.", + "args": [ + { + "name": "uid", + "description": "", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnShippingTracking", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnShippingCarrier", + "description": "Contains details about the carrier on a return.", + "fields": [ + { + "name": "label", + "description": "A description of the shipping carrier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnShippingTracking", + "description": "Contains shipping and tracking details.", + "fields": [ + { + "name": "carrier", + "description": "Contains details of a shipping carrier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnShippingCarrier", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "Details about the status of a shipment.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ReturnShippingTrackingStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tracking_number", + "description": "A tracking number assigned by the carrier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for a `ReturnShippingTracking` object assigned to the tracking item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnShippingTrackingStatus", + "description": "Contains the status of a shipment.", + "fields": [ + { + "name": "text", + "description": "Text that describes the status.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "Indicates whether the status type is informational or an error.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ReturnShippingTrackingStatusType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ReturnShippingTrackingStatusType", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INFORMATION", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ERROR", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnShippingAddress", + "description": "Contains details about the shipping address used for receiving returned items.", + "fields": [ + { + "name": "city", + "description": "The city for product returns.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "contact_name", + "description": "The merchant's contact person.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "An object that defines the country for product returns.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Country", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "postcode", + "description": "The postal code for product returns.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "region", + "description": "An object that defines the state or province for product returns.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Region", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "street", + "description": "The street address for product returns.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "telephone", + "description": "The telephone number for product returns.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ReturnStatus", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PENDING", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNCONFIRMED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AUTHORIZED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PARTIALLY_AUTHORIZED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RECEIVED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PARTIALLY_RECEIVED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APPROVED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PARTIALLY_APPROVED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REJECTED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PARTIALLY_REJECTED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DENIED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PROCESSED_AND_CLOSED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CLOSED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ReturnItemStatus", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PENDING", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AUTHORIZED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RECEIVED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APPROVED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REJECTED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DENIED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ConfirmReturnInput", + "description": "", + "fields": null, + "inputFields": [ + { + "name": "confirmation_key", + "description": "Confirmation Key to return order.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "order_id", + "description": "The unique ID of an `Order` type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "WishlistVisibilityEnum", + "description": "Defines the wish list visibility types.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PUBLIC", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRIVATE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreateWishlistOutput", + "description": "Contains the wish list.", + "fields": [ + { + "name": "wishlist", + "description": "The newly-created wish list", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Wishlist", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeleteWishlistOutput", + "description": "Contains the status of the request to delete a wish list and an array of the customer's remaining wish lists.", + "fields": [ + { + "name": "status", + "description": "Indicates whether the wish list was deleted.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "wishlists", + "description": "A list of undeleted wish lists.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Wishlist", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CopyProductsBetweenWishlistsOutput", + "description": "Contains the source and target wish lists after copying products.", + "fields": [ + { + "name": "destination_wishlist", + "description": "The destination wish list containing the copied products.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Wishlist", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "source_wishlist", + "description": "The wish list that the products were copied from.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Wishlist", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "user_errors", + "description": "An array of errors encountered while copying products in a wish list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "WishListUserInputError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "WishlistItemCopyInput", + "description": "Specifies the IDs of items to copy and their quantities.", + "fields": null, + "inputFields": [ + { + "name": "quantity", + "description": "The quantity of this item to copy to the destination wish list. This value can't be greater than the quantity in the source wish list.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "wishlist_item_id", + "description": "The unique ID of the `WishlistItemInterface` object to be copied.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "WishlistItemMoveInput", + "description": "Specifies the IDs of the items to move and their quantities.", + "fields": null, + "inputFields": [ + { + "name": "quantity", + "description": "The quantity of this item to move to the destination wish list. This value can't be greater than the quantity in the source wish list.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "wishlist_item_id", + "description": "The unique ID of the `WishlistItemInterface` object to be moved.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CreateWishlistInput", + "description": "Defines the name and visibility of a new wish list.", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "The name of the new wish list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "visibility", + "description": "Indicates whether the wish list is public or private.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "WishlistVisibilityEnum", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UpdateWishlistOutput", + "description": "Contains the name and visibility of an updated wish list.", + "fields": [ + { + "name": "name", + "description": "The wish list name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID of a `Wishlist` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "visibility", + "description": "Indicates whether the wish list is public or private.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "WishlistVisibilityEnum", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MoveProductsBetweenWishlistsOutput", + "description": "Contains the source and target wish lists after moving products.", + "fields": [ + { + "name": "destination_wishlist", + "description": "The destination wish list after receiving products moved from the source wish list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Wishlist", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "source_wishlist", + "description": "The source wish list after moving products from it.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Wishlist", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "user_errors", + "description": "An array of errors encountered while moving products to a wish list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "WishListUserInputError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DynamicBlock", + "description": "Contains a single dynamic block.", + "fields": [ + { + "name": "content", + "description": "The renderable HTML code of the dynamic block.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ComplexTextValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID of a `DynamicBlock` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DynamicBlocks", + "description": "Contains an array of dynamic blocks.", + "fields": [ + { + "name": "items", + "description": "An array containing individual dynamic blocks.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DynamicBlock", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Metadata for pagination rendering.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The number of returned dynamic blocks.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DynamicBlocksFilterInput", + "description": "Defines the dynamic block filter. The filter can identify the block type, location and IDs to return.", + "fields": null, + "inputFields": [ + { + "name": "dynamic_block_uids", + "description": "An array of dynamic block UIDs to filter on.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "locations", + "description": "An array indicating the locations the dynamic block can be placed.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DynamicBlockLocationEnum", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "type", + "description": "A value indicating the type of dynamic block to filter on.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DynamicBlockTypeEnum", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DynamicBlockTypeEnum", + "description": "Indicates the selected Dynamic Blocks Rotator inline widget.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SPECIFIED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CART_PRICE_RULE_RELATED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATALOG_PRICE_RULE_RELATED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DynamicBlockLocationEnum", + "description": "Indicates the locations the dynamic block can be placed. If this field is not specified, the query returns all locations.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CONTENT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HEADER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FOOTER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LEFT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RIGHT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartRuleStorefront", + "description": "", + "fields": [ + { + "name": "uid", + "description": "The unique ID for a `CartRule` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SendEmailToFriendInput", + "description": "Defines the referenced product and the email sender and recipients.", + "fields": null, + "inputFields": [ + { + "name": "product_id", + "description": "The ID of the product that the sender is referencing.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "recipients", + "description": "An array containing information about each recipient.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SendEmailToFriendRecipientInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "sender", + "description": "Information about the customer and the content of the message.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SendEmailToFriendSenderInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SendEmailToFriendSenderInput", + "description": "Contains details about the sender.", + "fields": null, + "inputFields": [ + { + "name": "email", + "description": "The email address of the sender.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "message", + "description": "The text of the message to be sent.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The name of the sender.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SendEmailToFriendRecipientInput", + "description": "Contains details about a recipient.", + "fields": null, + "inputFields": [ + { + "name": "email", + "description": "The email address of the recipient.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The name of the recipient.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SendEmailToFriendOutput", + "description": "Contains information about the sender and recipients.", + "fields": [ + { + "name": "recipients", + "description": "An array containing information about each recipient.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SendEmailToFriendRecipient", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sender", + "description": "Information about the customer and the content of the message.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SendEmailToFriendSender", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SendEmailToFriendSender", + "description": "An output object that contains information about the sender.", + "fields": [ + { + "name": "email", + "description": "The email address of the sender.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The text of the message to be sent.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the sender.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SendEmailToFriendRecipient", + "description": "An output object that contains information about the recipient.", + "fields": [ + { + "name": "email", + "description": "The email address of the recipient.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the recipient.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SendFriendConfiguration", + "description": "Contains details about the configuration of the Email to a Friend feature.", + "fields": [ + { + "name": "enabled_for_customers", + "description": "Indicates whether the Email to a Friend feature is enabled.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "enabled_for_guests", + "description": "Indicates whether the Email to a Friend feature is enabled for guests.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ExchangeExternalCustomerTokenInput", + "description": "Contains details about external customer.", + "fields": null, + "inputFields": [ + { + "name": "customer", + "description": "An input object that defines the customer characteristics to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ExchangeExternalCustomerTokenOutput", + "description": "Contains customer token for external customer.", + "fields": [ + { + "name": "customer", + "description": "Return detailed information about a customer account.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "token", + "description": "The customer authorization token.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "SwatchLayerFilterItemInterface", + "description": "", + "fields": [ + { + "name": "swatch_data", + "description": "Data required to render a swatch filter item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SwatchData", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SwatchLayerFilterItem", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "SwatchLayerFilterItem", + "description": "", + "fields": [ + { + "name": "items_count", + "description": "The count of items per filter.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `AggregationOption.count` instead." + }, + { + "name": "label", + "description": "The label for a filter.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `AggregationOption.label` instead." + }, + { + "name": "swatch_data", + "description": "Data required to render a swatch filter item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SwatchData", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value_string", + "description": "The value of a filter request variable to be used in query.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `AggregationOption.value` instead." + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "LayerFilterItemInterface", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "SwatchLayerFilterItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SwatchData", + "description": "Describes the swatch type and a value.", + "fields": [ + { + "name": "type", + "description": "The type of swatch filter item: 1 - text; 2 - image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value for the swatch item. It could be text or an image link.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "SwatchDataInterface", + "description": "", + "fields": [ + { + "name": "value", + "description": "The value can be represented as color (HEX code), image link, or text.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "ImageSwatchData", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "TextSwatchData", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ColorSwatchData", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "ImageSwatchData", + "description": "", + "fields": [ + { + "name": "thumbnail", + "description": "The URL assigned to the thumbnail of the swatch image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value can be represented as color (HEX code), image link, or text.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "SwatchDataInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TextSwatchData", + "description": "", + "fields": [ + { + "name": "value", + "description": "The value can be represented as color (HEX code), image link, or text.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "SwatchDataInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ColorSwatchData", + "description": "", + "fields": [ + { + "name": "value", + "description": "The value can be represented as color (HEX code), image link, or text.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "SwatchDataInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SwatchInputTypeEnum", + "description": "Swatch attribute metadata input types.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BOOLEAN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DATE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DATETIME", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DROPDOWN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FILE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GALLERY", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HIDDEN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IMAGE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MEDIA_IMAGE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MULTILINE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MULTISELECT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELECT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TEXT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TEXTAREA", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNDEFINED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VISUAL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WEIGHT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "TaxWrappingEnum", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DISPLAY_EXCLUDING_TAX", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISPLAY_INCLUDING_TAX", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISPLAY_TYPE_BOTH", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeletePaymentTokenOutput", + "description": "Indicates whether the request succeeded and returns the remaining customer payment tokens.", + "fields": [ + { + "name": "customerPaymentTokens", + "description": "A container for the customer's remaining payment tokens.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentTokens", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "result", + "description": "Indicates whether the request succeeded.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentTokens", + "description": "Contains payment tokens stored in the customer's vault.", + "fields": [ + { + "name": "items", + "description": "An array of payment tokens.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentToken", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentToken", + "description": "The stored payment method available to the customer.", + "fields": [ + { + "name": "details", + "description": "A description of the stored account details.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_method_code", + "description": "The payment method code associated with the token.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "public_hash", + "description": "The public hash of the token.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "Specifies the payment token type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PaymentTokenTypeEnum", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PaymentTokenTypeEnum", + "description": "The list of available payment token types.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "card", + "description": "phpcs:ignore Magento2.GraphQL.ValidArgumentName", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "account", + "description": "phpcs:ignore Magento2.GraphQL.ValidArgumentName", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FixedProductTax", + "description": "A single FPT that can be applied to a product price.", + "fields": [ + { + "name": "amount", + "description": "The amount of the Fixed Product Tax.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "The display label assigned to the Fixed Product Tax.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FixedProductTaxDisplaySettings", + "description": "Lists display settings for the Fixed Product Tax.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INCLUDE_FPT_WITHOUT_DETAILS", + "description": "The displayed price includes the FPT amount without displaying the `ProductPrice.fixed_product_taxes` values. This value corresponds to 'Including FPT only'.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCLUDE_FPT_WITH_DETAILS", + "description": "The displayed price includes the FPT amount while displaying the values of `ProductPrice.fixed_product_taxes` separately. This value corresponds to 'Including FPT and FPT description'.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXCLUDE_FPT_AND_INCLUDE_WITH_DETAILS", + "description": "The displayed price does not include the FPT amount. The values of `ProductPrice.fixed_product_taxes` and the price including the FPT are displayed separately. This value corresponds to 'Excluding FPT, Including FPT description and final price.'", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXCLUDE_FPT_WITHOUT_DETAILS", + "description": "The displayed price does not include the FPT amount. The values from `ProductPrice.fixed_product_taxes` are not displayed. This value corresponds to 'Excluding FPT'.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FPT_DISABLED", + "description": "The FPT feature is not enabled. You can omit `ProductPrice.fixed_product_taxes` from your query.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardRequisitionListItem", + "description": "Contains details about gift cards added to a requisition list.", + "fields": [ + { + "name": "customizable_options", + "description": "Selected custom options for an item in the requisition list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedCustomizableOption", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift_card_options", + "description": "An array that defines gift card properties.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftCardOptions", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Details about a requisition list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The amount added.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID for the requisition list item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "RequisitionListItemInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "BraintreeInput", + "description": "", + "fields": null, + "inputFields": [ + { + "name": "device_data", + "description": "Contains a fingerprint provided by Braintree JS SDK and should be sent with sale transaction details to the Braintree payment gateway.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "is_active_payment_token_enabler", + "description": "States whether the payment details (Credit/Debit Card, PayPal Account) entered by a customer should be tokenized for later usage. Required only if Vault is enabled for the relevant Braintree payment integration.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "payment_method_nonce", + "description": "The one-time payment token generated by Braintree payment gateway based on payment details (Card, PayPal). Required field to make sale transaction.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "BraintreeCcVaultInput", + "description": "", + "fields": null, + "inputFields": [ + { + "name": "device_data", + "description": "", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "public_hash", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "BraintreeVaultInput", + "description": "", + "fields": null, + "inputFields": [ + { + "name": "device_data", + "description": "", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "public_hash", + "description": "", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__Schema", + "description": "A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.", + "fields": [ + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "types", + "description": "A list of all types supported by this server.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "queryType", + "description": "The type that query operations will be rooted at.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mutationType", + "description": "If this server supports mutation, the type that mutation operations will be rooted at.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionType", + "description": "If this server support subscription, the type that subscription operations will be rooted at.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "directives", + "description": "A list of all directives supported by this server.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Directive", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__Type", + "description": "The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum.\n\nDepending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.", + "fields": [ + { + "name": "kind", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "__TypeKind", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fields", + "description": null, + "args": [ + { + "name": "includeDeprecated", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Field", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "interfaces", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "possibleTypes", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "enumValues", + "description": null, + "args": [ + { + "name": "includeDeprecated", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__EnumValue", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inputFields", + "description": null, + "args": [ + { + "name": "includeDeprecated", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__InputValue", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ofType", + "description": null, + "args": [], + "type": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isOneOf", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "__TypeKind", + "description": "An enum describing what kind of type a given `__Type` is.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SCALAR", + "description": "Indicates this type is a scalar.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OBJECT", + "description": "Indicates this type is an object. `fields` and `interfaces` are valid fields.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERFACE", + "description": "Indicates this type is an interface. `fields`, `interfaces`, and `possibleTypes` are valid fields.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNION", + "description": "Indicates this type is a union. `possibleTypes` is a valid field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ENUM", + "description": "Indicates this type is an enum. `enumValues` is a valid field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INPUT_OBJECT", + "description": "Indicates this type is an input object. `inputFields` is a valid field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LIST", + "description": "Indicates this type is a list. `ofType` is a valid field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NON_NULL", + "description": "Indicates this type is a non-null. `ofType` is a valid field.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__Field", + "description": "Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.", + "fields": [ + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "args", + "description": null, + "args": [ + { + "name": "includeDeprecated", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__InputValue", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isDeprecated", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deprecationReason", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__InputValue", + "description": "Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.", + "fields": [ + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "defaultValue", + "description": "A GraphQL-formatted string representing the default value for this input value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isDeprecated", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deprecationReason", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__EnumValue", + "description": "One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.", + "fields": [ + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isDeprecated", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deprecationReason", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__Directive", + "description": "A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.\n\nIn some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.", + "fields": [ + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isRepeatable", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locations", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "__DirectiveLocation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "args", + "description": null, + "args": [ + { + "name": "includeDeprecated", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__InputValue", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "__DirectiveLocation", + "description": "A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "QUERY", + "description": "Location adjacent to a query operation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MUTATION", + "description": "Location adjacent to a mutation operation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIPTION", + "description": "Location adjacent to a subscription operation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FIELD", + "description": "Location adjacent to a field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FRAGMENT_DEFINITION", + "description": "Location adjacent to a fragment definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FRAGMENT_SPREAD", + "description": "Location adjacent to a fragment spread.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INLINE_FRAGMENT", + "description": "Location adjacent to an inline fragment.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIABLE_DEFINITION", + "description": "Location adjacent to a variable definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCHEMA", + "description": "Location adjacent to a schema definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCALAR", + "description": "Location adjacent to a scalar definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OBJECT", + "description": "Location adjacent to an object type definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FIELD_DEFINITION", + "description": "Location adjacent to a field definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ARGUMENT_DEFINITION", + "description": "Location adjacent to an argument definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERFACE", + "description": "Location adjacent to an interface definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNION", + "description": "Location adjacent to a union definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ENUM", + "description": "Location adjacent to an enum definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ENUM_VALUE", + "description": "Location adjacent to an enum value definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INPUT_OBJECT", + "description": "Location adjacent to an input object type definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INPUT_FIELD_DEFINITION", + "description": "Location adjacent to an input object field definition.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + } + ], + "directives": [ + { + "name": "include", + "description": "Directs the executor to include this field or fragment only when the `if` argument is true.", + "locations": [ + "FIELD", + "FRAGMENT_SPREAD", + "INLINE_FRAGMENT" + ], + "args": [ + { + "name": "if", + "description": "Included when true.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + } + ] + }, + { + "name": "skip", + "description": "Directs the executor to skip this field or fragment when the `if` argument is true.", + "locations": [ + "FIELD", + "FRAGMENT_SPREAD", + "INLINE_FRAGMENT" + ], + "args": [ + { + "name": "if", + "description": "Skipped when true.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + } + ] + }, + { + "name": "deprecated", + "description": "Marks an element of a GraphQL schema as no longer supported.", + "locations": [ + "FIELD_DEFINITION", + "ENUM_VALUE", + "ARGUMENT_DEFINITION", + "INPUT_FIELD_DEFINITION" + ], + "args": [ + { + "name": "reason", + "description": "Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted using the Markdown syntax, as specified by [CommonMark](https://commonmark.org/).", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": "\"No longer supported\"" + } + ] + }, + { + "name": "oneOf", + "description": "Indicates that an Input Object is a OneOf Input Object (and thus requires exactly one of its fields be provided).", + "locations": [ + "INPUT_OBJECT" + ], + "args": [] + } + ] + } +} \ No newline at end of file diff --git a/spectaql/schema_saas.json b/spectaql/schema_saas.json index 814e0c334..c5dd1fee3 100644 --- a/spectaql/schema_saas.json +++ b/spectaql/schema_saas.json @@ -1344,6 +1344,45 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "AddProductsToNewCartOutput", + "description": "Contains details about the cart after adding products to it.", + "fields": [ + { + "name": "cart", + "description": "The cart after products have been added.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "user_errors", + "description": "Contains errors encountered while adding an item to the cart.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartUserInputError", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "AddProductsToRequisitionListOutput", @@ -3158,6 +3197,83 @@ ], "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "AttributeFile", + "description": "", + "fields": [ + { + "name": "attribute_type", + "description": "Attribute type code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "The attribute code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "File URL to download the file.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "File code. For file download use `url` field.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "AttributeFilterInput", @@ -3396,6 +3512,83 @@ ], "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "AttributeImage", + "description": "", + "fields": [ + { + "name": "attribute_type", + "description": "Attribute type code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "The attribute code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "Image URL to download the image.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "Image code. For image download use `url` field.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "AttributeInput", @@ -3933,6 +4126,18 @@ "name": "AttributeSelectedOptions", "description": "", "fields": [ + { + "name": "attribute_type", + "description": "Attribute type code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "code", "description": "The attribute code.", @@ -4088,6 +4293,18 @@ "name": "AttributeValue", "description": "", "fields": [ + { + "name": "attribute_type", + "description": "Attribute type code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "code", "description": "The attribute code.", @@ -4186,6 +4403,18 @@ "name": "AttributeValueInterface", "description": "", "fields": [ + { + "name": "attribute_type", + "description": "Attribute type code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "code", "description": "The attribute code.", @@ -4207,6 +4436,16 @@ "interfaces": [], "enumValues": null, "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AttributeFile", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "AttributeImage", + "ofType": null + }, { "kind": "OBJECT", "name": "AttributeSelectedOptions", @@ -4547,6 +4786,16 @@ }, "defaultValue": null }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address to be used for billing.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, { "name": "same_as_shipping", "description": "Indicates whether to set the billing address to be the same as the existing shipping address on the cart.", @@ -4716,6 +4965,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "fax", "description": "The customer's fax number.", @@ -4753,8 +5014,8 @@ "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `customer_address_uid` instead." }, { "name": "lastname", @@ -4866,14 +5127,14 @@ }, { "name": "uid", - "description": "The unique id of the customer address.", + "description": "The unique id of the customer cart address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, @@ -6068,13 +6329,9 @@ "description": "The ProductInterface object, which contains details about the base product", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null }, "isDeprecated": true, "deprecationReason": "Product information is part of a composable Catalog Service." @@ -8472,6 +8729,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "fax", "description": "The customer's fax number.", @@ -8509,8 +8778,8 @@ "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `customer_address_uid` instead." }, { "name": "lastname", @@ -8622,14 +8891,14 @@ }, { "name": "uid", - "description": "The unique id of the customer address.", + "description": "The unique id of the customer cart address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, @@ -10366,6 +10635,77 @@ } ] }, + { + "kind": "OBJECT", + "name": "CategoryImage", + "description": "Represents an image associated with a category.", + "fields": [ + { + "name": "url", + "description": "The URL where the image is hosted.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "A descriptive label or alt text for the image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "roles", + "description": "Standard predefined roles for the image.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customRoles", + "description": "Custom roles specific to the implementation.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "INTERFACE", "name": "CategoryInterface", @@ -10695,6 +11035,207 @@ } ] }, + { + "kind": "OBJECT", + "name": "CategoryMetaTags", + "description": "SEO metadata tags for the category.", + "fields": [ + { + "name": "title", + "description": "The page title for SEO purposes.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The meta description for SEO purposes.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "keywords", + "description": "Keywords associated with the category for SEO.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CategoryNavigationView", + "description": "Represents a category optimized for navigation menus, with nested children for building navigation trees.", + "fields": [ + { + "name": "slug", + "description": "The unique URL-friendly identifier for the category.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The display name of the category.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "children", + "description": "The direct child categories for building nested navigation menus.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CategoryNavigationView", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CategoryViewV2", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CategoryProductView", + "description": "Represents category information associated with a product, including hierarchical parent relationships.", + "fields": [ + { + "name": "name", + "description": "The display name of the category.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "slug", + "description": "The unique URL-friendly identifier for the category.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "level", + "description": "The depth level of the category in the hierarchy (0 for root categories).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parents", + "description": "The ancestor categories in the hierarchy, ordered from root to immediate parent.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CategoryProductView", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CategoryViewV2", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "CategoryTree", @@ -11024,6 +11565,135 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "CategoryTreeView", + "description": "Represents a category within a hierarchical tree structure, including parent and children relationships.", + "fields": [ + { + "name": "slug", + "description": "The unique URL-friendly identifier for the category.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The display name of the category.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "A detailed description of the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metaTags", + "description": "SEO metadata tags for the category.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CategoryMetaTags", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "images", + "description": "Visual images associated with the category.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CategoryImage", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "level", + "description": "The depth level of the category in the tree hierarchy (0 for root categories).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parentSlug", + "description": "The slug of the parent category, if any.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "childrenSlugs", + "description": "The slugs of all direct child categories.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CategoryViewV2", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "CategoryView", @@ -11379,6 +12049,65 @@ } ] }, + { + "kind": "INTERFACE", + "name": "CategoryViewV2", + "description": "Base interface defining essential category fields shared across all category views.", + "fields": [ + { + "name": "slug", + "description": "The unique URL-friendly identifier for the category.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The display name of the category.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CategoryNavigationView", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CategoryProductView", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CategoryTreeView", + "ofType": null + } + ] + }, { "kind": "OBJECT", "name": "CheckoutAgreement", @@ -11916,6 +12645,33 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "CommerceOptimizerContext", + "description": "Commerce Optimizer entities", + "fields": [ + { + "name": "priceBookId", + "description": "The priceBookId for current customer session.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "ENUM", "name": "CompaniesSortFieldEnum", @@ -11993,6 +12749,38 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "available_payment_methods", + "description": "Available payment methods for the company with proper B2B configuration and company-specific filtering.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AvailablePaymentMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "available_shipping_methods", + "description": "Available shipping carriers for the company with proper B2B configuration and company-specific filtering.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyAvailableShippingMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "company_admin", "description": "An object containing information about the company administrator.", @@ -12252,6 +13040,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "status", + "description": "The current status of the company.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CompanyStatusEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "structure", "description": "The company structure of teams and customers in depth-first order.", @@ -12651,6 +13451,49 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "CompanyAvailableShippingMethod", + "description": "Describes a carrier-level shipping option available to the company.", + "fields": [ + { + "name": "code", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "CompanyBasicInfo", @@ -12695,6 +13538,18 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "status", + "description": "The current status of the company.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CompanyStatusEnum", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -12836,6 +13691,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "exceed_limit", + "description": "Indicates whether company credit functionality is allowed to exceed current company credit limit.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "outstanding_balance", "description": "The amount reimbursed, less the total due from all orders placed using the Payment on Account payment method. The amount can be a positive or negative value.", @@ -13663,16 +14534,12 @@ "name": "permissions", "description": "A list of resources the role can access.", "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null } }, "defaultValue": null @@ -13837,6 +14704,41 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "ENUM", + "name": "CompanyStatusEnum", + "description": "Defines the list of company status values.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PENDING", + "description": "Company is pending approval.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APPROVED", + "description": "Company is approved.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REJECTED", + "description": "Company is rejected.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BLOCKED", + "description": "Company is blocked.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "OBJECT", "name": "CompanyStructure", @@ -13997,13 +14899,9 @@ "description": "The unique ID for a `CompanyTeam` object.", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } + "kind": "SCALAR", + "name": "ID", + "ofType": null }, "isDeprecated": false, "deprecationReason": null @@ -14701,6 +15599,45 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "CompleteOrderInput", + "description": "Update the quote and complete the order", + "fields": null, + "inputFields": [ + { + "name": "cartId", + "description": "The customer cart ID", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "id", + "description": "PayPal order ID", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "ComplexProductView", @@ -14744,7 +15681,7 @@ }, { "name": "attributes", - "description": "A list of merchant-defined attributes designated for the storefront.", + "description": "A list of merchant-defined attributes designated for the storefront. They can be filtered by roles and names.", "args": [ { "name": "roles", @@ -14759,6 +15696,20 @@ } }, "defaultValue": null + }, + { + "name": "names", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null } ], "type": { @@ -15047,6 +15998,37 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "categories", + "description": "A list of categories in which the product is present.", + "args": [ + { + "name": "family", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CategoryProductView", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "queryType", "description": "Indicates if the product was retrieved from the primary or the backup query", @@ -15110,6 +16092,47 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "ConditionInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "field", + "description": null, + "type": { + "kind": "ENUM", + "name": "Field", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "operator", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "OperatorInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "enabled", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "ConfigurableAttributeOption", @@ -15663,13 +16686,9 @@ "description": "The ProductInterface object, which contains details about the base product", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null }, "isDeprecated": true, "deprecationReason": "Product information is part of a composable Catalog Service." @@ -22364,6 +23383,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "id", + "description": "The unique ID assigned to the customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "`id` is not needed as part of `Customer`, because on the server side, it can be identified based on the customer token used for authentication. There is no need to know customer ID on the client side." + }, { "name": "is_subscribed", "description": "Indicates whether the customer is subscribed to the company's newsletter.", @@ -22645,6 +23680,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "quote_enabled", + "description": "Indicates whether negotiable quote functionality is enabled for the current customer. Global and company-level settings are factored into the result.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "requisition_lists", "description": "An object that contains the customer's requisition lists.", @@ -22678,6 +23729,16 @@ "ofType": null }, "defaultValue": null + }, + { + "name": "sort", + "description": "The field to use for sorting results.", + "type": { + "kind": "INPUT_OBJECT", + "name": "RequisitionListSortInput", + "ofType": null + }, + "defaultValue": null } ], "type": { @@ -23103,8 +24164,8 @@ "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `uid` instead." }, { "name": "lastname", @@ -23218,6 +24279,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "uid", + "description": "The unique ID for a `CustomerAddress` object.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "vat_id", "description": "The customer's Value-added tax (VAT) number (for corporate customers).", @@ -24527,6 +25600,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "negotiable_quote", + "description": "The negotiable quote associated with this order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuote", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "number", "description": "The order number.", @@ -26979,6 +28064,64 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "CustomOperatorInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "type", + "description": null, + "type": { + "kind": "ENUM", + "name": "CustomOperatorType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "value", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomOperatorType", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNKNOWN_CUSTOMOPERATOR_TYPE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOM", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "SCALAR", "name": "DateTime", @@ -28505,13 +29648,9 @@ "description": "The ProductInterface object, which contains details about the base product", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null }, "isDeprecated": true, "deprecationReason": "Product information is part of a composable Catalog Service." @@ -30244,6 +31383,213 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "FastlaneConfig", + "description": "", + "fields": [ + { + "name": "code", + "description": "The payment method code as defined in the payment gateway", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_visible", + "description": "Indicates whether the payment method is displayed", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_intent", + "description": "Defines the payment intent (Authorize or Capture", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment_source", + "description": "The payment source for the payment method", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sdk_params", + "description": "The PayPal parameters required to load the JS SDK", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SDKParams", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sort_order", + "description": "The relative order the payment method is displayed on the checkout page", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "three_ds_mode", + "description": "3DS mode", + "args": [], + "type": { + "kind": "ENUM", + "name": "ThreeDSMode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The name displayed for the payment method", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "PaymentConfigItem", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FastlaneMethodInput", + "description": "Fastlane Payment inputs", + "fields": null, + "inputFields": [ + { + "name": "payment_source", + "description": "The payment source for the payment method", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "paypal_fastlane_token", + "description": "The single use token from Fastlane", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "Field", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNKNOWN_FIELD", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATEGORY", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OUT_OF_STOCK", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOW_STOCK", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TYPE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VISIBILITY", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "OBJECT", "name": "FilterableInSearchAttribute", @@ -30427,6 +31773,80 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "FilterRuleInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "name", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "type", + "description": null, + "type": { + "kind": "ENUM", + "name": "FilterRuleType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "conditions", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ConditionInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FilterRuleType", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNKNOWN_FILTER_RULE_TYPE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCLUSION", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXCLUSION", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "FilterStringTypeInput", @@ -30631,6 +32051,100 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "finishUploadInput", + "description": "", + "fields": null, + "inputFields": [ + { + "name": "key", + "description": "The unique key identifier from the upload", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "media_resource_type", + "description": "The type of media resource being uploaded", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaResourceType", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "finishUploadOutput", + "description": "", + "fields": [ + { + "name": "key", + "description": "The unique key identifier", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "Additional information about the confirmation", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "success", + "description": "Whether the confirmation was successful", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "FixedProductTax", @@ -31932,13 +33446,9 @@ "description": "The ProductInterface object, which contains details about the base product", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null }, "isDeprecated": true, "deprecationReason": "Product information is part of a composable Catalog Service." @@ -34865,6 +36375,16 @@ "ofType": null }, "defaultValue": null + }, + { + "name": "customer_address_uid", + "description": "The unique ID assigned to this customer address.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null } ], "interfaces": null, @@ -36176,6 +37696,113 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "HistoryItemNoteData", + "description": "Item note data that is added to the negotiable quote history object.", + "fields": [ + { + "name": "created_at", + "description": "Datetime of the note added.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "creator_name", + "description": "Name of the creator.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "creator_type", + "description": "Creator type: Buyer or Seller.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "item_id", + "description": "Id of the quote item for which the note has been added.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "The note added by the creator for the item", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product_name", + "description": "Name of the quote item product for which note has been added.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "HostedFieldsConfig", @@ -36471,6 +38098,104 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "initiateUploadInput", + "description": "", + "fields": null, + "inputFields": [ + { + "name": "key", + "description": "The name of the file to be uploaded, cannot contain slashes", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "media_resource_type", + "description": "The type of media resource being uploaded", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaResourceType", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "initiateUploadOutput", + "description": "", + "fields": [ + { + "name": "expires_at", + "description": "The expiration timestamp of the URL", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "key", + "description": "The unique key identifier for the upload", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "upload_url", + "description": "The presigned URL for uploading the file", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "ENUM", "name": "InputFilterEnum", @@ -37375,6 +39100,60 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "IsOperatorInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "type", + "description": null, + "type": { + "kind": "ENUM", + "name": "IsOperatorType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "value", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "IsOperatorType", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNKNOWN_ISOPERATOR_TYPE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IS", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "OBJECT", "name": "ItemNote", @@ -37404,6 +39183,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "creator_name", + "description": "Name of the creator.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "creator_type", "description": "Type of teh user who submitted a note.", @@ -37909,6 +39700,47 @@ } ] }, + { + "kind": "ENUM", + "name": "MediaResourceType", + "description": "Enumeration of media resource types", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NEGOTIABLE_QUOTE_ATTACHMENT", + "description": "Negotiable quote comment file attachment", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_ATTRIBUTE_FILE", + "description": "Customer file resource type", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_ATTRIBUTE_IMAGE", + "description": "Customer image resource type", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_ATTRIBUTE_ADDRESS_FILE", + "description": "Customer file resource type for customer address", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_ATTRIBUTE_ADDRESS_IMAGE", + "description": "Customer image resource type for customer address", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "OBJECT", "name": "MessageStyleLogo", @@ -38478,6 +40310,41 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "addProductsToNewCart", + "description": "Creates a new cart and add any type of product to it", + "args": [ + { + "name": "cartItems", + "description": "An array that defines the products to add to the new cart", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartItemInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddProductsToNewCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "addProductsToRequisitionList", "description": "Add items to the specified requisition list.", @@ -39185,6 +41052,29 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "completeOrder", + "description": "Synchronizes order details and place the order", + "args": [ + { + "name": "input", + "description": "Describes the variables needed to complete or place the order", + "type": { + "kind": "INPUT_OBJECT", + "name": "CompleteOrderInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PlaceOrderOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "confirmCancelOrder", "description": "Cancel the specified guest customer order.", @@ -39940,6 +41830,33 @@ "name": "Boolean", "ofType": null }, + "isDeprecated": true, + "deprecationReason": "Use `deleteCustomerAddressV2` instead." + }, + { + "name": "deleteCustomerAddressV2", + "description": "Delete the billing or shipping address of a customer.", + "args": [ + { + "name": "uid", + "description": "The unique ID of the customer address to be deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null }, @@ -40270,6 +42187,74 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "exchangeOtpForCustomerToken", + "description": "Exchange a customer's one time password for a customer token.", + "args": [ + { + "name": "email", + "description": "The customer's email address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "otp", + "description": "The customer's OTP.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "finishUpload", + "description": null, + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "finishUploadInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "finishUploadOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "generateCustomerToken", "description": "Generate a token for specified customer.", @@ -40365,6 +42350,33 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "initiateUpload", + "description": null, + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "initiateUploadInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "initiateUploadOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "mergeCarts", "description": "Transfer the contents of a guest cart into the cart of a logged-in customer.", @@ -40635,6 +42647,33 @@ "name": "PlaceNegotiableQuoteOrderOutput", "ofType": null }, + "isDeprecated": true, + "deprecationReason": "Use placeNegotiableQuoteOrderV2 instead." + }, + { + "name": "placeNegotiableQuoteOrderV2", + "description": "Convert a negotiable quote into an order.", + "args": [ + { + "name": "input", + "description": "An input object that specifies the negotiable quote.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PlaceNegotiableQuoteOrderInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PlaceNegotiableQuoteOrderOutputV2", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null }, @@ -41553,6 +43592,33 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "setCartAsInactive", + "description": "Sets the cart as inactive", + "args": [ + { + "name": "cartId", + "description": "The customer cart ID", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SetCartAsInactiveOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "setCustomAttributesOnCart", "description": "Add custom attributes to the cart.", @@ -41976,6 +44042,33 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "setQuoteTemplateExpirationDate", + "description": "Set expiration date to a negotiable quote template.", + "args": [ + { + "name": "input", + "description": "An input object that defines the quote template expiration date.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "QuoteTemplateExpirationDateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplate", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "setQuoteTemplateLineItemNote", "description": "Add buyer's note to a negotiable quote template item.", @@ -42381,6 +44474,43 @@ "name": "CustomerAddress", "ofType": null }, + "isDeprecated": true, + "deprecationReason": "Use `updateCustomerAddressV2` instead." + }, + { + "name": "updateCustomerAddressV2", + "description": "Update the billing or shipping address of a customer or guest.", + "args": [ + { + "name": "uid", + "description": "The unique ID of the customer address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "An input object that contains changes to the customer address.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerAddressInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAddress", + "ofType": null + }, "isDeprecated": false, "deprecationReason": null }, @@ -42992,6 +45122,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "expiration_date", + "description": "The expiration period of the negotiable quote.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "history", "description": "A list of status and price changes for the negotiable quote.", @@ -43056,6 +45202,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "order", + "description": "The order created from the negotiable quote.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "prices", "description": "A set of subtotals and totals applied to the negotiable quote.", @@ -43068,6 +45226,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "sales_rep_name", + "description": "The first and last name of the sales representative.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "selected_payment_method", "description": "The payment method that was applied to the negotiable quote.", @@ -43116,6 +45290,30 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "template_id", + "description": "The unique ID of a `NegotiableQuoteTemplate` object.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "template_name", + "description": "The title assigned to the negotiable quote template.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "total_quantity", "description": "The total number of items in the negotiable quote.", @@ -43253,6 +45451,30 @@ }, "defaultValue": null }, + { + "name": "custom_attributes", + "description": "The custom attribute values of the billing or shipping negotiable quote address.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeValueInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "fax", + "description": "The fax number of the customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, { "name": "firstname", "description": "The first name of the company user.", @@ -43281,6 +45503,16 @@ }, "defaultValue": null }, + { + "name": "middlename", + "description": "The middle name of the person associated with the billing/shipping address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, { "name": "postcode", "description": "The ZIP or postal code of the billing or shipping address.", @@ -43291,6 +45523,16 @@ }, "defaultValue": null }, + { + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, { "name": "region", "description": "A string that defines the state or province of the billing or shipping address.", @@ -43339,6 +45581,16 @@ }, "defaultValue": null }, + { + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, { "name": "telephone", "description": "The telephone number for the billing or shipping address.", @@ -43348,6 +45600,16 @@ "ofType": null }, "defaultValue": null + }, + { + "name": "vat_id", + "description": "The customer's Tax/VAT number (for corporate customers).", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null } ], "interfaces": null, @@ -43403,6 +45665,46 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "custom_attributes", + "description": "The custom attribute values of the billing or shipping negotiable quote address.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fax", + "description": "The fax number of the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "firstname", "description": "The first name of the company user.", @@ -43435,6 +45737,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "middlename", + "description": "The middle name of the person associated with the billing/shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "postcode", "description": "The company's ZIP or postal code.", @@ -43447,6 +45761,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "region", "description": "An object containing the region name, region code, and region ID.", @@ -43479,6 +45805,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "telephone", "description": "The customer's telephone number.", @@ -43490,6 +45828,34 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique identifier of the negotiable quote address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vat_id", + "description": "The customer's Tax/VAT number (for corporate customers).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -43604,6 +45970,46 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "custom_attributes", + "description": "The custom attribute values of the billing or shipping negotiable quote address.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fax", + "description": "The fax number of the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "firstname", "description": "The first name of the company user.", @@ -43636,6 +46042,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "middlename", + "description": "The middle name of the person associated with the billing/shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "postcode", "description": "The company's ZIP or postal code.", @@ -43648,6 +46066,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "region", "description": "An object containing the region name, region code, and region ID.", @@ -43680,6 +46110,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "telephone", "description": "The customer's telephone number.", @@ -43691,6 +46133,34 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique identifier of the negotiable quote address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vat_id", + "description": "The customer's Tax/VAT number (for corporate customers).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -43760,6 +46230,26 @@ "name": "NegotiableQuoteComment", "description": "Contains a single plain text comment from either the buyer or seller.", "fields": [ + { + "name": "attachments", + "description": "Negotiable quote comment file attachments.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteCommentAttachment", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "author", "description": "The first and last name of the commenter.", @@ -43846,6 +46336,74 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteCommentAttachment", + "description": "Negotiable quote comment file attachment.", + "fields": [ + { + "name": "name", + "description": "Negotiable quote comment attachment file name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "Negotiable quote comment attachment file url.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteCommentAttachmentInput", + "description": "Negotiable quote comment file attachment.", + "fields": null, + "inputFields": [ + { + "name": "key", + "description": "Negotiable quote comment attachment file key.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "ENUM", "name": "NegotiableQuoteCommentCreatorType", @@ -43875,6 +46433,20 @@ "description": "Contains the commend provided by the buyer.", "fields": null, "inputFields": [ + { + "name": "attachments", + "description": "Negotiable quote comment file attachments.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteCommentAttachmentInput", + "ofType": null + } + }, + "defaultValue": null + }, { "name": "comment", "description": "The comment provided by the buyer.", @@ -44151,6 +46723,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "item_note", + "description": "Item note data that is added to the negotiable quote history object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "HistoryItemNoteData", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "uid", "description": "The unique ID of a `NegotiableQuoteHistoryEntry` object.", @@ -44634,6 +47218,46 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "custom_attributes", + "description": "The custom attribute values of the billing or shipping negotiable quote address.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "AttributeValueInterface", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fax", + "description": "The fax number of the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "firstname", "description": "The first name of the company user.", @@ -44666,6 +47290,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "middlename", + "description": "The middle name of the person associated with the billing/shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "postcode", "description": "The company's ZIP or postal code.", @@ -44678,6 +47314,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "prefix", + "description": "An honorific, such as Dr., Mr., or Mrs.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "region", "description": "An object containing the region name, region code, and region ID.", @@ -44722,6 +47370,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "suffix", + "description": "A value such as Sr., Jr., or III.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "telephone", "description": "The customer's telephone number.", @@ -44733,6 +47393,34 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique identifier of the negotiable quote address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vat_id", + "description": "The customer's Tax/VAT number (for corporate customers).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -45032,6 +47720,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "created_at", + "description": "Timestamp indicating when the negotiable quote template was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "expiration_date", "description": "The expiration period of the negotiable quote template.", @@ -45064,6 +47768,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "historyV2", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplateHistoryEntry", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "is_min_max_qty_used", "description": "Indicates whether the minimum and maximum quantity settings are used.", @@ -45204,6 +47924,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "sales_rep_name", + "description": "The first and last name of the sales representative.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "shipping_addresses", "description": "A list of shipping addresses applied to the negotiable quote template.", @@ -45271,6 +48007,38 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID of a `NegotiableQuoteTemplate` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "Timestamp indicating when the negotiable quote template was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -45346,6 +48114,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "created_at", + "description": "Timestamp indicating when the negotiable quote template was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "expiration_date", "description": "The expiration period of the negotiable quote template.", @@ -45378,6 +48162,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "last_ordered_at", + "description": "Timestamp indicating when the last negotiable quote template order was placed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "last_shared_at", "description": "The date and time the negotiable quote template was last shared.", @@ -45474,6 +48274,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "prices", + "description": "A set of subtotals and totals applied to the negotiable quote template.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CartPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "sales_rep_name", "description": "The first and last name of the sales representative.", @@ -45553,6 +48365,278 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID of a `NegotiableQuoteTemplate` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updated_at", + "description": "Timestamp indicating when the negotiable quote template was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplateHistoryChanges", + "description": "Contains a list of changes to a negotiable quote template.", + "fields": [ + { + "name": "comment_added", + "description": "The comment provided with a change in the negotiable quote history.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryCommentChange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom_changes", + "description": "Lists log entries added by third-party extensions.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteCustomLogChange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expiration", + "description": "The expiration date of the negotiable quote before and after a change in the quote history.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryExpirationChange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products_removed", + "description": "Lists products that were removed as a result of a change in the quote history.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryProductsRemovedChange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "statuses", + "description": "The status before and after a change in the negotiable quote template history.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplateHistoryStatusesChange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total", + "description": "The total amount of the negotiable quote before and after a change in the quote history.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteHistoryTotalChange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplateHistoryEntry", + "description": "Contains details about a change for a negotiable quote template.", + "fields": [ + { + "name": "author", + "description": "The person who made a change in the status of the negotiable quote.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteUser", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "change_type", + "description": "An enum that specifies the reason for a status change in the negotiable quote history entry.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "NegotiableQuoteHistoryEntryChangeType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "changes", + "description": "The set of changes in the negotiable quote template.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplateHistoryChanges", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "created_at", + "description": "Timestamp indicating when the negotiable quote entry was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uid", + "description": "The unique ID of a `NegotiableQuoteHistoryEntry` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplateHistoryStatusChange", + "description": "Lists a new status change applied to a negotiable quote template and the previous status.", + "fields": [ + { + "name": "new_status", + "description": "The updated status.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "old_status", + "description": "The previous status. The value will be null for the first history entry in a negotiable quote.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplateHistoryStatusesChange", + "description": "Contains a list of status changes that occurred for the negotiable quote template.", + "fields": [ + { + "name": "changes", + "description": "A list of status changes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NegotiableQuoteTemplateHistoryStatusChange", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -46014,6 +49098,56 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "NumericOperatorInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "type", + "description": null, + "type": { + "kind": "ENUM", + "name": "NumericOperatorType", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "NumericOperatorType", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNKNOWN_NUMERIC_OPERATOR", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN_CURRENT", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN_CURRENT", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "OBJECT", "name": "OopePaymentMethodConfig", @@ -46086,6 +49220,67 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "OperatorInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "rangeOperator", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "RangeOperatorInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customOperator", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomOperatorInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "isOperator", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "IsOperatorInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "numericOperator", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "NumericOperatorInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "stringOperator", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "StringOperatorInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "Order", @@ -46652,13 +49847,9 @@ "description": "The ProductInterface object, which contains details about the base product", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null }, "isDeprecated": true, "deprecationReason": "Product information is part of a composable Catalog Service." @@ -46977,13 +50168,9 @@ "description": "The ProductInterface object, which contains details about the base product", "args": [], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INTERFACE", - "name": "ProductInterface", - "ofType": null - } + "kind": "INTERFACE", + "name": "ProductInterface", + "ofType": null }, "isDeprecated": true, "deprecationReason": "Product information is part of a composable Catalog Service." @@ -47666,6 +50853,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "grand_total_excl_tax", + "description": "The grand total of the order, excluding taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "shipping_handling", "description": "Details about the shipping and handling costs for the order.", @@ -48070,6 +51273,11 @@ "name": "ApplePayConfig", "ofType": null }, + { + "kind": "OBJECT", + "name": "FastlaneConfig", + "ofType": null + }, { "kind": "OBJECT", "name": "GooglePayConfig", @@ -48109,6 +51317,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "fastlane", + "description": "Fastlane payment method configuration", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FastlaneConfig", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "google_pay", "description": "GooglePay payment method configuration", @@ -48236,6 +51456,16 @@ }, "defaultValue": null }, + { + "name": "payment_services_paypal_fastlane", + "description": "Required input for fastlane", + "type": { + "kind": "INPUT_OBJECT", + "name": "FastlaneMethodInput", + "ofType": null + }, + "defaultValue": null + }, { "name": "payment_services_paypal_google_pay", "description": "Required input for Google Pay button", @@ -49163,6 +52393,45 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "PlaceNegotiableQuoteOrderOutputV2", + "description": "An output object that returns the generated order.", + "fields": [ + { + "name": "errors", + "description": "An array of place negotiable quote order errors.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PlaceOrderError", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "Full order information.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "PlaceOrderError", @@ -51035,6 +54304,22 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "warnings", + "description": "An array of warning messages for validation issues (e.g., sort parameter ignored due to missing categoryPath)", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductSearchWarning", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -51081,6 +54366,49 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "ProductSearchWarning", + "description": "Structured warning with code and message for easier client handling", + "fields": [ + { + "name": "code", + "description": "Error code for programmatic handling (e.g., EMPTY_CATEGORY_PATH)", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "Human-readable message describing the warning", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "ENUM", "name": "ProductStockStatus", @@ -51224,7 +54552,7 @@ }, { "name": "attributes", - "description": "A list of merchant-defined attributes designated for the storefront.", + "description": "A list of merchant-defined attributes designated for the storefront. They can be filtered by roles and names.", "args": [ { "name": "roles", @@ -51239,6 +54567,20 @@ } }, "defaultValue": null + }, + { + "name": "names", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null } ], "type": { @@ -51499,6 +54841,37 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "categories", + "description": "A list of categories in which the product is present.", + "args": [ + { + "name": "family", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CategoryProductView", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "queryType", "description": "Indicates if the product was retrieved from the primary or the backup query", @@ -53370,6 +56743,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "tiers", + "description": "Volume based pricing", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductViewTierPrice", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "roles", "description": "Price roles, stating if the price should be visible or hidden.", @@ -53427,6 +56816,136 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "UNION", + "name": "ProductViewTierCondition", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "ProductViewTierRangeCondition", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductViewTierExactMatchCondition", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "ProductViewTierExactMatchCondition", + "description": null, + "fields": [ + { + "name": "in", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductViewTierPrice", + "description": null, + "fields": [ + { + "name": "tier", + "description": "Volume based price", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Price", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "Condition to active price", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "ProductViewTierCondition", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductViewTierRangeCondition", + "description": null, + "fields": [ + { + "name": "gte", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lt", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "ProductViewVariant", @@ -53625,16 +57144,12 @@ "description": "The approval flows for each applied rules.", "args": [], "type": { - "kind": "NON_NULL", + "kind": "LIST", "name": null, "ofType": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PurchaseOrderRuleApprovalFlow", - "ofType": null - } + "kind": "OBJECT", + "name": "PurchaseOrderRuleApprovalFlow", + "ofType": null } }, "isDeprecated": false, @@ -55040,6 +58555,16 @@ }, "defaultValue": null }, + { + "name": "my_approvals", + "description": "Include purchase orders that are pending approval by the customer or eligible for their approval but have already been dealt with.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, { "name": "require_my_approval", "description": "Include only purchase orders that are waiting for the customer’s approval.", @@ -55343,6 +58868,96 @@ "isDeprecated": true, "deprecationReason": "This field is deprecated and will be removed." }, + { + "name": "navigation", + "description": "Retrieves the navigation tree for a given product family.", + "args": [ + { + "name": "family", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CategoryNavigationView", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "categoryTree", + "description": "Retrieves category tree nodes, optionally filtered by slugs and limited by depth.", + "args": [ + { + "name": "family", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "slugs", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "depth", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CategoryTreeView", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "attributesForm", "description": "Retrieve EAV attributes associated to a frontend form. Use countries query provided by DirectoryGraphQl module to retrieve region_id and country_id attribute options.", @@ -55481,6 +59096,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "commerceOptimizer", + "description": "Provide necessary information to build headless storefront when Adobe Commerce is connected to Commerce Optimizer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CommerceOptimizerContext", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "company", "description": "Return detailed information about the customer's company within the current company context.", @@ -56559,6 +60190,16 @@ } }, "defaultValue": null + }, + { + "name": "config", + "description": "Optional unit configuration", + "type": { + "kind": "INPUT_OBJECT", + "name": "UnitConfigInput", + "ofType": null + }, + "defaultValue": null } ], "type": { @@ -56571,11 +60212,11 @@ }, { "name": "recommendationsByUnitIds", - "description": "Get Recommendations by Unit IDs", + "description": null, "args": [ { "name": "unitIds", - "description": "List unit IDs of the preconfigured units", + "description": "List unit IDs of preconfigured units", "type": { "kind": "NON_NULL", "name": null, @@ -56859,13 +60500,27 @@ }, { "kind": "INPUT_OBJECT", - "name": "QuoteTemplateLineItemNoteInput", - "description": "Sets quote item note.", + "name": "QuoteTemplateExpirationDateInput", + "description": "Sets quote template expiration date.", "fields": null, "inputFields": [ { - "name": "item_id", - "description": "The unique ID of a `CartLineItem` object.", + "name": "expiration_date", + "description": "The expiration period of the negotiable quote template.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "template_id", + "description": "The unique ID of a `NegotiableQuoteTemplate` object.", "type": { "kind": "NON_NULL", "name": null, @@ -56876,6 +60531,37 @@ } }, "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "QuoteTemplateLineItemNoteInput", + "description": "Sets quote item note.", + "fields": null, + "inputFields": [ + { + "name": "item_id", + "description": "The unique ID of a `CartLineItem` object.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "item_uid", + "description": "The unique ID of a `CartLineItem` object.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null }, { "name": "note", @@ -57026,6 +60712,103 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "RangeOperatorInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "type", + "description": null, + "type": { + "kind": "ENUM", + "name": "RangeType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "value", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "RangeValueInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "RangeType", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNKNOWN_RANGE_TYPE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STATIC", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PERCENTAGE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DYNAMIC", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RangeValueInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "from", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "to", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "ReCaptchaConfigOutput", @@ -57433,6 +61216,12 @@ "description": "", "isDeprecated": false, "deprecationReason": null + }, + { + "name": "RECAPTCHA_ENTERPRISE", + "description": "", + "isDeprecated": false, + "deprecationReason": null } ], "possibleTypes": null @@ -59094,6 +62883,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "sort_fields", + "description": "Contains the default sort field and all available sort fields.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SortFields", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "total_count", "description": "The number of returned requisition lists.", @@ -59112,6 +62913,64 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "ENUM", + "name": "RequisitionListSortableField", + "description": "", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NAME", + "description": "Sorts requisition lists by requisition list name.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sorts requisition lists by the date they were last updated.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RequisitionListSortInput", + "description": "Defines the field to use to sort a list of requisition lists.", + "fields": null, + "inputFields": [ + { + "name": "sort_direction", + "description": "Whether to return results in ascending or descending order.", + "type": { + "kind": "ENUM", + "name": "SortEnum", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sort_field", + "description": "The specified sort field.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "RequisitionListSortableField", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "RequistionListItems", @@ -61886,6 +65745,45 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "SetCartAsInactiveOutput", + "description": "Sets the cart as inactive", + "fields": [ + { + "name": "error", + "description": "The error message returned after failing to set the cart as inactive", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "success", + "description": "Indicates whether the cart was set as inactive", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "SetCustomAttributesOnCompanyInput", @@ -63199,6 +67097,16 @@ }, "defaultValue": null }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address to be used for shipping.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, { "name": "customer_notes", "description": "Text provided by the shopper.", @@ -63325,6 +67233,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "customer_address_uid", + "description": "The unique ID from the customer's address book that uniquely identifies the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "customer_notes", "description": "Text provided by the shopper.", @@ -63374,8 +67294,8 @@ "name": "Int", "ofType": null }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Use `customer_address_uid` instead." }, { "name": "lastname", @@ -63527,14 +67447,14 @@ }, { "name": "uid", - "description": "The unique id of the customer address.", + "description": "The unique id of the customer cart address.", "args": [], "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "ID", "ofType": null } }, @@ -64608,7 +68528,7 @@ }, { "name": "attributes", - "description": "A list of merchant-defined attributes designated for the storefront.", + "description": "A list of merchant-defined attributes designated for the storefront. They can be filtered by names and roles.", "args": [ { "name": "roles", @@ -64623,6 +68543,20 @@ } }, "defaultValue": null + }, + { + "name": "names", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null } ], "type": { @@ -64895,6 +68829,37 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "categories", + "description": "A list of categories in which the product is present.", + "args": [ + { + "name": "family", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CategoryProductView", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "queryType", "description": "Indicates if the product was retrieved from the primary or the backup query", @@ -65175,6 +69140,18 @@ "name": "SmartButtonsConfig", "description": "", "fields": [ + { + "name": "app_switch_when_available", + "description": "Indicated whether to use App Switch on enabled mobile devices", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "button_styles", "description": "The styles for the PayPal Smart Button configuration", @@ -65750,6 +69727,22 @@ "name": "StoreConfig", "description": "Contains information about a store's configuration.", "fields": [ + { + "name": "allow_company_registration", + "description": "Indicates if company registration is allowed", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "allow_gift_receipt", "description": "Indicates if the gift sender has the option to send a gift receipt. Possible values: 1 (Yes) and 0 (No).", @@ -65918,6 +69911,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "cart_merge_preference", + "description": "Configuration data from checkout/cart/cart_merge_preference", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "cart_printed_card", "description": "Indicates if printed card prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No).", @@ -66098,6 +70107,38 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "company_credit_enabled", + "description": "Indicates if company credit is enabled.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company_enabled", + "description": "Indicates if B2B company functionality is enabled", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "configurable_product_image", "description": "checkout/cart/configurable_product_image: which image to use for configurable products.", @@ -67002,6 +71043,30 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "quote_minimum_amount", + "description": "Minimum order total for quote request.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quote_minimum_amount_message", + "description": "A message that will be shown in the cart when the subtotal (after discount) is lower than the minimum allowed amount.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "required_character_classes_number", "description": "The number of different character classes (lowercase, uppercase, digits, special characters) required in a password.", @@ -67535,12 +71600,76 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "StringOperatorInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "type", + "description": null, + "type": { + "kind": "ENUM", + "name": "StringOperatorType", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "StringOperatorType", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNKNOWN_STRING_OPERATOR", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SAME_AS_CURRENT", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ALL_EXCEPT_CURRENT", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "SubmitNegotiableQuoteTemplateForReviewInput", "description": "Specifies the quote template properties to update.", "fields": null, "inputFields": [ + { + "name": "attachments", + "description": "Negotiable quote template comment file attachments.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "NegotiableQuoteCommentAttachmentInput", + "ofType": null + } + }, + "defaultValue": null + }, { "name": "comment", "description": "A comment for the seller to review.", @@ -68171,6 +72300,101 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "UnitConfigInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "unitName", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "storefrontLabel", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pagePlacement", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "displayNumber", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pageType", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "unitStatus", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "typeId", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "filterRules", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "FilterRuleInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "UpdateCartItemsInput", @@ -70952,6 +75176,12 @@ "description": "", "isDeprecated": false, "deprecationReason": null + }, + { + "name": "REQUIRED_PARAMETER_MISSING", + "description": "", + "isDeprecated": false, + "deprecationReason": null } ], "possibleTypes": null diff --git a/src/_includes/accs-intro.md b/src/_includes/accs-intro.md new file mode 100644 index 000000000..14e584e05 --- /dev/null +++ b/src/_includes/accs-intro.md @@ -0,0 +1,9 @@ +The schema documented here is autogenerated from an instance of Adobe Commerce as a Cloud Service. + +The base format for Adobe Commerce as a Cloud Service REST endpoint URLs is: + +`https://.api.commerce.adobe.com//` + +The URL does not include `/rest` or the store view code. You must use the `Store` HTTP header to set the store scope. + +See the REST Overview for more details about the URL structure and authentication. diff --git a/src/_includes/custom-attribute-installation.md b/src/_includes/custom-attribute-installation.md index 60313b9d4..e8d99a92f 100644 --- a/src/_includes/custom-attribute-installation.md +++ b/src/_includes/custom-attribute-installation.md @@ -16,10 +16,11 @@ To install custom attributes in Adobe Commerce: composer require magento/out-of-process-custom-attributes=^0.2.0 --with-dependencies ``` -1. Enable the new module: +1. Enable the new modules: ```bash - bin/magento module:enable Magento_OutOfProcessCustomAttributes + bin/magento module:enable Magento_CustomAttributeSerializable + bin/magento module:enable Magento_CustomAttributeSerializableGraphQl ``` 1. For on-premises installations, run the following command to upgrade Adobe Commerce and clear the cache. diff --git a/src/_includes/graphql/examples/customer-s3-download.md b/src/_includes/graphql/examples/customer-s3-download.md new file mode 100644 index 000000000..92446c958 --- /dev/null +++ b/src/_includes/graphql/examples/customer-s3-download.md @@ -0,0 +1,40 @@ +The following query returns the presigned URL of any file or image that a customer [uploaded to Amazon S3](../../uploads/index.md). + +**Request:** + +```graphql +{ + customer { + custom_attributes { + code + ... on AttributeFile { + url + value + } + ... on AttributeImage { + url + value + } + } + } +} +``` + +**Response:** + +```json +{ + "data": { + "customer": { + "firstname": "John", + "lastname": "Doe", + "custom_attributes": [ + { + "code": "profile_picture", + "url": "https://your-bucket.s3.amazonaws.com/path/to/file.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..." + } + ] + } + } +} +``` diff --git a/src/data/navigation/header.js b/src/data/navigation/header.js index 73463912a..85281e473 100644 --- a/src/data/navigation/header.js +++ b/src/data/navigation/header.js @@ -35,6 +35,10 @@ module.exports = [ title: "SaaS Reference", path: "/reference/graphql/saas" }, + { + title: "2.4.9-beta-1 Reference", + path: "/reference/graphql/2.4.9-beta-1", + }, { title: "2.4.8 Reference", path: "/reference/graphql/2.4.8", diff --git a/src/data/navigation/sections/graphql.js b/src/data/navigation/sections/graphql.js index 73fb4eeee..be46c34cc 100644 --- a/src/data/navigation/sections/graphql.js +++ b/src/data/navigation/sections/graphql.js @@ -239,6 +239,14 @@ module.exports = [ title: "createGuestCart", path: "/graphql/schema/cart/mutations/create-guest-cart/", }, + { + title: "estimateShippingMethods", + path: "/graphql/schema/cart/mutations/estimate-shipping-methods/", + }, + { + title: "estimateTotals", + path: "/graphql/schema/cart/mutations/estimate-totals/", + }, { title: "mergeCarts", path: "/graphql/schema/cart/mutations/merge/", @@ -575,9 +583,17 @@ module.exports = [ title: "deleteCustomerAddress", path: "/graphql/schema/customer/mutations/delete-address/", }, + { + title: "deleteCustomerAddressV2", + path: "/graphql/schema/customer/mutations/delete-address-v2/", + }, { title: "exchangeExternalCustomerToken", - path: "/graphql/schema/customer/mutations/create-external-customer-token/", + path: "/graphql/schema/customer/mutations/exchange-external-customer-token/", + }, + { + title: "exchangeOtpForCustomerToken", + path: "/graphql/schema/customer/mutations/exchange-otp-customer-token/", }, { title: "generateCustomerToken", @@ -619,6 +635,10 @@ module.exports = [ title: "updateCustomerAddress", path: "/graphql/schema/customer/mutations/update-address/", }, + { + title: "updateCustomerAddressV2", + path: "/graphql/schema/customer/mutations/update-address-v2/", + }, { title: "updateCustomerEmail", path: "/graphql/schema/customer/mutations/update-email/", @@ -745,6 +765,10 @@ module.exports = [ title: "negotiableQuotes", path: "/graphql/schema/b2b/negotiable-quote/queries/quotes/", }, + { + title: "negotiableQuoteTemplates", + path: "/graphql/schema/b2b/negotiable-quote/queries/templates/", + }, ], }, { @@ -763,6 +787,10 @@ module.exports = [ title: "placeNegotiableQuoteOrder", path: "/graphql/schema/b2b/negotiable-quote/mutations/place-order/", }, + { + title: "placeNegotiableQuoteOrderV2", + path: "/graphql/schema/b2b/negotiable-quote/mutations/place-order-v2/", + }, { title: "removeNegotiableQuoteItems", path: "/graphql/schema/b2b/negotiable-quote/mutations/remove-items/", @@ -791,6 +819,10 @@ module.exports = [ title: "setNegotiableQuoteShippingMethods", path: "/graphql/schema/b2b/negotiable-quote/mutations/set-shipping-methods/", }, + { + title: "setQuoteTemplateExpirationDate", + path: "/graphql/schema/b2b/negotiable-quote/mutations/set-quote-template-expiration-date/", + }, { title: "updateNegotiableQuoteQuantities", path: "/graphql/schema/b2b/negotiable-quote/mutations/update-quantities/", @@ -1235,6 +1267,26 @@ module.exports = [ }, ], }, + { + title: "Uploads", + path: "/graphql/schema/uploads/", + pages: [ + { + title: "Mutations", + path: "/graphql/schema/uploads/", + pages: [ + { + title: "finishUpload", + path: "/graphql/schema/uploads/mutations/finish-upload/", + }, + { + title: "initiateUpload", + path: "/graphql/schema/uploads/mutations/initiate-upload/", + } + ] + } + ] + }, { title: "Wish list", path: "/graphql/schema/wishlist/", @@ -1371,6 +1423,10 @@ module.exports = [ title: "Minicart", path: "/graphql/payment-services-extension/workflows/minicart.md", }, + { + title: "Add product to a new cart on a Product Details Page", + path: "/graphql/payment-services-extension/workflows/cart-pdp.md", + }, { title: "Vault a card during a checkout authorization", path: "/graphql/payment-services-extension/workflows/vault-with-purchase.md", @@ -1411,6 +1467,14 @@ module.exports = [ title: "Mutations", path: "/graphql/payment-services-extension/mutations/", pages: [ + { + title: "addProductsToNewCart", + path: "/graphql/payment-services-extension/mutations/add-products-new-cart/", + }, + { + title: "completeOrder", + path: "/graphql/payment-services-extension/mutations/complete-order/", + }, { title: "createPaymentOrder", path: "/graphql/payment-services-extension/mutations/create-payment-order/", @@ -1423,6 +1487,10 @@ module.exports = [ title: "createVaultCardSetupToken", path: "/graphql/payment-services-extension/mutations/create-vault-card-setup-token/", }, + { + title: "setCartAsInactive", + path: "/graphql/payment-services-extension/mutations/set-cart-inactive/", + }, { title: "syncPaymentOrder", path: "/graphql/payment-services-extension/mutations/sync-payment-order/", @@ -1490,6 +1558,11 @@ module.exports = [ path: "https://developer.adobe.com/commerce/webapi/reference/graphql/saas/", EventTarget: "_top" }, + { + title: "2.4.9-beta-1", + path: "https://developer.adobe.com/commerce/webapi/reference/graphql/2.4.9-beta-1/", + EventTarget: "_top" + }, { title: "2.4.8", path: "https://developer.adobe.com/commerce/webapi/reference/graphql/2.4.8/", diff --git a/src/data/navigation/sections/rest.js b/src/data/navigation/sections/rest.js index 5371ee96e..b8358b357 100644 --- a/src/data/navigation/sections/rest.js +++ b/src/data/navigation/sections/rest.js @@ -497,6 +497,10 @@ module.exports = [ title: "Sales refunds", path: "/rest/modules/sales/" }, + { + title: "S3 uploads", + path: "/rest/modules/s3-uploads/" + } ], } ]; diff --git a/src/openapi/accs-schema.yaml b/src/openapi/accs-schema.yaml index 8213ec94a..1d8f7e518 100644 --- a/src/openapi/accs-schema.yaml +++ b/src/openapi/accs-schema.yaml @@ -6,7 +6,7 @@ securityDefinitions: in: header swagger: '2.0' info: - version: 'Production' + version: '1.0' title: Adobe Commerce SaaS description: The schemas documented here are autogenerated from an instance of Adobe Commerce as a Cloud Service. @@ -16,13 +16,14 @@ schemes: - https tags: - name: addresses/{addressId} +- name: adminuisdk/appmanagement/validate - name: adminuisdk/massaction/{request_id} +- name: adminuisdk/orderviewbutton/{request_id} - name: adobe_io_events/check_configuration - name: adobestock/asset/{id} - name: adobestock/asset/list - name: adobestock/asset/search - name: adobestock/search -- name: analytics/link - name: attributeMetadata/customer - name: attributeMetadata/customer/attribute/{attributeCode} - name: attributeMetadata/customer/custom @@ -50,6 +51,7 @@ tags: - name: carts/{cartId}/coupons - name: carts/{cartId}/coupons/{couponCode} - name: carts/{cartId}/coupons/deleteByCodes +- name: carts/{cartId}/customAttributes - name: carts/{cartId}/estimate-shipping-methods - name: carts/{cartId}/estimate-shipping-methods-by-address-id - name: carts/{cartId}/gift-message @@ -118,6 +120,7 @@ tags: - name: creditmemo/{id}/emails - name: creditmemo/refund - name: creditmemos +- name: custom-email/send - name: customerGroups - name: customerGroups/{id} - name: customerGroups/{id}/permissions @@ -125,6 +128,7 @@ tags: - name: customerGroups/default/{id} - name: customerGroups/default/{storeId} - name: customerGroups/search +- name: customers - name: customers/{customerId} - name: customers/{customerId}/billingAddress - name: customers/{customerId}/carts @@ -133,12 +137,15 @@ tags: - name: customers/{customerId}/confirm - name: customers/{customerId}/permissions/readonly - name: customers/{customerId}/shippingAddress +- name: customers/{customerId}/token - name: customers/{email}/activate - name: customers/addresses/{addressId} - name: customers/companies - name: customers/confirm +- name: customers/otp - name: customers/search - name: customers/validate +- name: customerSegments/search - name: eav/attribute-sets - name: eav/attribute-sets/{attributeSetId} - name: eav/attribute-sets/list @@ -196,6 +203,8 @@ tags: - name: invoices/{id}/emails - name: invoices/{id}/void - name: invoices/comments +- name: media/finish-upload +- name: media/initiate-upload - name: modules - name: negotiable-cart-item-note - name: negotiable-cart-item-note/{noteId} @@ -221,6 +230,8 @@ tags: - name: negotiableQuoteTemplate/referenceDocumentLink/{linkId} - name: negotiableQuoteTemplate/request - name: negotiableQuoteTemplate/submitToCustomer +- name: oope_observability/subscription +- name: oope_observability/subscription/{subscriptionId} - name: oope_payment_method - name: oope_payment_method/{code} - name: oope_shipping_carrier @@ -286,12 +297,14 @@ tags: - name: products/cost-information - name: products/downloadable-links/{id} - name: products/downloadable-links/samples/{id} +- name: products/external-media/asset - name: products/external-media/get-sku/assetId/{assetId} - name: products/external-media/image - name: products/external-media/ping - name: products/external-media/remove-by-asset-id - name: products/external-media/remove-by-asset-id-and-sku - name: products/external-media/remove-by-sku +- name: products/external-media/version - name: products/external-media/video - name: products/links/{type}/attributes - name: products/links/types @@ -409,6 +422,44 @@ paths: schema: "$ref": "#/definitions/error-response" summary: addresses/{addressId} + "/V1/adminuisdk/appmanagement/validate": + post: + tags: + - adminuisdk/appmanagement/validate + description: Validate App Management User token + operationId: PostV1AdminuisdkAppmanagementValidate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1AdminuisdkAppmanagementValidateBody + in: body + schema: + required: + - orgId + properties: + orgId: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/commerce-backend-uix-data-app-management-validation-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: adminuisdk/appmanagement/validate "/V1/adminuisdk/massaction/{request_id}": get: tags: @@ -444,6 +495,41 @@ paths: schema: "$ref": "#/definitions/error-response" summary: adminuisdk/massaction/{request_id} + "/V1/adminuisdk/orderviewbutton/{request_id}": + get: + tags: + - adminuisdk/orderviewbutton/{request_id} + description: Load order view button failed request by request id + operationId: GetV1AdminuisdkOrderviewbuttonRequest_id + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: requestId + in: query + type: string + required: true + - name: request_id + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/commerce-backend-uix-data-order-view-button-failed-request-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: adminuisdk/orderviewbutton/{request_id} "/V1/adobe_io_events/check_configuration": get: tags: @@ -715,32 +801,6 @@ paths: schema: "$ref": "#/definitions/error-response" summary: adobestock/search - "/V1/analytics/link": - get: - tags: - - analytics/link - description: '' - operationId: GetV1AnalyticsLink - consumes: - - application/json - - application/xml - produces: - - application/json - - application/xml - responses: - '200': - description: 200 Success. - schema: - "$ref": "#/definitions/analytics-data-link-interface" - '401': - description: 401 Unauthorized - schema: - "$ref": "#/definitions/error-response" - default: - description: Unexpected error - schema: - "$ref": "#/definitions/error-response" - summary: analytics/link "/V1/attributeMetadata/customer": get: tags: @@ -2068,6 +2128,54 @@ paths: schema: "$ref": "#/definitions/error-response" summary: carts/{cartId}/coupons/{couponCode} + "/V1/carts/{cartId}/customAttributes": + post: + tags: + - carts/{cartId}/customAttributes + description: Save custom attributes for quote by cart id + operationId: PostV1CartsCartIdCustomAttributes + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: PostV1CartsCartIdCustomAttributesBody + in: body + schema: + required: + - customAttributes + properties: + customAttributes: + type: array + items: + "$ref": "#/definitions/framework-attribute-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/customAttributes "/V1/carts/{cartId}/estimate-shipping-methods": post: tags: @@ -5712,6 +5820,58 @@ paths: schema: "$ref": "#/definitions/error-response" summary: creditmemos + "/V1/custom-email/send": + post: + tags: + - custom-email/send + description: Send an email using the given template ID and variables. + operationId: PostV1CustomemailSend + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CustomemailSendBody + in: body + schema: + required: + - templateId + - recipientEmail + properties: + templateId: + type: integer + description: Email template ID + recipientEmail: + type: string + description: Recipient email address + variables: + type: array + description: Template variables (key-value map for placeholder substitution) + items: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/custom-email-send-data-send-email-response-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: custom-email/send "/V1/customerGroups": post: tags: @@ -6105,6 +6265,112 @@ paths: schema: "$ref": "#/definitions/error-response" summary: customerGroups/{id}/permissions + "/V1/customerSegments/search": + get: + tags: + - customerSegments/search + description: Retrieve customer segments that match a specified criteria. + operationId: GetV1CustomerSegmentsSearch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-segment-storefront-compatibility-data-customer-segment-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customerSegments/search + "/V1/customers": + post: + tags: + - customers + description: Create customer account. Perform necessary business operations + like sending email. + operationId: PostV1Customers + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CustomersBody + in: body + schema: + required: + - customer + properties: + customer: + "$ref": "#/definitions/customer-data-customer-interface" + password: + type: string + redirectUrl: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-customer-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers "/V1/customers/addresses/{addressId}": get: tags: @@ -6280,10 +6546,53 @@ paths: schema: "$ref": "#/definitions/error-response" summary: customers/confirm - "/V1/customers/search": - get: + "/V1/customers/otp": + post: tags: - - customers/search + - customers/otp + description: Generate a one-time password for the customer identified by email. + The OTP can be used with the exchangeOtpForCustomerToken GraphQL mutation. + Returns a successful response even when the customer does not exist (prevents + user enumeration). + operationId: PostV1CustomersOtp + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CustomersOtpBody + in: body + schema: + required: + - email + properties: + email: + type: string + reason: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/otp-rest-data-otp-response-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/otp + "/V1/customers/search": + get: + tags: + - customers/search description: Retrieve customers which match a specified criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#CustomerRepositoryInterface @@ -6837,6 +7146,43 @@ paths: schema: "$ref": "#/definitions/error-response" summary: customers/{customerId}/shippingAddress + "/V1/customers/{customerId}/token": + post: + tags: + - customers/{customerId}/token + description: Generate a customer token based on the provided customer ID. + operationId: PostV1CustomersCustomerIdToken + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: customerId + in: path + type: integer + required: true + description: The ID of the customer for whom the token is to be generated. + responses: + '200': + description: 200 Success. + schema: + type: string + description: The generated customer token. + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/{customerId}/token "/V1/customers/{email}/activate": put: tags: @@ -9795,6 +10141,97 @@ paths: schema: "$ref": "#/definitions/error-response" summary: invoices/{id}/void + "/V1/media/finish-upload": + post: + tags: + - media/finish-upload + description: Finish the upload and move object from presigned bucket to final + destination. + operationId: PostV1MediaFinishupload + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1MediaFinishuploadBody + in: body + schema: + required: + - key + - mediaResourceType + properties: + key: + type: string + mediaResourceType: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/s3-presigned-upload-data-finish-upload-response-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: media/finish-upload + "/V1/media/initiate-upload": + post: + tags: + - media/initiate-upload + description: Generate a presigned S3 URL for direct upload. + operationId: PostV1MediaInitiateupload + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1MediaInitiateuploadBody + in: body + schema: + required: + - key + - mediaResourceType + properties: + key: + type: string + mediaResourceType: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/s3-presigned-upload-data-initiate-upload-response-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: media/initiate-upload "/V1/modules": get: tags: @@ -11006,25 +11443,52 @@ paths: schema: "$ref": "#/definitions/error-response" summary: negotiableQuoteTemplate/{templateId} - "/V1/oope_payment_method": + "/V1/oope_observability/subscription": get: tags: - - oope_payment_method - description: Retrieves the list of out of process payment methods - operationId: GetV1Oope_payment_method + - oope_observability/subscription + description: Get a list of subscriptions matching criteria + operationId: GetV1Oope_observabilitySubscription consumes: - application/json - application/xml produces: - application/json - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. responses: '200': description: 200 Success. schema: - type: array - items: - "$ref": "#/definitions/out-of-process-payment-methods-data-out-of-process-payment-method-interface" + "$ref": "#/definitions/out-of-process-observability-data-subscription-search-result-interface" '401': description: 401 Unauthorized schema: @@ -11033,12 +11497,12 @@ paths: description: Unexpected error schema: "$ref": "#/definitions/error-response" - summary: oope_payment_method + summary: oope_observability/subscription post: tags: - - oope_payment_method - description: Creates or updates an out of process payment method - operationId: PostV1Oope_payment_method + - oope_observability/subscription + description: Create or update a subscription + operationId: PostV1Oope_observabilitySubscription consumes: - application/json - application/xml @@ -11046,14 +11510,14 @@ paths: - application/json - application/xml parameters: - - name: PostV1Oope_payment_methodBody + - name: PostV1Oope_observabilitySubscriptionBody in: body schema: required: - - payment_method + - subscription properties: - payment_method: - "$ref": "#/definitions/out-of-process-payment-methods-data-out-of-process-payment-method-interface" + subscription: + "$ref": "#/definitions/out-of-process-observability-data-subscription-interface" type: object xml: name: request @@ -11061,22 +11525,25 @@ paths: '200': description: 200 Success. schema: - "$ref": "#/definitions/out-of-process-payment-methods-data-out-of-process-payment-method-interface" + "$ref": "#/definitions/out-of-process-observability-data-subscription-interface" '401': description: 401 Unauthorized schema: "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" default: description: Unexpected error schema: "$ref": "#/definitions/error-response" - summary: oope_payment_method - "/V1/oope_payment_method/{code}": - get: + summary: oope_observability/subscription + put: tags: - - oope_payment_method/{code} - description: Retrieves an out of process payment method - operationId: GetV1Oope_payment_methodCode + - oope_observability/subscription + description: Create or update a subscription + operationId: PutV1Oope_observabilitySubscription consumes: - application/json - application/xml @@ -11084,16 +11551,22 @@ paths: - application/json - application/xml parameters: - - name: code - in: path - type: string - required: true - description: to lookup + - name: PutV1Oope_observabilitySubscriptionBody + in: body + schema: + required: + - subscription + properties: + subscription: + "$ref": "#/definitions/out-of-process-observability-data-subscription-interface" + type: object + xml: + name: request responses: '200': description: 200 Success. schema: - "$ref": "#/definitions/out-of-process-payment-methods-data-out-of-process-payment-method-interface" + "$ref": "#/definitions/out-of-process-observability-data-subscription-interface" '401': description: 401 Unauthorized schema: @@ -11106,40 +11579,47 @@ paths: description: Unexpected error schema: "$ref": "#/definitions/error-response" - summary: oope_payment_method/{code} - "/V1/oope_shipping_carrier": + summary: oope_observability/subscription + "/V1/oope_observability/subscription/{subscriptionId}": get: tags: - - oope_shipping_carrier - description: Get a list of out of process shipping carriers - operationId: GetV1Oope_shipping_carrier + - oope_observability/subscription/{subscriptionId} + description: Get a single subscription by ID + operationId: GetV1Oope_observabilitySubscriptionSubscriptionId consumes: - application/json - application/xml produces: - application/json - application/xml + parameters: + - name: subscriptionId + in: path + type: integer + required: true responses: '200': description: 200 Success. schema: - type: array - items: - "$ref": "#/definitions/out-of-process-shipping-methods-data-out-of-process-carrier-interface" + "$ref": "#/definitions/out-of-process-observability-data-subscription-interface" '401': description: 401 Unauthorized schema: "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" default: description: Unexpected error schema: "$ref": "#/definitions/error-response" - summary: oope_shipping_carrier - post: + summary: oope_observability/subscription/{subscriptionId} + delete: tags: - - oope_shipping_carrier - description: Create or update an out of process shipping carrier - operationId: PostV1Oope_shipping_carrier + - oope_observability/subscription/{subscriptionId} + description: Delete a subscription by ID + operationId: DeleteV1Oope_observabilitySubscriptionSubscriptionId consumes: - application/json - application/xml @@ -11147,44 +11627,207 @@ paths: - application/json - application/xml parameters: - - name: PostV1Oope_shipping_carrierBody - in: body - schema: - required: - - carrier - properties: - carrier: - "$ref": "#/definitions/out-of-process-shipping-methods-data-out-of-process-carrier-interface" - type: object - xml: - name: request + - name: subscriptionId + in: path + type: integer + required: true responses: '200': description: 200 Success. schema: - "$ref": "#/definitions/out-of-process-shipping-methods-data-out-of-process-carrier-interface" + type: boolean '401': description: 401 Unauthorized schema: "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" default: description: Unexpected error schema: "$ref": "#/definitions/error-response" - summary: oope_shipping_carrier - put: + summary: oope_observability/subscription/{subscriptionId} + "/V1/oope_payment_method": + get: tags: - - oope_shipping_carrier - description: Create or update an out of process shipping carrier - operationId: PutV1Oope_shipping_carrier + - oope_payment_method + description: Retrieves the list of out of process payment methods + operationId: GetV1Oope_payment_method consumes: - application/json - application/xml produces: - application/json - application/xml - parameters: - - name: PutV1Oope_shipping_carrierBody + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/out-of-process-payment-methods-data-out-of-process-payment-method-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: oope_payment_method + post: + tags: + - oope_payment_method + description: Creates or updates an out of process payment method + operationId: PostV1Oope_payment_method + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1Oope_payment_methodBody + in: body + schema: + required: + - payment_method + properties: + payment_method: + "$ref": "#/definitions/out-of-process-payment-methods-data-out-of-process-payment-method-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/out-of-process-payment-methods-data-out-of-process-payment-method-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: oope_payment_method + "/V1/oope_payment_method/{code}": + get: + tags: + - oope_payment_method/{code} + description: Retrieves an out of process payment method + operationId: GetV1Oope_payment_methodCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: code + in: path + type: string + required: true + description: to lookup + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/out-of-process-payment-methods-data-out-of-process-payment-method-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: oope_payment_method/{code} + "/V1/oope_shipping_carrier": + get: + tags: + - oope_shipping_carrier + description: Get a list of out of process shipping carriers + operationId: GetV1Oope_shipping_carrier + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/out-of-process-shipping-methods-data-out-of-process-carrier-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: oope_shipping_carrier + post: + tags: + - oope_shipping_carrier + description: Create or update an out of process shipping carrier + operationId: PostV1Oope_shipping_carrier + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1Oope_shipping_carrierBody + in: body + schema: + required: + - carrier + properties: + carrier: + "$ref": "#/definitions/out-of-process-shipping-methods-data-out-of-process-carrier-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/out-of-process-shipping-methods-data-out-of-process-carrier-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: oope_shipping_carrier + put: + tags: + - oope_shipping_carrier + description: Create or update an out of process shipping carrier + operationId: PutV1Oope_shipping_carrier + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1Oope_shipping_carrierBody in: body schema: required: @@ -13509,6 +14152,52 @@ paths: schema: "$ref": "#/definitions/error-response" summary: products/downloadable-links/{id} + "/V1/products/external-media/asset": + post: + tags: + - products/external-media/asset + description: POST endpoint to replace existing assets for a product + operationId: PostV1ProductsExternalmediaAsset + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ProductsExternalmediaAssetBody + in: body + schema: + required: + - sku + properties: + sku: + type: string + videos: + type: array + items: + "$ref": "#/definitions/adobe-assets-integration-data-video-item-interface" + images: + type: array + items: + "$ref": "#/definitions/adobe-assets-integration-data-image-item-interface" + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/external-media/asset "/V1/products/external-media/get-sku/assetId/{assetId}": get: tags: @@ -13718,6 +14407,32 @@ paths: schema: "$ref": "#/definitions/error-response" summary: products/external-media/remove-by-sku + "/V1/products/external-media/version": + get: + tags: + - products/external-media/version + description: GET extension version + operationId: GetV1ProductsExternalmediaVersion + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: string + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/external-media/version "/V1/products/external-media/video": post: tags: @@ -19215,6 +19930,8 @@ definitions: type: array items: type: integer + uid: + type: string customer-data-group-search-results-interface: type: object description: Interface for customer groups search results. @@ -19690,9 +20407,13 @@ definitions: converter: type: string description: Event field converter + source: + type: string + description: Event field source required: - name - converter + - source adobe-commerce-events-client-data-event-rule-interface: type: object description: Interface for event rule data from webapi requests @@ -19825,6 +20546,8 @@ definitions: description: Webhook headers items: "$ref": "#/definitions/adobe-commerce-webhooks-data-hook-header-interface" + developer_console_oauth: + "$ref": "#/definitions/adobe-commerce-webhooks-data-developer-console-oauth-interface" required: - webhook_method - webhook_type @@ -19885,6 +20608,27 @@ definitions: required: - name - value + adobe-commerce-webhooks-data-developer-console-oauth-interface: + type: object + description: Interface for Developer Console OAuth data from webapi requests. + properties: + client_id: + type: string + description: The Developer Console OAuth client ID. + client_secret: + type: string + description: The Developer Console OAuth client secret. + org_id: + type: string + description: The Developer Console OAuth org ID. + environment: + type: string + description: The Developer Console OAuth environment. + required: + - client_id + - client_secret + - org_id + - environment framework-search-search-result-interface: type: object description: Interface SearchResultInterface @@ -20068,8 +20812,6 @@ definitions: type: array items: "$ref": "#/definitions/catalog-data-category-link-interface" - stock_item: - "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" discounts: type: array items: @@ -20078,6 +20820,8 @@ definitions: type: array items: "$ref": "#/definitions/bundle-data-option-interface" + stock_item: + "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" configurable_product_options: type: array items: @@ -20114,112 +20858,16 @@ definitions: catalog-data-category-link-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CategoryLinkInterface - catalog-inventory-data-stock-item-interface: + sales-rule-data-rule-discount-interface: type: object - description: Interface StockItem + description: Rule discount Interface properties: - item_id: - type: integer - product_id: - type: integer - stock_id: - type: integer - description: Stock identifier - qty: - type: number - is_in_stock: - type: boolean - description: Stock Availability - is_qty_decimal: - type: boolean - show_default_notification_message: - type: boolean - use_config_min_qty: - type: boolean - min_qty: - type: number - description: Minimal quantity available for item status in stock - use_config_min_sale_qty: - type: integer - min_sale_qty: - type: number - description: Minimum Qty Allowed in Shopping Cart or NULL when there is no - limitation - use_config_max_sale_qty: - type: boolean - max_sale_qty: - type: number - description: Maximum Qty Allowed in Shopping Cart data wrapper - use_config_backorders: - type: boolean - backorders: - type: integer - description: Backorders status - use_config_notify_stock_qty: - type: boolean - notify_stock_qty: - type: number - description: Notify for Quantity Below data wrapper - use_config_qty_increments: - type: boolean - qty_increments: - type: number - description: Quantity Increments data wrapper - use_config_enable_qty_inc: - type: boolean - enable_qty_increments: - type: boolean - description: Whether Quantity Increments is enabled - use_config_manage_stock: - type: boolean - manage_stock: - type: boolean - description: Can Manage Stock - low_stock_date: - type: string - is_decimal_divided: - type: boolean - stock_status_changed_auto: - type: integer - extension_attributes: - "$ref": "#/definitions/catalog-inventory-data-stock-item-extension-interface" - required: - - qty - - is_in_stock - - is_qty_decimal - - show_default_notification_message - - use_config_min_qty - - min_qty - - use_config_min_sale_qty - - min_sale_qty - - use_config_max_sale_qty - - max_sale_qty - - use_config_backorders - - backorders - - use_config_notify_stock_qty - - notify_stock_qty - - use_config_qty_increments - - qty_increments - - use_config_enable_qty_inc - - enable_qty_increments - - use_config_manage_stock - - manage_stock - - low_stock_date - - is_decimal_divided - - stock_status_changed_auto - catalog-inventory-data-stock-item-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\CatalogInventory\Api\Data\StockItemInterface - sales-rule-data-rule-discount-interface: - type: object - description: Rule discount Interface - properties: - discount_data: - "$ref": "#/definitions/sales-rule-data-discount-data-interface" - rule_label: - type: string - description: Rule Label - rule_i_d: + discount_data: + "$ref": "#/definitions/sales-rule-data-discount-data-interface" + rule_label: + type: string + description: Rule Label + rule_i_d: type: integer description: Rule ID required: @@ -20319,6 +20967,102 @@ definitions: bundle-data-option-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\OptionInterface + catalog-inventory-data-stock-item-interface: + type: object + description: Interface StockItem + properties: + item_id: + type: integer + product_id: + type: integer + stock_id: + type: integer + description: Stock identifier + qty: + type: number + is_in_stock: + type: boolean + description: Stock Availability + is_qty_decimal: + type: boolean + show_default_notification_message: + type: boolean + use_config_min_qty: + type: boolean + min_qty: + type: number + description: Minimal quantity available for item status in stock + use_config_min_sale_qty: + type: integer + min_sale_qty: + type: number + description: Minimum Qty Allowed in Shopping Cart or NULL when there is no + limitation + use_config_max_sale_qty: + type: boolean + max_sale_qty: + type: number + description: Maximum Qty Allowed in Shopping Cart data wrapper + use_config_backorders: + type: boolean + backorders: + type: integer + description: Backorders status + use_config_notify_stock_qty: + type: boolean + notify_stock_qty: + type: number + description: Notify for Quantity Below data wrapper + use_config_qty_increments: + type: boolean + qty_increments: + type: number + description: Quantity Increments data wrapper + use_config_enable_qty_inc: + type: boolean + enable_qty_increments: + type: boolean + description: Whether Quantity Increments is enabled + use_config_manage_stock: + type: boolean + manage_stock: + type: boolean + description: Can Manage Stock + low_stock_date: + type: string + is_decimal_divided: + type: boolean + stock_status_changed_auto: + type: integer + extension_attributes: + "$ref": "#/definitions/catalog-inventory-data-stock-item-extension-interface" + required: + - qty + - is_in_stock + - is_qty_decimal + - show_default_notification_message + - use_config_min_qty + - min_qty + - use_config_min_sale_qty + - min_sale_qty + - use_config_max_sale_qty + - max_sale_qty + - use_config_backorders + - backorders + - use_config_notify_stock_qty + - notify_stock_qty + - use_config_qty_increments + - qty_increments + - use_config_enable_qty_inc + - enable_qty_increments + - use_config_manage_stock + - manage_stock + - low_stock_date + - is_decimal_divided + - stock_status_changed_auto + catalog-inventory-data-stock-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\CatalogInventory\Api\Data\StockItemInterface configurable-product-data-option-interface: type: object description: Interface OptionInterface @@ -22704,129 +23448,20 @@ definitions: - base_original_price_incl_tax - negotiated_price_type - negotiated_price_value - catalog-inventory-data-stock-item-collection-interface: - type: object - description: Interface StockItemCollectionInterface - properties: - items: - type: array - description: Items - items: - "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" - search_criteria: - "$ref": "#/definitions/catalog-inventory-stock-item-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - catalog-inventory-stock-item-criteria-interface: + sales-data-order-interface: type: object - description: Interface StockItemCriteriaInterface + description: Order interface. An order is a document that a web store issues to + a customer. Magento generates a sales order that lists the product items, billing + and shipping addresses, and shipping and payment methods. A corresponding external + document, known as a purchase order, is emailed to the customer. properties: - mapper_interface_name: - type: string - description: Associated Mapper Interface name - criteria_list: - type: array - description: Criteria objects added to current Composite Criteria - items: - "$ref": "#/definitions/framework-criteria-interface" - filters: - type: array - description: List of filters - items: - type: string - orders: - type: array - description: Ordering criteria - items: - type: string - limit: - type: array - description: Limit - items: - type: string - required: - - mapper_interface_name - - criteria_list - - filters - - orders - - limit - framework-criteria-interface: - type: object - description: Interface CriteriaInterface - properties: - mapper_interface_name: - type: string - description: Associated Mapper Interface name - criteria_list: - type: array - description: Criteria objects added to current Composite Criteria - items: - "$ref": "#/definitions/framework-criteria-interface" - filters: - type: array - description: List of filters - items: - type: string - orders: - type: array - description: Ordering criteria - items: - type: string - limit: - type: array - description: Limit - items: - type: string - required: - - mapper_interface_name - - criteria_list - - filters - - orders - - limit - catalog-inventory-data-stock-status-interface: - type: object - description: Interface StockStatusInterface - properties: - product_id: - type: integer - stock_id: - type: integer - qty: - type: integer - stock_status: - type: integer - stock_item: - "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" - extension_attributes: - "$ref": "#/definitions/catalog-inventory-data-stock-status-extension-interface" - required: - - product_id - - stock_id - - qty - - stock_status - - stock_item - catalog-inventory-data-stock-status-extension-interface: - type: object - description: ExtensionInterface class for @see \Magento\CatalogInventory\Api\Data\StockStatusInterface - sales-data-order-interface: - type: object - description: Order interface. An order is a document that a web store issues to - a customer. Magento generates a sales order that lists the product items, billing - and shipping addresses, and shipping and payment methods. A corresponding external - document, known as a purchase order, is emailed to the customer. - properties: - adjustment_negative: - type: number - description: Negative adjustment value. - adjustment_positive: - type: number - description: Positive adjustment value. - applied_rule_ids: + adjustment_negative: + type: number + description: Negative adjustment value. + adjustment_positive: + type: number + description: Positive adjustment value. + applied_rule_ids: type: string description: Applied rule IDs. base_adjustment_negative: @@ -24105,10 +24740,6 @@ definitions: type: array items: "$ref": "#/definitions/tax-data-order-tax-item-interface" - custom_fees: - type: array - items: - "$ref": "#/definitions/admin-ui-sdk-custom-fees-data-custom-fees-interface" gift_cards: type: array items: @@ -24217,12 +24848,6 @@ definitions: type: string gw_card_tax_refunded: type: string - pickup_location_code: - type: string - notification_sent: - type: integer - send_notification: - type: integer coupon_codes: type: array items: @@ -24231,12 +24856,22 @@ definitions: type: array items: type: string + pickup_location_code: + type: string + notification_sent: + type: integer + send_notification: + type: integer reward_points_balance: type: integer reward_currency_amount: type: number base_reward_currency_amount: type: number + custom_fees: + type: array + items: + "$ref": "#/definitions/admin-ui-sdk-custom-fees-data-custom-fees-interface" sales-data-shipping-assignment-interface: type: object description: Interface ShippingAssignmentInterface @@ -24494,6 +25129,27 @@ definitions: tax-data-order-tax-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Tax\Api\Data\OrderTaxInterface + gift-card-account-data-gift-card-interface: + type: object + description: Gift Card data + properties: + id: + type: integer + description: Id + code: + type: string + description: Code + amount: + type: number + description: Amount + base_amount: + type: number + description: Base Amount + required: + - id + - code + - amount + - base_amount admin-ui-sdk-custom-fees-data-custom-fees-interface: type: object description: Interface CustomFeesInterface @@ -24552,27 +25208,6 @@ definitions: - base_custom_fee_amount_refunded - apply_fee_on_last_invoice - apply_fee_on_last_creditmemo - gift-card-account-data-gift-card-interface: - type: object - description: Gift Card data - properties: - id: - type: integer - description: Id - code: - type: string - description: Code - amount: - type: number - description: Amount - base_amount: - type: number - description: Base Amount - required: - - id - - code - - amount - - base_amount sales-data-order-search-result-interface: type: object description: Order search result interface. An order is a document that a web @@ -25928,6 +26563,9 @@ definitions: sales-data-invoice-creation-arguments-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceCreationArgumentsInterface + properties: + custom_capture_amount: + type: number sales-rule-data-rule-interface: type: object description: Interface RuleInterface @@ -26247,6 +26885,115 @@ definitions: bundle-data-option-type-extension-interface: type: object description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\OptionTypeInterface + catalog-inventory-data-stock-item-collection-interface: + type: object + description: Interface StockItemCollectionInterface + properties: + items: + type: array + description: Items + items: + "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" + search_criteria: + "$ref": "#/definitions/catalog-inventory-stock-item-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + catalog-inventory-stock-item-criteria-interface: + type: object + description: Interface StockItemCriteriaInterface + properties: + mapper_interface_name: + type: string + description: Associated Mapper Interface name + criteria_list: + type: array + description: Criteria objects added to current Composite Criteria + items: + "$ref": "#/definitions/framework-criteria-interface" + filters: + type: array + description: List of filters + items: + type: string + orders: + type: array + description: Ordering criteria + items: + type: string + limit: + type: array + description: Limit + items: + type: string + required: + - mapper_interface_name + - criteria_list + - filters + - orders + - limit + framework-criteria-interface: + type: object + description: Interface CriteriaInterface + properties: + mapper_interface_name: + type: string + description: Associated Mapper Interface name + criteria_list: + type: array + description: Criteria objects added to current Composite Criteria + items: + "$ref": "#/definitions/framework-criteria-interface" + filters: + type: array + description: List of filters + items: + type: string + orders: + type: array + description: Ordering criteria + items: + type: string + limit: + type: array + description: Limit + items: + type: string + required: + - mapper_interface_name + - criteria_list + - filters + - orders + - limit + catalog-inventory-data-stock-status-interface: + type: object + description: Interface StockStatusInterface + properties: + product_id: + type: integer + stock_id: + type: integer + qty: + type: integer + stock_status: + type: integer + stock_item: + "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" + extension_attributes: + "$ref": "#/definitions/catalog-inventory-data-stock-status-extension-interface" + required: + - product_id + - stock_id + - qty + - stock_status + - stock_item + catalog-inventory-data-stock-status-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\CatalogInventory\Api\Data\StockStatusInterface checkout-data-shipping-information-interface: type: object description: Interface ShippingInformationInterface @@ -26353,23 +27100,64 @@ definitions: - error_message - request_timestamp - selected_ids - company-data-company-search-results-interface: + commerce-backend-uix-data-order-view-button-failed-request-interface: type: object - description: Interface for company search results + description: Defines the order view button failed requests database model properties: - items: - type: array - description: Companies list - items: - "$ref": "#/definitions/company-data-company-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria + id: + type: string + description: Internal id + request_id: + type: string + description: Request id + button_id: + type: string + description: Button id + order_id: + type: string + description: Order id + error_status: + type: string + description: Error status + error_message: + type: string + description: Error message + request_timestamp: + type: string + description: Request timestamp + required: + - request_id + - button_id + - order_id + - error_status + - error_message + - request_timestamp + commerce-backend-uix-data-app-management-validation-result-interface: + type: object + description: App Management User Validation Result Interface + properties: + authorized: + type: boolean + description: Authorization status + required: + - authorized + company-data-company-search-results-interface: + type: object + description: Interface for company search results + properties: + items: + type: array + description: Companies list + items: + "$ref": "#/definitions/company-data-company-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria - total_count company-data-company-interface: type: object @@ -26458,14 +27246,14 @@ definitions: type: integer quote_config: "$ref": "#/definitions/negotiable-quote-data-company-quote-config-interface" - is_purchase_order_enabled: - type: boolean applicable_shipping_method: type: integer available_shipping_methods: type: string use_config_settings_shipping: type: integer + is_purchase_order_enabled: + type: boolean negotiable-quote-data-company-quote-config-interface: type: object description: Interface CompanyQuoteConfigInterface @@ -27311,6 +28099,37 @@ definitions: required: - company_id - parent_id + gift-card-account-data-gift-card-account-interface: + type: object + description: Gift Card Account data + properties: + gift_cards: + type: array + description: Cards codes. + items: + type: string + gift_cards_amount: + type: number + description: Cards amount in quote currency. + base_gift_cards_amount: + type: number + description: Cards amount in base currency. + gift_cards_amount_used: + type: number + description: Cards amount used in quote currency. + base_gift_cards_amount_used: + type: number + description: Cards amount used in base currency. + extension_attributes: + "$ref": "#/definitions/gift-card-account-data-gift-card-account-extension-interface" + required: + - gift_cards_amount + - base_gift_cards_amount + - gift_cards_amount_used + - base_gift_cards_amount_used + gift-card-account-data-gift-card-account-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface shared-catalog-data-shared-catalog-interface: type: object description: SharedCatalogInterface interface. @@ -27369,48 +28188,87 @@ definitions: - items - search_criteria - total_count - analytics-data-link-interface: + adobe-assets-integration-data-video-item-interface: type: object - description: Represents link with collected data and initialized vector for decryption. + description: Video item Interface. Dto to receive an import video asset. properties: + sku: + type: string + description: Sku + asset_id: + type: string + description: Asset ID + roles: + type: array + description: Roles + items: + type: string + position: + type: integer + description: Position url: type: string - initialization_vector: + description: Video URL + video_thumbnail_url: type: string + description: VideoThumbnailUrl required: + - sku + - asset_id + - roles - url - - initialization_vector - gift-card-account-data-gift-card-account-interface: + - video_thumbnail_url + adobe-assets-integration-data-image-item-interface: type: object - description: Gift Card Account data + description: Image item Interface. Dto to receive an import image asset. properties: - gift_cards: + sku: + type: string + description: Sku + asset_id: + type: string + description: Asset ID + roles: type: array - description: Cards codes. + description: Roles items: type: string - gift_cards_amount: - type: number - description: Cards amount in quote currency. - base_gift_cards_amount: - type: number - description: Cards amount in base currency. - gift_cards_amount_used: - type: number - description: Cards amount used in quote currency. - base_gift_cards_amount_used: - type: number - description: Cards amount used in base currency. - extension_attributes: - "$ref": "#/definitions/gift-card-account-data-gift-card-account-extension-interface" + position: + type: integer + description: Position + url: + type: string + description: Image URL required: - - gift_cards_amount - - base_gift_cards_amount - - gift_cards_amount_used - - base_gift_cards_amount_used - gift-card-account-data-gift-card-account-extension-interface: + - sku + - asset_id + - roles + - url + custom-email-send-data-send-email-response-interface: type: object - description: ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface + description: Response DTO after accepting a custom email for delivery. + properties: + message: + type: string + description: Message (e.g. "Email accepted for delivery"). + reference_id: + type: string + description: Reference ID for this send request. + recipient_email: + type: string + description: Email address. + template_id: + type: integer + description: ID used. + template_code: + type: string + description: Code (name) from the template record. + required: + - message + - reference_id + - recipient_email + - template_id + - template_code out-of-process-payment-methods-data-out-of-process-payment-method-interface: type: object description: '' @@ -27833,54 +28691,6 @@ definitions: required: - sku - qty - inventory-distance-based-source-selection-api-data-lat-lng-interface: - type: object - description: DTO for latitude and longitude request - properties: - lat: - type: number - description: Latitude - lng: - type: number - description: Longitude - required: - - lat - - lng - inventory-export-stock-api-data-export-stock-salable-qty-search-result-interface: - type: object - description: Interface for ExportStockSalableQtySearchResult - properties: - items: - type: array - items: - "$ref": "#/definitions/framework-extensible-data-interface" - search_criteria: - "$ref": "#/definitions/framework-search-criteria-interface" - total_count: - type: integer - description: Total count. - required: - - items - - search_criteria - - total_count - inventory-export-stock-api-data-product-stock-index-data-interface: - type: object - description: Class ExportStockIndexDataResultInterface for result Inventory stock - index dump export - properties: - sku: - type: string - description: Product SKU - qty: - type: number - description: Product QTY - is_salable: - type: boolean - description: Product is salable flag - required: - - sku - - qty - - is_salable inventory-sales-api-data-is-product-salable-result-interface: type: object description: Represents "is product salable" result interface. @@ -27965,6 +28775,54 @@ definitions: inventory-sales-api-data-is-product-salable-for-requested-qty-result-extension-interface: type: object description: ExtensionInterface class for @see \Magento\InventorySalesApi\Api\Data\IsProductSalableForRequestedQtyResultInterface + inventory-distance-based-source-selection-api-data-lat-lng-interface: + type: object + description: DTO for latitude and longitude request + properties: + lat: + type: number + description: Latitude + lng: + type: number + description: Longitude + required: + - lat + - lng + inventory-export-stock-api-data-export-stock-salable-qty-search-result-interface: + type: object + description: Interface for ExportStockSalableQtySearchResult + properties: + items: + type: array + items: + "$ref": "#/definitions/framework-extensible-data-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + inventory-export-stock-api-data-product-stock-index-data-interface: + type: object + description: Class ExportStockIndexDataResultInterface for result Inventory stock + index dump export + properties: + sku: + type: string + description: Product SKU + qty: + type: number + description: Product QTY + is_salable: + type: boolean + description: Product is salable flag + required: + - sku + - qty + - is_salable inventory-source-selection-api-data-source-selection-algorithm-interface: type: object description: Data Interface representing particular Source Selection Algorithm @@ -28387,6 +29245,84 @@ definitions: - items - search_criteria - total_count + otp-rest-data-otp-response-interface: + type: object + description: Response containing the one-time password for customer login. + properties: + otp: + type: string + description: The one-time password. + required: + - otp + out-of-process-observability-data-subscription-search-result-interface: + type: object + description: Search result interface for observability subscriptions + properties: + items: + type: array + items: + "$ref": "#/definitions/out-of-process-observability-data-subscription-interface" + required: + - items + out-of-process-observability-data-subscription-interface: + type: object + description: Observability Subscription data interface + properties: + id: + type: integer + description: Entity ID + type: + type: string + description: A subscription type, (logs, metrics) + destination_endpoint: + type: string + description: A destination endpoint for the subscription + component: + type: array + description: The component type for the subscription (eq. "event", "webhook", + "admin-ui-sdk") + items: + type: string + headers: + type: array + description: The request headers for the subscription + items: + "$ref": "#/definitions/out-of-process-observability-data-subscription-header-interface" + service_name: + type: string + description: The service name for the subscription + is_active: + type: boolean + description: If the subscription is active + log_message_settings: + type: array + description: The configured log message settings for the subscription + items: + type: string + required: + - destination_endpoint + - component + - headers + - service_name + - is_active + - log_message_settings + out-of-process-observability-data-subscription-header-interface: + type: object + description: Observability Subscription Header data interface + properties: + name: + type: string + description: Header name + value: + type: string + description: Header value + secret: + type: boolean + description: If header value is secret + required: + - name + - value + - secret out-of-process-shipping-methods-data-out-of-process-carrier-interface: type: object description: Shipping carrier interface for out of process shipping carriers @@ -28449,11 +29385,24 @@ definitions: description: list of store codes items: type: string + credit_memo_tax_enabled: + type: boolean + description: If credit memo tax calculation is enabled required: - code - title - active - stores + - credit_memo_tax_enabled + adobe-commerce-webhooks-core-saas-data-supported-webhook-interface: + type: object + description: Interface for supported webhook data returned in webapi requests + properties: + name: + type: string + description: The supported webhook name + required: + - name rma-data-track-interface: type: object description: Interface TrackInterface @@ -28717,6 +29666,39 @@ definitions: description: Code of the attribute. required: - attribute_code + s3-presigned-upload-data-initiate-upload-response-interface: + type: object + description: Data interface representing presigned URL response payload. Contains + the presigned upload URL, the server-generated unique key that identifies the + object for finish upload, and the expiration timestamp. + properties: + upload_url: + type: string + description: The presigned URL to upload directly to S3. + key: + type: string + description: The unique key (hashed filename) to be used in the finish step. + expires_at: + type: integer + description: UNIX timestamp when the presigned URL expires. + required: + - upload_url + - key + - expires_at + s3-presigned-upload-data-finish-upload-response-interface: + type: object + description: Data interface representing the finish result of a presigned upload. + Indicates whether the finish was successful and returns the final filename. + properties: + success: + type: boolean + description: The finish was successful. + key: + type: string + description: Final filename stored in destination. + required: + - success + - key adobe-commerce-events-core-saas-data-supported-event-interface: type: object description: Interface for supported event data returned in webapi requests @@ -28726,22 +29708,65 @@ definitions: description: The supported event name required: - name - adobe-commerce-webhooks-core-saas-data-supported-webhook-interface: + customer-segment-storefront-compatibility-data-customer-segment-search-results-interface: type: object - description: Interface for supported webhook data returned in webapi requests + description: '' properties: + items: + type: array + description: Customer segments list. + items: + "$ref": "#/definitions/customer-segment-storefront-compatibility-data-customer-segment-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + customer-segment-storefront-compatibility-data-customer-segment-interface: + type: object + description: '' + properties: + id: + type: integer + description: Segment ID. + uid: + type: string + description: Segment UID. name: type: string - description: The supported webhook name + description: Segment name. + description: + type: string + description: Segment description. + is_active: + type: integer + description: Segment active status. + apply_to: + type: integer + description: Apply-to value. + number_of_customers: + type: integer + description: Number of customers the segment applies to. + associated_websites: + type: array + description: Associated websites for the segments + items: + "$ref": "#/definitions/store-data-website-interface" required: - - name + - associated_websites x-tagGroups: - name: addresses tags: - addresses/{addressId} - name: adminuisdk tags: + - adminuisdk/appmanagement/validate - adminuisdk/massaction/{request_id} + - adminuisdk/orderviewbutton/{request_id} - name: adobe_io_events tags: - adobe_io_events/check_configuration @@ -28751,9 +29776,6 @@ x-tagGroups: - adobestock/asset/search - adobestock/asset/{id} - adobestock/search -- name: analytics - tags: - - analytics/link - name: attributeMetadata tags: - attributeMetadata/customer @@ -28792,6 +29814,7 @@ x-tagGroups: - carts/{cartId}/coupons - carts/{cartId}/coupons/deleteByCodes - carts/{cartId}/coupons/{couponCode} + - carts/{cartId}/customAttributes - carts/{cartId}/estimate-shipping-methods - carts/{cartId}/estimate-shipping-methods-by-address-id - carts/{cartId}/gift-message @@ -28871,6 +29894,9 @@ x-tagGroups: - name: creditmemos tags: - creditmemos +- name: custom email + tags: + - custom-email/send - name: customerGroups tags: - customerGroups @@ -28880,11 +29906,16 @@ x-tagGroups: - customerGroups/search - customerGroups/{id} - customerGroups/{id}/permissions +- name: customerSegments + tags: + - customerSegments/search - name: customers tags: + - customers - customers/addresses/{addressId} - customers/companies - customers/confirm + - customers/otp - customers/search - customers/validate - customers/{customerId} @@ -28895,6 +29926,7 @@ x-tagGroups: - customers/{customerId}/confirm - customers/{customerId}/permissions/readonly - customers/{customerId}/shippingAddress + - customers/{customerId}/token - customers/{email}/activate - name: eav tags: @@ -28969,6 +30001,10 @@ x-tagGroups: - invoices/{id}/comments - invoices/{id}/emails - invoices/{id}/void +- name: media + tags: + - media/finish-upload + - media/initiate-upload - name: modules tags: - modules @@ -29002,6 +30038,10 @@ x-tagGroups: - negotiableQuoteTemplate/request - negotiableQuoteTemplate/submitToCustomer - negotiableQuoteTemplate/{templateId} +- name: oope_observability + tags: + - oope_observability/subscription + - oope_observability/subscription/{subscriptionId} - name: oope_payment_method tags: - oope_payment_method @@ -29061,12 +30101,14 @@ x-tagGroups: - products/cost-information - products/downloadable-links/samples/{id} - products/downloadable-links/{id} + - products/external-media/asset - products/external-media/get-sku/assetId/{assetId} - products/external-media/image - products/external-media/ping - products/external-media/remove-by-asset-id - products/external-media/remove-by-asset-id-and-sku - products/external-media/remove-by-sku + - products/external-media/version - products/external-media/video - products/links/types - products/links/{type}/attributes diff --git a/src/openapi/admin-schema-2.4.9-beta-1.yaml b/src/openapi/admin-schema-2.4.9-beta-1.yaml new file mode 100644 index 000000000..31d73755e --- /dev/null +++ b/src/openapi/admin-schema-2.4.9-beta-1.yaml @@ -0,0 +1,37205 @@ +--- +securityDefinitions: + api_key: + type: apiKey + name: api_key + in: header +swagger: '2.0' +info: + version: 2.4.9-beta-1 + title: Commerce Admin REST endpoints - All inclusive + description: + "$ref": "../_includes/redocly-intro.md" +host: example.com +basePath: "/rest/default" +schemes: +- http +tags: +- name: addresses/{addressId} +- name: adminuisdk/appmanagement/validate +- name: adminuisdk/massaction/{request_id} +- name: adminuisdk/orderviewbutton/{request_id} +- name: adobe_io_events/check_configuration +- name: adobestock/asset/{id} +- name: adobestock/asset/list +- name: adobestock/asset/search +- name: adobestock/search +- name: analytics/link +- name: applepay/auth +- name: attributeMetadata/customer +- name: attributeMetadata/customer/attribute/{attributeCode} +- name: attributeMetadata/customer/custom +- name: attributeMetadata/customer/form/{formCode} +- name: attributeMetadata/customerAddress +- name: attributeMetadata/customerAddress/attribute/{attributeCode} +- name: attributeMetadata/customerAddress/custom +- name: attributeMetadata/customerAddress/form/{formCode} +- name: braintree/mine/payment/vault +- name: bulk +- name: bulk/{bulkUuid}/detailed-status +- name: bulk/{bulkUuid}/operation-status/{status} +- name: bulk/{bulkUuid}/status +- name: bundle-products/{productSku}/children +- name: bundle-products/{sku}/links/{id} +- name: bundle-products/{sku}/links/{optionId} +- name: bundle-products/{sku}/options/{optionId} +- name: bundle-products/{sku}/options/{optionId}/children/{childSku} +- name: bundle-products/{sku}/options/all +- name: bundle-products/options/{optionId} +- name: bundle-products/options/add +- name: bundle-products/options/types +- name: carts/ +- name: carts/{cartId} +- name: carts/{cartId}/billing-address +- name: carts/{cartId}/coupons +- name: carts/{cartId}/coupons/{couponCode} +- name: carts/{cartId}/coupons/deleteByCodes +- name: carts/{cartId}/estimate-shipping-methods +- name: carts/{cartId}/estimate-shipping-methods-by-address-id +- name: carts/{cartId}/gift-message +- name: carts/{cartId}/gift-message/{itemId} +- name: carts/{cartId}/giftCards +- name: carts/{cartId}/giftCards/{giftCardCode} +- name: carts/{cartId}/items +- name: carts/{cartId}/items/{itemId} +- name: carts/{cartId}/order +- name: carts/{cartId}/payment-methods +- name: carts/{cartId}/selected-payment-method +- name: carts/{cartId}/shipping-information +- name: carts/{cartId}/shipping-methods +- name: carts/{cartId}/totals +- name: carts/{cartId}/totals-information +- name: carts/{quoteId}/giftCards +- name: carts/{quoteId}/items +- name: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} +- name: carts/guest-carts/{cartId}/giftCards +- name: carts/guest-carts/{cartId}/giftCards/{giftCardCode} +- name: carts/licence +- name: carts/licence/list +- name: carts/mine +- name: carts/mine/balance/apply +- name: carts/mine/billing-address +- name: carts/mine/checkGiftCard/{giftCardCode} +- name: carts/mine/collect-totals +- name: carts/mine/coupons +- name: carts/mine/coupons/{couponCode} +- name: carts/mine/coupons/deleteByCodes +- name: carts/mine/estimate-shipping-methods +- name: carts/mine/estimate-shipping-methods-by-address-id +- name: carts/mine/gift-message +- name: carts/mine/gift-message/{itemId} +- name: carts/mine/giftCards +- name: carts/mine/giftCards/{giftCardCode} +- name: carts/mine/items +- name: carts/mine/items/{itemId} +- name: carts/mine/order +- name: carts/mine/payment-information +- name: carts/mine/payment-methods +- name: carts/mine/payment-order +- name: carts/mine/payment-order/{id} +- name: carts/mine/po-payment-information +- name: carts/mine/selected-payment-method +- name: carts/mine/set-payment-information +- name: carts/mine/shipping-information +- name: carts/mine/shipping-methods +- name: carts/mine/totals +- name: carts/mine/totals-information +- name: carts/search +- name: categories +- name: categories/{categoryId} +- name: categories/{categoryId}/move +- name: categories/{categoryId}/products +- name: categories/{categoryId}/products/{sku} +- name: categories/{id} +- name: categories/attributes +- name: categories/attributes/{attributeCode} +- name: categories/attributes/{attributeCode}/options +- name: categories/list +- name: cmsBlock +- name: cmsBlock/{blockId} +- name: cmsBlock/{id} +- name: cmsBlock/search +- name: cmsPage +- name: cmsPage/{id} +- name: cmsPage/{pageId} +- name: cmsPage/search +- name: company/ +- name: company/{companyId} +- name: company/{parentId}/relations +- name: company/{parentId}/relations/{companyId} +- name: company/assignRoles +- name: company/relations +- name: company/role/ +- name: company/role/{id} +- name: company/role/{roleId} +- name: company/role/{roleId}/users +- name: companyCredits/ +- name: companyCredits/{creditId} +- name: companyCredits/{creditId}/decreaseBalance +- name: companyCredits/{creditId}/increaseBalance +- name: companyCredits/{id} +- name: companyCredits/company/{companyId} +- name: companyCredits/history +- name: companyCredits/history/{historyId} +- name: configurable-products/{sku}/child +- name: configurable-products/{sku}/children +- name: configurable-products/{sku}/children/{childSku} +- name: configurable-products/{sku}/options +- name: configurable-products/{sku}/options/{id} +- name: configurable-products/{sku}/options/all +- name: configurable-products/variation +- name: coupons +- name: coupons/{couponId} +- name: coupons/deleteByCodes +- name: coupons/deleteByIds +- name: coupons/generate +- name: coupons/search +- name: creditmemo +- name: creditmemo/{id} +- name: creditmemo/{id}/comments +- name: creditmemo/{id}/emails +- name: creditmemo/refund +- name: creditmemos +- name: customerGroups +- name: customerGroups/{id} +- name: customerGroups/{id}/permissions +- name: customerGroups/default +- name: customerGroups/default/{id} +- name: customerGroups/default/{storeId} +- name: customerGroups/search +- name: customers +- name: customers/{customerId} +- name: customers/{customerId}/billingAddress +- name: customers/{customerId}/carts +- name: customers/{customerId}/companies +- name: customers/{customerId}/companies/{companyId} +- name: customers/{customerId}/confirm +- name: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} +- name: customers/{customerId}/permissions/readonly +- name: customers/{customerId}/shippingAddress +- name: customers/{customerId}/token +- name: customers/{email}/activate +- name: customers/activate +- name: customers/addresses/{addressId} +- name: customers/companies +- name: customers/confirm +- name: customers/isEmailAvailable +- name: customers/me +- name: customers/me/activate +- name: customers/me/billingAddress +- name: customers/me/password +- name: customers/me/shippingAddress +- name: customers/password +- name: customers/resetPassword +- name: customers/search +- name: customers/validate +- name: directory/countries +- name: directory/countries/{countryId} +- name: directory/currency +- name: eav/attribute-sets +- name: eav/attribute-sets/{attributeSetId} +- name: eav/attribute-sets/list +- name: eventing/eventProvider +- name: eventing/eventProvider/{providerId} +- name: eventing/eventSubscribe +- name: eventing/eventSubscribe/{name} +- name: eventing/eventUnsubscribe/{name} +- name: eventing/getEventProviders +- name: eventing/getEventSubscriptions +- name: eventing/updateConfiguration +- name: gift-wrappings +- name: gift-wrappings/{id} +- name: gift-wrappings/{wrappingId} +- name: giftregistry/mine/estimate-shipping-methods +- name: guest-carts +- name: guest-carts/{cartId} +- name: guest-carts/{cartId}/billing-address +- name: guest-carts/{cartId}/collect-totals +- name: guest-carts/{cartId}/coupons +- name: guest-carts/{cartId}/coupons/{couponCode} +- name: guest-carts/{cartId}/estimate-shipping-methods +- name: guest-carts/{cartId}/gift-message +- name: guest-carts/{cartId}/gift-message/{itemId} +- name: guest-carts/{cartId}/items +- name: guest-carts/{cartId}/items/{itemId} +- name: guest-carts/{cartId}/order +- name: guest-carts/{cartId}/payment-information +- name: guest-carts/{cartId}/payment-methods +- name: guest-carts/{cartId}/payment-order +- name: guest-carts/{cartId}/payment-order/{id} +- name: guest-carts/{cartId}/selected-payment-method +- name: guest-carts/{cartId}/set-payment-information +- name: guest-carts/{cartId}/shipping-information +- name: guest-carts/{cartId}/shipping-methods +- name: guest-carts/{cartId}/totals +- name: guest-carts/{cartId}/totals-information +- name: guest-giftregistry/{cartId}/estimate-shipping-methods +- name: hierarchy/{id} +- name: hierarchy/move/{id} +- name: import/csv +- name: import/json +- name: integration/admin/token +- name: integration/customer/revoke-customer-token +- name: integration/customer/token +- name: inventory/are-product-salable-for-requested-qty/ +- name: inventory/are-products-salable +- name: inventory/bulk-partial-source-transfer +- name: inventory/bulk-product-source-assign +- name: inventory/bulk-product-source-transfer +- name: inventory/bulk-product-source-unassign +- name: inventory/dump-stock-index-data/{salesChannelType}/{salesChannelCode} +- name: inventory/export-stock-salable-qty/{salesChannelType}/{salesChannelCode} +- name: inventory/get-distance +- name: inventory/get-distance-provider-code +- name: inventory/get-latlng-from-address +- name: inventory/get-latslngs-from-address +- name: inventory/get-product-salable-quantity/{sku}/{stockId} +- name: inventory/get-sources-assigned-to-stock-ordered-by-priority/{stockId} +- name: inventory/in-store-pickup/pickup-locations/ +- name: inventory/is-product-salable-for-requested-qty/{sku}/{stockId}/{requestedQty} +- name: inventory/is-product-salable/{sku}/{stockId} +- name: inventory/low-quantity-notification +- name: inventory/low-quantity-notification/{sourceCode}/{sku} +- name: inventory/low-quantity-notifications-delete +- name: inventory/source-items +- name: inventory/source-items-delete +- name: inventory/source-selection-algorithm-list +- name: inventory/source-selection-algorithm-result +- name: inventory/sources +- name: inventory/sources/{sourceCode} +- name: inventory/stock-resolver/{type}/{code} +- name: inventory/stock-source-links +- name: inventory/stock-source-links-delete +- name: inventory/stocks +- name: inventory/stocks/{stockId} +- name: invoice/{invoiceId}/refund +- name: invoices +- name: invoices/ +- name: invoices/{id} +- name: invoices/{id}/capture +- name: invoices/{id}/comments +- name: invoices/{id}/emails +- name: invoices/{id}/void +- name: invoices/comments +- name: modules +- name: negotiable-cart-item-note +- name: negotiable-cart-item-note/{noteId} +- name: negotiable-cart-item-note/search +- name: negotiable-carts/{cartId}/billing-address +- name: negotiable-carts/{cartId}/coupons +- name: negotiable-carts/{cartId}/coupons/{couponCode} +- name: negotiable-carts/{cartId}/estimate-shipping-methods +- name: negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id +- name: negotiable-carts/{cartId}/giftCards +- name: negotiable-carts/{cartId}/giftCards/{giftCardCode} +- name: negotiable-carts/{cartId}/payment-information +- name: negotiable-carts/{cartId}/po-payment-information +- name: negotiable-carts/{cartId}/set-payment-information +- name: negotiable-carts/{cartId}/shipping-information +- name: negotiable-carts/{cartId}/totals +- name: negotiableQuote/{negotiableQuoteId}/duplicate +- name: negotiableQuote/{quoteId} +- name: negotiableQuote/{quoteId}/comments +- name: negotiableQuote/{quoteId}/shippingMethod +- name: negotiableQuote/attachmentContent +- name: negotiableQuote/decline +- name: negotiableQuote/draft +- name: negotiableQuote/pricesUpdated +- name: negotiableQuote/request +- name: negotiableQuote/submitToCustomer +- name: negotiableQuoteTemplate +- name: negotiableQuoteTemplate/{templateId} +- name: negotiableQuoteTemplate/accept +- name: negotiableQuoteTemplate/cancel +- name: negotiableQuoteTemplate/cancel/me +- name: negotiableQuoteTemplate/decline +- name: negotiableQuoteTemplate/draft +- name: negotiableQuoteTemplate/generateQuote +- name: negotiableQuoteTemplate/me +- name: negotiableQuoteTemplate/me/{templateId} +- name: negotiableQuoteTemplate/open +- name: negotiableQuoteTemplate/open/me +- name: negotiableQuoteTemplate/referenceDocumentLink +- name: negotiableQuoteTemplate/referenceDocumentLink/{linkId} +- name: negotiableQuoteTemplate/request +- name: negotiableQuoteTemplate/request/me +- name: negotiableQuoteTemplate/submitToCustomer +- name: negotiableQuoteTemplate/submitToSeller +- name: order/{orderId}/invoice +- name: order/{orderId}/refund +- name: order/{orderId}/ship +- name: order/notify-orders-are-ready-for-pickup +- name: orders +- name: orders/{id} +- name: orders/{id}/cancel +- name: orders/{id}/comments +- name: orders/{id}/emails +- name: orders/{id}/hold +- name: orders/{id}/statuses +- name: orders/{id}/unhold +- name: orders/{parent_id} +- name: orders/create +- name: orders/items +- name: orders/items/{id} +- name: payment-order/completeOrder +- name: payments-config/{location} +- name: payments-config/apple-pay/{location} +- name: payments-config/google-pay/{location} +- name: payments-config/hosted-fields/{location} +- name: payments-config/smart-buttons/{location} +- name: payments-sdk/{location} +- name: payments-sdk/{location}/{methodCode} +- name: paypal/lineItems +- name: paypal/oneClick +- name: paypal/validatePhoneNumber +- name: products +- name: products-render-info +- name: products/{productSku}/stockItems/{itemId} +- name: products/{sku} +- name: products/{sku}/downloadable-links +- name: products/{sku}/downloadable-links/{id} +- name: products/{sku}/downloadable-links/samples +- name: products/{sku}/downloadable-links/samples/{id} +- name: products/{sku}/group-prices/{customerGroupId}/tiers +- name: products/{sku}/group-prices/{customerGroupId}/tiers/{qty} +- name: products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price} +- name: products/{sku}/links +- name: products/{sku}/links/{type} +- name: products/{sku}/links/{type}/{linkedProductSku} +- name: products/{sku}/media +- name: products/{sku}/media/{entryId} +- name: products/{sku}/options +- name: products/{sku}/options/{optionId} +- name: products/{sku}/websites +- name: products/{sku}/websites/{websiteId} +- name: products/attribute-sets +- name: products/attribute-sets/{attributeSetId} +- name: products/attribute-sets/{attributeSetId}/attributes +- name: products/attribute-sets/{attributeSetId}/attributes/{attributeCode} +- name: products/attribute-sets/{attributeSetId}/groups +- name: products/attribute-sets/attributes +- name: products/attribute-sets/groups +- name: products/attribute-sets/groups/{groupId} +- name: products/attribute-sets/groups/list +- name: products/attribute-sets/sets/list +- name: products/attributes +- name: products/attributes/{attributeCode} +- name: products/attributes/{attributeCode}/is-filterable +- name: products/attributes/{attributeCode}/is-filterable/{isFilterable} +- name: products/attributes/{attributeCode}/options +- name: products/attributes/{attributeCode}/options/{optionId} +- name: products/attributes/types +- name: products/base-prices +- name: products/base-prices-information +- name: products/cost +- name: products/cost-delete +- name: products/cost-information +- name: products/downloadable-links/{id} +- name: products/downloadable-links/samples/{id} +- name: products/links/{type}/attributes +- name: products/links/types +- name: products/media/types/{attributeSetName} +- name: products/options +- name: products/options/{optionId} +- name: products/options/types +- name: products/special-price +- name: products/special-price-delete +- name: products/special-price-information +- name: products/tier-prices +- name: products/tier-prices-delete +- name: products/tier-prices-information +- name: products/types +- name: purchase-order-carts/{cartId}/billing-address +- name: purchase-order-carts/{cartId}/estimate-shipping-methods +- name: purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id +- name: purchase-order-carts/{cartId}/giftCards +- name: purchase-order-carts/{cartId}/giftCards/{giftCardCode} +- name: purchase-order-carts/{cartId}/payment-information +- name: purchase-order-carts/{cartId}/set-payment-information +- name: purchase-order-carts/{cartId}/totals +- name: requisition_lists +- name: returns +- name: returns/{id} +- name: returns/{id}/comments +- name: returns/{id}/labels +- name: returns/{id}/tracking-numbers +- name: returns/{id}/tracking-numbers/{trackId} +- name: returnsAttributeMetadata +- name: returnsAttributeMetadata/{attributeCode} +- name: returnsAttributeMetadata/custom +- name: returnsAttributeMetadata/form/{formCode} +- name: reward/mine/use-reward +- name: salesRules +- name: salesRules/{ruleId} +- name: salesRules/search +- name: search +- name: sharedCatalog +- name: sharedCatalog/ +- name: sharedCatalog/{id} +- name: sharedCatalog/{id}/assignCategories +- name: sharedCatalog/{id}/assignProducts +- name: sharedCatalog/{id}/categories +- name: sharedCatalog/{id}/products +- name: sharedCatalog/{id}/unassignCategories +- name: sharedCatalog/{id}/unassignProducts +- name: sharedCatalog/{sharedCatalogId} +- name: sharedCatalog/{sharedCatalogId}/assignCompanies +- name: sharedCatalog/{sharedCatalogId}/assignTierPrices +- name: sharedCatalog/{sharedCatalogId}/companies +- name: sharedCatalog/{sharedCatalogId}/resetTierPrices +- name: sharedCatalog/{sharedCatalogId}/unassignCompanies +- name: shipment/ +- name: shipment/{id} +- name: shipment/{id}/comments +- name: shipment/{id}/emails +- name: shipment/{id}/label +- name: shipment/track +- name: shipment/track/{id} +- name: shipments +- name: stockItems/{productSku} +- name: stockItems/lowStock/ +- name: stockStatuses/{productSku} +- name: store/storeConfigs +- name: store/storeGroups +- name: store/storeViews +- name: store/websites +- name: taxClasses +- name: taxClasses/{classId} +- name: taxClasses/{taxClassId} +- name: taxClasses/search +- name: taxRates +- name: taxRates/{rateId} +- name: taxRates/search +- name: taxRules +- name: taxRules/{ruleId} +- name: taxRules/search +- name: team/ +- name: team/{companyId} +- name: team/{teamId} +- name: tfa/default-provider-code/{userId} +- name: tfa/forced-providers +- name: tfa/installed-providers +- name: tfa/provider/authy/activate +- name: tfa/provider/authy/authenticate +- name: tfa/provider/authy/authenticate-onetouch +- name: tfa/provider/authy/configure +- name: tfa/provider/authy/send-token/{via} +- name: tfa/provider/duo_security/activate +- name: tfa/provider/duo_security/authenticate +- name: tfa/provider/duo_security/configure +- name: tfa/provider/google/activate +- name: tfa/provider/google/authenticate +- name: tfa/provider/google/configure +- name: tfa/provider/u2fkey/activate +- name: tfa/provider/u2fkey/authentication-challenge +- name: tfa/provider/u2fkey/configure +- name: tfa/provider/u2fkey/verify +- name: tfa/providers-to-activate/{userId} +- name: tfa/tfat-providers-to-activate +- name: tfa/tfat-user-providers +- name: tfa/user-providers/{userId} +- name: transactions +- name: transactions/{id} +- name: webhooks/list +- name: webhooks/subscribe +- name: webhooks/unsubscribe +paths: + "/V1/addresses/{addressId}": + delete: + tags: + - addresses/{addressId} + description: Delete customer address by ID. + operationId: DeleteV1AddressesAddressId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: addressId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: addresses/{addressId} + "/V1/adminuisdk/appmanagement/validate": + post: + tags: + - adminuisdk/appmanagement/validate + description: Validate App Management User token + operationId: PostV1AdminuisdkAppmanagementValidate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1AdminuisdkAppmanagementValidateBody + in: body + schema: + required: + - orgId + properties: + orgId: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/commerce-backend-uix-data-app-management-validation-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: adminuisdk/appmanagement/validate + "/V1/adminuisdk/massaction/{request_id}": + get: + tags: + - adminuisdk/massaction/{request_id} + description: Load mass actions failed request by request id + operationId: GetV1AdminuisdkMassactionRequest_id + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: requestId + in: query + type: string + required: true + - name: request_id + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/commerce-backend-uix-data-mass-action-failed-request-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: adminuisdk/massaction/{request_id} + "/V1/adminuisdk/orderviewbutton/{request_id}": + get: + tags: + - adminuisdk/orderviewbutton/{request_id} + description: Load order view button failed request by request id + operationId: GetV1AdminuisdkOrderviewbuttonRequest_id + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: requestId + in: query + type: string + required: true + - name: request_id + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/commerce-backend-uix-data-order-view-button-failed-request-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: adminuisdk/orderviewbutton/{request_id} + "/V1/adobe_io_events/check_configuration": + get: + tags: + - adobe_io_events/check_configuration + description: Checks configuration and returns success/failure results for each + component + operationId: GetV1Adobe_io_eventsCheck_configuration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/adobe-io-events-client-configuration-check-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: adobe_io_events/check_configuration + "/V1/adobestock/asset/list": + get: + tags: + - adobestock/asset/list + description: Search for images based on search criteria + operationId: GetV1AdobestockAssetList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[requestName] + in: query + type: string + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/framework-search-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: adobestock/asset/list + "/V1/adobestock/asset/search": + get: + tags: + - adobestock/asset/search + description: Get a list of assets + operationId: GetV1AdobestockAssetSearch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/adobe-stock-asset-api-data-asset-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: adobestock/asset/search + "/V1/adobestock/asset/{id}": + delete: + tags: + - adobestock/asset/{id} + description: Delete asset + operationId: DeleteV1AdobestockAssetId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: adobestock/asset/{id} + get: + tags: + - adobestock/asset/{id} + description: Get asset by id + operationId: GetV1AdobestockAssetId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/adobe-stock-asset-api-data-asset-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: adobestock/asset/{id} + "/V1/adobestock/search": + get: + tags: + - adobestock/search + description: Search for images based on search criteria + operationId: GetV1AdobestockSearch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[requestName] + in: query + type: string + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/framework-search-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: adobestock/search + "/V1/analytics/link": + get: + tags: + - analytics/link + description: Retrieve link + operationId: GetV1AnalyticsLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/analytics-data-link-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: analytics/link + "/V1/applepay/auth": + get: + tags: + - applepay/auth + description: Returns details required to be able to submit a payment with Apple + Pay + operationId: GetV1ApplepayAuth + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/pay-pal-braintree-data-auth-data-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: applepay/auth + "/V1/attributeMetadata/customer": + get: + tags: + - attributeMetadata/customer + description: Get all attribute metadata. + operationId: GetV1AttributeMetadataCustomer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/customer-data-attribute-metadata-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: attributeMetadata/customer + "/V1/attributeMetadata/customer/attribute/{attributeCode}": + get: + tags: + - attributeMetadata/customer/attribute/{attributeCode} + description: Retrieve attribute metadata. + operationId: GetV1AttributeMetadataCustomerAttributeAttributeCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-attribute-metadata-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: attributeMetadata/customer/attribute/{attributeCode} + "/V1/attributeMetadata/customer/custom": + get: + tags: + - attributeMetadata/customer/custom + description: Get custom attributes metadata for the given data interface. + operationId: GetV1AttributeMetadataCustomerCustom + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: dataInterfaceName + in: query + type: string + required: false + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/customer-data-attribute-metadata-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: attributeMetadata/customer/custom + "/V1/attributeMetadata/customer/form/{formCode}": + get: + tags: + - attributeMetadata/customer/form/{formCode} + description: Retrieve all attributes filtered by form code + operationId: GetV1AttributeMetadataCustomerFormFormCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: formCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/customer-data-attribute-metadata-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: attributeMetadata/customer/form/{formCode} + "/V1/attributeMetadata/customerAddress": + get: + tags: + - attributeMetadata/customerAddress + description: Get all attribute metadata. + operationId: GetV1AttributeMetadataCustomerAddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/customer-data-attribute-metadata-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: attributeMetadata/customerAddress + "/V1/attributeMetadata/customerAddress/attribute/{attributeCode}": + get: + tags: + - attributeMetadata/customerAddress/attribute/{attributeCode} + description: Retrieve attribute metadata. + operationId: GetV1AttributeMetadataCustomerAddressAttributeAttributeCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-attribute-metadata-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: attributeMetadata/customerAddress/attribute/{attributeCode} + "/V1/attributeMetadata/customerAddress/custom": + get: + tags: + - attributeMetadata/customerAddress/custom + description: Get custom attributes metadata for the given data interface. + operationId: GetV1AttributeMetadataCustomerAddressCustom + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: dataInterfaceName + in: query + type: string + required: false + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/customer-data-attribute-metadata-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: attributeMetadata/customerAddress/custom + "/V1/attributeMetadata/customerAddress/form/{formCode}": + get: + tags: + - attributeMetadata/customerAddress/form/{formCode} + description: Retrieve all attributes filtered by form code + operationId: GetV1AttributeMetadataCustomerAddressFormFormCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: formCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/customer-data-attribute-metadata-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: attributeMetadata/customerAddress/form/{formCode} + "/V1/braintree/mine/payment/vault": + post: + tags: + - braintree/mine/payment/vault + description: Vault a Payment nonce for a customer. Billing address is optional + but advised for Card vaulting. + operationId: PostV1BraintreeMinePaymentVault + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1BraintreeMinePaymentVaultBody + in: body + schema: + required: + - payment + properties: + payment: + "$ref": "#/definitions/pay-pal-braintree-data-payment-interface" + billingAddress: + "$ref": "#/definitions/customer-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: braintree/mine/payment/vault + "/V1/bulk": + get: + tags: + - bulk + description: Lists the bulk operation items that match specified search criteria. + operationId: GetV1Bulk + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/asynchronous-operations-data-operation-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: bulk + "/V1/bulk/{bulkUuid}/detailed-status": + get: + tags: + - bulk/{bulkUuid}/detailed-status + description: Get Bulk summary data with list of operations items full data. + operationId: GetV1BulkBulkUuidDetailedstatus + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: bulkUuid + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/asynchronous-operations-data-detailed-bulk-operations-status-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: bulk/{bulkUuid}/detailed-status + "/V1/bulk/{bulkUuid}/operation-status/{status}": + get: + tags: + - bulk/{bulkUuid}/operation-status/{status} + description: Get operations count by bulk uuid and status. + operationId: GetV1BulkBulkUuidOperationstatusStatus + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: bulkUuid + in: path + type: string + required: true + - name: status + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: integer + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: bulk/{bulkUuid}/operation-status/{status} + "/V1/bulk/{bulkUuid}/status": + get: + tags: + - bulk/{bulkUuid}/status + description: Get Bulk summary data with list of operations items short data. + operationId: GetV1BulkBulkUuidStatus + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: bulkUuid + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/asynchronous-operations-data-bulk-operations-status-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: bulk/{bulkUuid}/status + "/V1/bundle-products/options/add": + post: + tags: + - bundle-products/options/add + description: Add new option for bundle product + operationId: PostV1BundleproductsOptionsAdd + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1BundleproductsOptionsAddBody + in: body + schema: + required: + - option + properties: + option: + "$ref": "#/definitions/bundle-data-option-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: bundle-products/options/add + "/V1/bundle-products/options/types": + get: + tags: + - bundle-products/options/types + description: Get all types for options for bundle products + operationId: GetV1BundleproductsOptionsTypes + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/bundle-data-option-type-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: bundle-products/options/types + "/V1/bundle-products/options/{optionId}": + put: + tags: + - bundle-products/options/{optionId} + description: Add new option for bundle product + operationId: PutV1BundleproductsOptionsOptionId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: optionId + in: path + type: string + required: true + - name: PutV1BundleproductsOptionsOptionIdBody + in: body + schema: + required: + - option + properties: + option: + "$ref": "#/definitions/bundle-data-option-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: bundle-products/options/{optionId} + "/V1/bundle-products/{productSku}/children": + get: + tags: + - bundle-products/{productSku}/children + description: Get all children for Bundle product + operationId: GetV1BundleproductsProductSkuChildren + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: productSku + in: path + type: string + required: true + - name: optionId + in: query + type: integer + required: false + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/bundle-data-link-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: bundle-products/{productSku}/children + "/V1/bundle-products/{sku}/links/{id}": + put: + tags: + - bundle-products/{sku}/links/{id} + description: '' + operationId: PutV1BundleproductsSkuLinksId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: id + in: path + type: string + required: true + - name: PutV1BundleproductsSkuLinksIdBody + in: body + schema: + required: + - linkedProduct + properties: + linkedProduct: + "$ref": "#/definitions/bundle-data-link-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: bundle-products/{sku}/links/{id} + "/V1/bundle-products/{sku}/links/{optionId}": + post: + tags: + - bundle-products/{sku}/links/{optionId} + description: Add child product to specified Bundle option by product sku + operationId: PostV1BundleproductsSkuLinksOptionId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: optionId + in: path + type: integer + required: true + - name: PostV1BundleproductsSkuLinksOptionIdBody + in: body + schema: + required: + - linkedProduct + properties: + linkedProduct: + "$ref": "#/definitions/bundle-data-link-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: bundle-products/{sku}/links/{optionId} + "/V1/bundle-products/{sku}/options/all": + get: + tags: + - bundle-products/{sku}/options/all + description: Get all options for bundle product + operationId: GetV1BundleproductsSkuOptionsAll + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/bundle-data-option-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: bundle-products/{sku}/options/all + "/V1/bundle-products/{sku}/options/{optionId}": + get: + tags: + - bundle-products/{sku}/options/{optionId} + description: Get option for bundle product + operationId: GetV1BundleproductsSkuOptionsOptionId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: optionId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/bundle-data-option-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: bundle-products/{sku}/options/{optionId} + delete: + tags: + - bundle-products/{sku}/options/{optionId} + description: Remove bundle option + operationId: DeleteV1BundleproductsSkuOptionsOptionId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: optionId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: bundle-products/{sku}/options/{optionId} + "/V1/bundle-products/{sku}/options/{optionId}/children/{childSku}": + delete: + tags: + - bundle-products/{sku}/options/{optionId}/children/{childSku} + description: Remove product from Bundle product option + operationId: DeleteV1BundleproductsSkuOptionsOptionIdChildrenChildSku + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: optionId + in: path + type: integer + required: true + - name: childSku + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: bundle-products/{sku}/options/{optionId}/children/{childSku} + "/V1/carts/": + post: + tags: + - carts/ + description: Creates an empty cart and quote for a guest. + operationId: PostV1Carts + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Cart ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/ + "/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}": + get: + tags: + - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} + description: Check gift card balance if added to the cart. + operationId: GetV1CartsGuestcartsCartIdCheckGiftCardGiftCardCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: giftCardCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: number + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} + "/V1/carts/guest-carts/{cartId}/giftCards": + post: + tags: + - carts/guest-carts/{cartId}/giftCards + description: Add gift card to the cart. + operationId: PostV1CartsGuestcartsCartIdGiftCards + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1CartsGuestcartsCartIdGiftCardsBody + in: body + schema: + required: + - giftCardAccountData + properties: + giftCardAccountData: + "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/guest-carts/{cartId}/giftCards + "/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}": + delete: + tags: + - carts/guest-carts/{cartId}/giftCards/{giftCardCode} + description: Remove GiftCard Account entity. + operationId: DeleteV1CartsGuestcartsCartIdGiftCardsGiftCardCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: giftCardCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/guest-carts/{cartId}/giftCards/{giftCardCode} + "/V1/carts/licence": + get: + tags: + - carts/licence + description: Lists active checkout agreements. + operationId: GetV1CartsLicence + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/checkout-agreements-data-agreement-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/licence + "/V1/carts/licence/list": + get: + tags: + - carts/licence/list + description: List of checkout agreements. + operationId: GetV1CartsLicenceList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/checkout-agreements-data-agreement-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/licence/list + "/V1/carts/mine": + put: + tags: + - carts/mine + description: Save quote + operationId: PutV1CartsMine + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1CartsMineBody + in: body + schema: + required: + - quote + properties: + quote: + "$ref": "#/definitions/quote-data-cart-interface" + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine + post: + tags: + - carts/mine + description: Creates an empty cart and quote for a specified customer if customer + does not have a cart yet. + operationId: PostV1CartsMine + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: integer + description: new cart ID if customer did not have a cart or ID of the + existing cart otherwise. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine + get: + tags: + - carts/mine + description: Returns information for the cart for a specified customer. + operationId: GetV1CartsMine + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-cart-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine + "/V1/carts/mine/balance/apply": + post: + tags: + - carts/mine/balance/apply + description: Apply store credit + operationId: PostV1CartsMineBalanceApply + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/balance/apply + "/V1/carts/mine/billing-address": + get: + tags: + - carts/mine/billing-address + description: Returns the billing address for a specified quote. + operationId: GetV1CartsMineBillingaddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-address-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/billing-address + post: + tags: + - carts/mine/billing-address + description: Assigns a specified billing address to a specified cart. + operationId: PostV1CartsMineBillingaddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CartsMineBillingaddressBody + in: body + schema: + required: + - address + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + useForShipping: + type: boolean + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Address ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/billing-address + "/V1/carts/mine/checkGiftCard/{giftCardCode}": + get: + tags: + - carts/mine/checkGiftCard/{giftCardCode} + description: Check gift card balance if applied to given cart. + operationId: GetV1CartsMineCheckGiftCardGiftCardCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: giftCardCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: number + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/checkGiftCard/{giftCardCode} + "/V1/carts/mine/collect-totals": + put: + tags: + - carts/mine/collect-totals + description: Set shipping/billing methods and additional data for cart and collect + totals. + operationId: PutV1CartsMineCollecttotals + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1CartsMineCollecttotalsBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + shippingCarrierCode: + type: string + description: The carrier code. + shippingMethodCode: + type: string + description: The shipping method code. + additionalData: + "$ref": "#/definitions/quote-data-totals-additional-data-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-totals-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/collect-totals + "/V1/carts/mine/coupons": + get: + tags: + - carts/mine/coupons + description: Returns information for a coupon in a specified cart. + operationId: GetV1CartsMineCoupons + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: string + description: The coupon code data. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/coupons + delete: + tags: + - carts/mine/coupons + description: Deletes a coupon from a specified cart. + operationId: DeleteV1CartsMineCoupons + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/coupons + "/V1/carts/mine/coupons/{couponCode}": + put: + tags: + - carts/mine/coupons/{couponCode} + description: Adds a coupon by code to a specified cart. + operationId: PutV1CartsMineCouponsCouponCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: couponCode + in: path + type: string + required: true + description: The coupon code data. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/coupons/{couponCode} + "/V1/carts/mine/estimate-shipping-methods": + post: + tags: + - carts/mine/estimate-shipping-methods + description: Estimate shipping by address and return list of available shipping + methods + operationId: PostV1CartsMineEstimateshippingmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CartsMineEstimateshippingmethodsBody + in: body + schema: + required: + - address + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/estimate-shipping-methods + "/V1/carts/mine/estimate-shipping-methods-by-address-id": + post: + tags: + - carts/mine/estimate-shipping-methods-by-address-id + description: Estimate shipping + operationId: PostV1CartsMineEstimateshippingmethodsbyaddressid + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CartsMineEstimateshippingmethodsbyaddressidBody + in: body + schema: + required: + - addressId + properties: + addressId: + type: integer + description: The estimate address id + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods. + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/estimate-shipping-methods-by-address-id + "/V1/carts/mine/gift-message": + get: + tags: + - carts/mine/gift-message + description: Return the gift message for a specified order. + operationId: GetV1CartsMineGiftmessage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/gift-message-data-message-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/gift-message + post: + tags: + - carts/mine/gift-message + description: Set the gift message for an entire order. + operationId: PostV1CartsMineGiftmessage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CartsMineGiftmessageBody + in: body + schema: + required: + - giftMessage + properties: + giftMessage: + "$ref": "#/definitions/gift-message-data-message-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/gift-message + "/V1/carts/mine/gift-message/{itemId}": + get: + tags: + - carts/mine/gift-message/{itemId} + description: Return the gift message for a specified item in a specified shopping + cart. + operationId: GetV1CartsMineGiftmessageItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: itemId + in: path + type: integer + required: true + description: The item ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/gift-message-data-message-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/gift-message/{itemId} + post: + tags: + - carts/mine/gift-message/{itemId} + description: Set the gift message for a specified item in a specified shopping + cart. + operationId: PostV1CartsMineGiftmessageItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: itemId + in: path + type: integer + required: true + description: The item ID. + - name: PostV1CartsMineGiftmessageItemIdBody + in: body + schema: + required: + - giftMessage + properties: + giftMessage: + "$ref": "#/definitions/gift-message-data-message-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/gift-message/{itemId} + "/V1/carts/mine/giftCards": + post: + tags: + - carts/mine/giftCards + description: Add gift card to the cart. + operationId: PostV1CartsMineGiftCards + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CartsMineGiftCardsBody + in: body + schema: + required: + - giftCardAccountData + properties: + giftCardAccountData: + "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/giftCards + "/V1/carts/mine/giftCards/{giftCardCode}": + delete: + tags: + - carts/mine/giftCards/{giftCardCode} + description: Remove GiftCard Account entity + operationId: DeleteV1CartsMineGiftCardsGiftCardCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: giftCardCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/giftCards/{giftCardCode} + "/V1/carts/mine/items": + get: + tags: + - carts/mine/items + description: Lists items that are assigned to a specified cart. + operationId: GetV1CartsMineItems + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + description: Array of items. + items: + "$ref": "#/definitions/quote-data-cart-item-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/items + post: + tags: + - carts/mine/items + description: Add/update the specified cart item. + operationId: PostV1CartsMineItems + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CartsMineItemsBody + in: body + schema: + required: + - cartItem + properties: + cartItem: + "$ref": "#/definitions/quote-data-cart-item-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-cart-item-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/items + "/V1/carts/mine/items/{itemId}": + put: + tags: + - carts/mine/items/{itemId} + description: Add/update the specified cart item. + operationId: PutV1CartsMineItemsItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: itemId + in: path + type: string + required: true + - name: PutV1CartsMineItemsItemIdBody + in: body + schema: + required: + - cartItem + properties: + cartItem: + "$ref": "#/definitions/quote-data-cart-item-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-cart-item-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/items/{itemId} + delete: + tags: + - carts/mine/items/{itemId} + description: Removes the specified item from the specified cart. + operationId: DeleteV1CartsMineItemsItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: itemId + in: path + type: integer + required: true + description: The item ID of the item to be removed. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/items/{itemId} + "/V1/carts/mine/order": + put: + tags: + - carts/mine/order + description: Places an order for a specified cart. + operationId: PutV1CartsMineOrder + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1CartsMineOrderBody + in: body + schema: + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/order + "/V1/carts/mine/payment-information": + post: + tags: + - carts/mine/payment-information + description: Set payment information and place order for a specified cart. + operationId: PostV1CartsMinePaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CartsMinePaymentinformationBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/payment-information + get: + tags: + - carts/mine/payment-information + description: Get payment information + operationId: GetV1CartsMinePaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/checkout-data-payment-details-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/payment-information + "/V1/carts/mine/payment-methods": + get: + tags: + - carts/mine/payment-methods + description: Lists available payment methods for a specified shopping cart. + This call returns an array of objects, but detailed information about each + object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#PaymentMethodManagementInterface + to determine which call to use to get detailed information about all attributes + for an object. + operationId: GetV1CartsMinePaymentmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + description: Array of payment methods. + items: + "$ref": "#/definitions/quote-data-payment-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/payment-methods + "/V1/carts/mine/payment-order": + post: + tags: + - carts/mine/payment-order + description: Create a payment order for logged in customer + operationId: PostV1CartsMinePaymentorder + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CartsMinePaymentorderBody + in: body + schema: + required: + - methodCode + - paymentSource + - location + properties: + methodCode: + type: string + paymentSource: + type: string + location: + type: string + vaultIntent: + type: boolean + threeDSMode: + type: string + description: "| null $threeDSMode" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-order-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/payment-order + "/V1/carts/mine/payment-order/{id}": + get: + tags: + - carts/mine/payment-order/{id} + description: Get payment order for logged in customer + operationId: GetV1CartsMinePaymentorderId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-order-details-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/payment-order/{id} + post: + tags: + - carts/mine/payment-order/{id} + description: Sync payment order for logged in customer + operationId: PostV1CartsMinePaymentorderId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/payment-order/{id} + "/V1/carts/mine/po-payment-information": + post: + tags: + - carts/mine/po-payment-information + description: Set payment information and place purchase order for a specified + cart. + operationId: PostV1CartsMinePopaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CartsMinePopaymentinformationBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Purchase Order ID. + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/po-payment-information + "/V1/carts/mine/selected-payment-method": + get: + tags: + - carts/mine/selected-payment-method + description: Returns the payment method for a specified shopping cart. + operationId: GetV1CartsMineSelectedpaymentmethod + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-payment-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/selected-payment-method + put: + tags: + - carts/mine/selected-payment-method + description: Adds a specified payment method to a specified shopping cart. + operationId: PutV1CartsMineSelectedpaymentmethod + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1CartsMineSelectedpaymentmethodBody + in: body + schema: + required: + - method + properties: + method: + "$ref": "#/definitions/quote-data-payment-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + description: redirect url or error message. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/selected-payment-method + "/V1/carts/mine/set-payment-information": + post: + tags: + - carts/mine/set-payment-information + description: Set payment information for a specified cart. + operationId: PostV1CartsMineSetpaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CartsMineSetpaymentinformationBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/set-payment-information + "/V1/carts/mine/shipping-information": + post: + tags: + - carts/mine/shipping-information + description: '' + operationId: PostV1CartsMineShippinginformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CartsMineShippinginformationBody + in: body + schema: + required: + - addressInformation + properties: + addressInformation: + "$ref": "#/definitions/checkout-data-shipping-information-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/checkout-data-payment-details-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/shipping-information + "/V1/carts/mine/shipping-methods": + get: + tags: + - carts/mine/shipping-methods + description: Lists applicable shipping methods for a specified quote. + operationId: GetV1CartsMineShippingmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods. + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/shipping-methods + "/V1/carts/mine/totals": + get: + tags: + - carts/mine/totals + description: Returns quote totals data for a specified cart. + operationId: GetV1CartsMineTotals + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-totals-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/totals + "/V1/carts/mine/totals-information": + post: + tags: + - carts/mine/totals-information + description: Calculate quote totals based on address and shipping method. + operationId: PostV1CartsMineTotalsinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CartsMineTotalsinformationBody + in: body + schema: + required: + - addressInformation + properties: + addressInformation: + "$ref": "#/definitions/checkout-data-totals-information-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-totals-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/totals-information + "/V1/carts/search": + get: + tags: + - carts/search + description: Enables administrative users to list carts that match specified + search criteria. This call returns an array of objects, but detailed information + about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#CartRepositoryInterface + to determine which call to use to get detailed information about all attributes + for an object. + operationId: GetV1CartsSearch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-cart-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/search + "/V1/carts/{cartId}": + get: + tags: + - carts/{cartId} + description: Enables an administrative user to return information for a specified + cart. + operationId: GetV1CartsCartId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-cart-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId} + put: + tags: + - carts/{cartId} + description: Assigns a specified customer to a specified shopping cart. + operationId: PutV1CartsCartId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + - name: PutV1CartsCartIdBody + in: body + schema: + required: + - customerId + - storeId + properties: + customerId: + type: integer + description: The customer ID. + storeId: + type: integer + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId} + "/V1/carts/{cartId}/billing-address": + get: + tags: + - carts/{cartId}/billing-address + description: Returns the billing address for a specified quote. + operationId: GetV1CartsCartIdBillingaddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-address-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/billing-address + post: + tags: + - carts/{cartId}/billing-address + description: Assigns a specified billing address to a specified cart. + operationId: PostV1CartsCartIdBillingaddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + - name: PostV1CartsCartIdBillingaddressBody + in: body + schema: + required: + - address + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + useForShipping: + type: boolean + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Address ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/billing-address + "/V1/carts/{cartId}/coupons": + get: + tags: + - carts/{cartId}/coupons + description: Returns information for a coupon in a specified cart. + operationId: GetV1CartsCartIdCoupons + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + type: string + description: The coupon code data. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/coupons + delete: + tags: + - carts/{cartId}/coupons + description: Deletes a coupon from a specified cart. + operationId: DeleteV1CartsCartIdCoupons + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/coupons + "/V1/carts/{cartId}/coupons/{couponCode}": + put: + tags: + - carts/{cartId}/coupons/{couponCode} + description: Adds a coupon by code to a specified cart. + operationId: PutV1CartsCartIdCouponsCouponCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + - name: couponCode + in: path + type: string + required: true + description: The coupon code data. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/coupons/{couponCode} + "/V1/carts/{cartId}/estimate-shipping-methods": + post: + tags: + - carts/{cartId}/estimate-shipping-methods + description: Estimate shipping by address and return list of available shipping + methods + operationId: PostV1CartsCartIdEstimateshippingmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1CartsCartIdEstimateshippingmethodsBody + in: body + schema: + required: + - address + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/estimate-shipping-methods + "/V1/carts/{cartId}/estimate-shipping-methods-by-address-id": + post: + tags: + - carts/{cartId}/estimate-shipping-methods-by-address-id + description: Estimate shipping + operationId: PostV1CartsCartIdEstimateshippingmethodsbyaddressid + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The shopping cart ID. + - name: PostV1CartsCartIdEstimateshippingmethodsbyaddressidBody + in: body + schema: + required: + - addressId + properties: + addressId: + type: integer + description: The estimate address id + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods. + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/estimate-shipping-methods-by-address-id + "/V1/carts/{cartId}/gift-message": + get: + tags: + - carts/{cartId}/gift-message + description: Return the gift message for a specified order. + operationId: GetV1CartsCartIdGiftmessage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The shopping cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/gift-message-data-message-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/gift-message + post: + tags: + - carts/{cartId}/gift-message + description: Set the gift message for an entire order. + operationId: PostV1CartsCartIdGiftmessage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + - name: PostV1CartsCartIdGiftmessageBody + in: body + schema: + required: + - giftMessage + properties: + giftMessage: + "$ref": "#/definitions/gift-message-data-message-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/gift-message + "/V1/carts/{cartId}/gift-message/{itemId}": + get: + tags: + - carts/{cartId}/gift-message/{itemId} + description: Return the gift message for a specified item in a specified shopping + cart. + operationId: GetV1CartsCartIdGiftmessageItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The shopping cart ID. + - name: itemId + in: path + type: integer + required: true + description: The item ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/gift-message-data-message-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/gift-message/{itemId} + post: + tags: + - carts/{cartId}/gift-message/{itemId} + description: Set the gift message for a specified item in a specified shopping + cart. + operationId: PostV1CartsCartIdGiftmessageItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + - name: itemId + in: path + type: integer + required: true + description: The item ID. + - name: PostV1CartsCartIdGiftmessageItemIdBody + in: body + schema: + required: + - giftMessage + properties: + giftMessage: + "$ref": "#/definitions/gift-message-data-message-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/gift-message/{itemId} + "/V1/carts/{cartId}/giftCards": + put: + tags: + - carts/{cartId}/giftCards + description: Add gift card to the cart. + operationId: PutV1CartsCartIdGiftCards + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: PutV1CartsCartIdGiftCardsBody + in: body + schema: + required: + - giftCardAccountData + properties: + giftCardAccountData: + "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/giftCards + "/V1/carts/{cartId}/giftCards/{giftCardCode}": + delete: + tags: + - carts/{cartId}/giftCards/{giftCardCode} + description: Remove GiftCard Account entity + operationId: DeleteV1CartsCartIdGiftCardsGiftCardCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: giftCardCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/giftCards/{giftCardCode} + "/V1/carts/{cartId}/items": + get: + tags: + - carts/{cartId}/items + description: Lists items that are assigned to a specified cart. + operationId: GetV1CartsCartIdItems + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + type: array + description: Array of items. + items: + "$ref": "#/definitions/quote-data-cart-item-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/items + "/V1/carts/{cartId}/items/{itemId}": + put: + tags: + - carts/{cartId}/items/{itemId} + description: Add/update the specified cart item. + operationId: PutV1CartsCartIdItemsItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: itemId + in: path + type: string + required: true + - name: PutV1CartsCartIdItemsItemIdBody + in: body + schema: + required: + - cartItem + properties: + cartItem: + "$ref": "#/definitions/quote-data-cart-item-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-cart-item-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/items/{itemId} + delete: + tags: + - carts/{cartId}/items/{itemId} + description: Removes the specified item from the specified cart. + operationId: DeleteV1CartsCartIdItemsItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + - name: itemId + in: path + type: integer + required: true + description: The item ID of the item to be removed. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/items/{itemId} + "/V1/carts/{cartId}/order": + put: + tags: + - carts/{cartId}/order + description: Places an order for a specified cart. + operationId: PutV1CartsCartIdOrder + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + - name: PutV1CartsCartIdOrderBody + in: body + schema: + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/order + "/V1/carts/{cartId}/payment-methods": + get: + tags: + - carts/{cartId}/payment-methods + description: Lists available payment methods for a specified shopping cart. + This call returns an array of objects, but detailed information about each + object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#PaymentMethodManagementInterface + to determine which call to use to get detailed information about all attributes + for an object. + operationId: GetV1CartsCartIdPaymentmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + type: array + description: Array of payment methods. + items: + "$ref": "#/definitions/quote-data-payment-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/payment-methods + "/V1/carts/{cartId}/selected-payment-method": + get: + tags: + - carts/{cartId}/selected-payment-method + description: Returns the payment method for a specified shopping cart. + operationId: GetV1CartsCartIdSelectedpaymentmethod + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-payment-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/selected-payment-method + put: + tags: + - carts/{cartId}/selected-payment-method + description: Adds a specified payment method to a specified shopping cart. + operationId: PutV1CartsCartIdSelectedpaymentmethod + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + - name: PutV1CartsCartIdSelectedpaymentmethodBody + in: body + schema: + required: + - method + properties: + method: + "$ref": "#/definitions/quote-data-payment-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + description: redirect url or error message. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/selected-payment-method + "/V1/carts/{cartId}/shipping-information": + post: + tags: + - carts/{cartId}/shipping-information + description: '' + operationId: PostV1CartsCartIdShippinginformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: PostV1CartsCartIdShippinginformationBody + in: body + schema: + required: + - addressInformation + properties: + addressInformation: + "$ref": "#/definitions/checkout-data-shipping-information-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/checkout-data-payment-details-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/shipping-information + "/V1/carts/{cartId}/shipping-methods": + get: + tags: + - carts/{cartId}/shipping-methods + description: Lists applicable shipping methods for a specified quote. + operationId: GetV1CartsCartIdShippingmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The shopping cart ID. + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods. + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/shipping-methods + "/V1/carts/{cartId}/totals": + get: + tags: + - carts/{cartId}/totals + description: Returns quote totals data for a specified cart. + operationId: GetV1CartsCartIdTotals + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-totals-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/totals + "/V1/carts/{cartId}/totals-information": + post: + tags: + - carts/{cartId}/totals-information + description: Calculate quote totals based on address and shipping method. + operationId: PostV1CartsCartIdTotalsinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: PostV1CartsCartIdTotalsinformationBody + in: body + schema: + required: + - addressInformation + properties: + addressInformation: + "$ref": "#/definitions/checkout-data-totals-information-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-totals-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/totals-information + "/V1/carts/{quoteId}/giftCards": + get: + tags: + - carts/{quoteId}/giftCards + description: Return GiftCard Account cards. + operationId: GetV1CartsQuoteIdGiftCards + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: quoteId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{quoteId}/giftCards + "/V1/carts/{quoteId}/items": + post: + tags: + - carts/{quoteId}/items + description: Add/update the specified cart item. + operationId: PostV1CartsQuoteIdItems + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: quoteId + in: path + type: string + required: true + - name: PostV1CartsQuoteIdItemsBody + in: body + schema: + required: + - cartItem + properties: + cartItem: + "$ref": "#/definitions/quote-data-cart-item-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-cart-item-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{quoteId}/items + "/V1/categories": + post: + tags: + - categories + description: Create category service + operationId: PostV1Categories + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CategoriesBody + in: body + schema: + required: + - category + properties: + category: + "$ref": "#/definitions/catalog-data-category-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-category-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: categories + get: + tags: + - categories + description: Retrieve list of categories + operationId: GetV1Categories + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: rootCategoryId + in: query + type: integer + required: false + - name: depth + in: query + type: integer + required: false + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-category-tree-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: categories + "/V1/categories/attributes": + get: + tags: + - categories/attributes + description: Retrieve all attributes for entity type + operationId: GetV1CategoriesAttributes + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-category-attribute-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: categories/attributes + "/V1/categories/attributes/{attributeCode}": + get: + tags: + - categories/attributes/{attributeCode} + description: Retrieve specific attribute + operationId: GetV1CategoriesAttributesAttributeCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-category-attribute-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: categories/attributes/{attributeCode} + "/V1/categories/attributes/{attributeCode}/options": + get: + tags: + - categories/attributes/{attributeCode}/options + description: Retrieve list of attribute options + operationId: GetV1CategoriesAttributesAttributeCodeOptions + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/eav-data-attribute-option-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: categories/attributes/{attributeCode}/options + "/V1/categories/list": + get: + tags: + - categories/list + description: Get category list + operationId: GetV1CategoriesList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-category-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: categories/list + "/V1/categories/{categoryId}": + delete: + tags: + - categories/{categoryId} + description: Delete category by identifier + operationId: DeleteV1CategoriesCategoryId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: categoryId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: Will returned True if deleted + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: categories/{categoryId} + get: + tags: + - categories/{categoryId} + description: Get info about category by category id + operationId: GetV1CategoriesCategoryId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: categoryId + in: path + type: integer + required: true + - name: storeId + in: query + type: integer + required: false + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-category-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: categories/{categoryId} + "/V1/categories/{categoryId}/move": + put: + tags: + - categories/{categoryId}/move + description: Move category + operationId: PutV1CategoriesCategoryIdMove + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: categoryId + in: path + type: integer + required: true + - name: PutV1CategoriesCategoryIdMoveBody + in: body + schema: + required: + - parentId + properties: + parentId: + type: integer + afterId: + type: integer + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: categories/{categoryId}/move + "/V1/categories/{categoryId}/products": + get: + tags: + - categories/{categoryId}/products + description: Get products assigned to category + operationId: GetV1CategoriesCategoryIdProducts + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: categoryId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-category-product-link-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: categories/{categoryId}/products + post: + tags: + - categories/{categoryId}/products + description: Assign a product to the required category + operationId: PostV1CategoriesCategoryIdProducts + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: categoryId + in: path + type: string + required: true + - name: PostV1CategoriesCategoryIdProductsBody + in: body + schema: + required: + - productLink + properties: + productLink: + "$ref": "#/definitions/catalog-data-category-product-link-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: will returned True if assigned + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: categories/{categoryId}/products + put: + tags: + - categories/{categoryId}/products + description: Assign a product to the required category + operationId: PutV1CategoriesCategoryIdProducts + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: categoryId + in: path + type: string + required: true + - name: PutV1CategoriesCategoryIdProductsBody + in: body + schema: + required: + - productLink + properties: + productLink: + "$ref": "#/definitions/catalog-data-category-product-link-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: will returned True if assigned + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: categories/{categoryId}/products + "/V1/categories/{categoryId}/products/{sku}": + delete: + tags: + - categories/{categoryId}/products/{sku} + description: Remove the product assignment from the category by category id + and sku + operationId: DeleteV1CategoriesCategoryIdProductsSku + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: categoryId + in: path + type: integer + required: true + - name: sku + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: will returned True if products successfully deleted + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: categories/{categoryId}/products/{sku} + "/V1/categories/{id}": + put: + tags: + - categories/{id} + description: Create category service + operationId: PutV1CategoriesId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: string + required: true + - name: PutV1CategoriesIdBody + in: body + schema: + required: + - category + properties: + category: + "$ref": "#/definitions/catalog-data-category-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-category-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: categories/{id} + "/V1/cmsBlock": + post: + tags: + - cmsBlock + description: Save block. + operationId: PostV1CmsBlock + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CmsBlockBody + in: body + schema: + required: + - block + properties: + block: + "$ref": "#/definitions/cms-data-block-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/cms-data-block-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: cmsBlock + "/V1/cmsBlock/search": + get: + tags: + - cmsBlock/search + description: Retrieve blocks matching the specified criteria. + operationId: GetV1CmsBlockSearch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/cms-data-block-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: cmsBlock/search + "/V1/cmsBlock/{blockId}": + get: + tags: + - cmsBlock/{blockId} + description: Retrieve block. + operationId: GetV1CmsBlockBlockId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: blockId + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/cms-data-block-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: cmsBlock/{blockId} + delete: + tags: + - cmsBlock/{blockId} + description: Delete block by ID. + operationId: DeleteV1CmsBlockBlockId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: blockId + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: cmsBlock/{blockId} + "/V1/cmsBlock/{id}": + put: + tags: + - cmsBlock/{id} + description: Save block. + operationId: PutV1CmsBlockId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: string + required: true + - name: PutV1CmsBlockIdBody + in: body + schema: + required: + - block + properties: + block: + "$ref": "#/definitions/cms-data-block-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/cms-data-block-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: cmsBlock/{id} + "/V1/cmsPage": + post: + tags: + - cmsPage + description: Save page. + operationId: PostV1CmsPage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CmsPageBody + in: body + schema: + required: + - page + properties: + page: + "$ref": "#/definitions/cms-data-page-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/cms-data-page-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: cmsPage + "/V1/cmsPage/search": + get: + tags: + - cmsPage/search + description: Retrieve pages matching the specified criteria. + operationId: GetV1CmsPageSearch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/cms-data-page-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: cmsPage/search + "/V1/cmsPage/{id}": + put: + tags: + - cmsPage/{id} + description: Save page. + operationId: PutV1CmsPageId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: string + required: true + - name: PutV1CmsPageIdBody + in: body + schema: + required: + - page + properties: + page: + "$ref": "#/definitions/cms-data-page-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/cms-data-page-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: cmsPage/{id} + "/V1/cmsPage/{pageId}": + get: + tags: + - cmsPage/{pageId} + description: Retrieve page. + operationId: GetV1CmsPagePageId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: pageId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/cms-data-page-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: cmsPage/{pageId} + delete: + tags: + - cmsPage/{pageId} + description: Delete page by ID. + operationId: DeleteV1CmsPagePageId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: pageId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: cmsPage/{pageId} + "/V1/company/": + get: + tags: + - company/ + description: Returns the list of companies. The list is an array of objects, + and detailed information about item attributes might not be included. + operationId: GetV1Company + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/company-data-company-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: company/ + post: + tags: + - company/ + description: Create or update a company account. + operationId: PostV1Company + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CompanyBody + in: body + schema: + required: + - company + properties: + company: + "$ref": "#/definitions/company-data-company-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/company-data-company-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: company/ + "/V1/company/assignRoles": + put: + tags: + - company/assignRoles + description: Change a role for a company user. + operationId: PutV1CompanyAssignRoles + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1CompanyAssignRolesBody + in: body + schema: + required: + - userId + - roles + properties: + userId: + type: integer + roles: + type: array + items: + "$ref": "#/definitions/company-data-role-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: company/assignRoles + "/V1/company/relations": + get: + tags: + - company/relations + description: Get existing company relation(s) + operationId: GetV1CompanyRelations + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/company-relation-data-relation-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: company/relations + "/V1/company/role/": + get: + tags: + - company/role/ + description: Returns the list of roles and permissions for a specified company. + operationId: GetV1CompanyRole + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/company-data-role-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: company/role/ + post: + tags: + - company/role/ + description: Create or update a role for a selected company. + operationId: PostV1CompanyRole + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CompanyRoleBody + in: body + schema: + required: + - role + properties: + role: + "$ref": "#/definitions/company-data-role-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/company-data-role-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: company/role/ + "/V1/company/role/{id}": + put: + tags: + - company/role/{id} + description: Create or update a role for a selected company. + operationId: PutV1CompanyRoleId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: string + required: true + - name: PutV1CompanyRoleIdBody + in: body + schema: + required: + - role + properties: + role: + "$ref": "#/definitions/company-data-role-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/company-data-role-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: company/role/{id} + "/V1/company/role/{roleId}": + get: + tags: + - company/role/{roleId} + description: Returns the list of permissions for a specified role. + operationId: GetV1CompanyRoleRoleId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: roleId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/company-data-role-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: company/role/{roleId} + delete: + tags: + - company/role/{roleId} + description: Delete a role. + operationId: DeleteV1CompanyRoleRoleId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: roleId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: company/role/{roleId} + "/V1/company/role/{roleId}/users": + get: + tags: + - company/role/{roleId}/users + description: View the list of company users assigned to a specified role. + operationId: GetV1CompanyRoleRoleIdUsers + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: roleId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/customer-data-customer-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: company/role/{roleId}/users + "/V1/company/{companyId}": + get: + tags: + - company/{companyId} + description: Returns company details. + operationId: GetV1CompanyCompanyId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: companyId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/company-data-company-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: company/{companyId} + delete: + tags: + - company/{companyId} + description: Delete a company. Customers belonging to a company are not deleted + with this request. + operationId: DeleteV1CompanyCompanyId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: companyId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: company/{companyId} + put: + tags: + - company/{companyId} + description: Create or update a company account. + operationId: PutV1CompanyCompanyId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: companyId + in: path + type: string + required: true + - name: PutV1CompanyCompanyIdBody + in: body + schema: + required: + - company + properties: + company: + "$ref": "#/definitions/company-data-company-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/company-data-company-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: company/{companyId} + "/V1/company/{parentId}/relations": + post: + tags: + - company/{parentId}/relations + description: Create relation(s) between companies. + operationId: PostV1CompanyParentIdRelations + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: parentId + in: path + type: integer + required: true + - name: PostV1CompanyParentIdRelationsBody + in: body + schema: + required: + - relations + properties: + relations: + type: array + items: + "$ref": "#/definitions/company-relation-data-relation-interface" + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: company/{parentId}/relations + "/V1/company/{parentId}/relations/{companyId}": + delete: + tags: + - company/{parentId}/relations/{companyId} + description: Delete relation of the company to the parent by respective ids. + operationId: DeleteV1CompanyParentIdRelationsCompanyId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: parentId + in: path + type: integer + required: true + - name: companyId + in: path + type: integer + required: true + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: company/{parentId}/relations/{companyId} + "/V1/companyCredits/": + get: + tags: + - companyCredits/ + description: Returns the list of credits for specified companies. + operationId: GetV1CompanyCredits + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/company-credit-data-credit-limit-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: companyCredits/ + "/V1/companyCredits/company/{companyId}": + get: + tags: + - companyCredits/company/{companyId} + description: Returns data on the credit limit for a specified company. + operationId: GetV1CompanyCreditsCompanyCompanyId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: companyId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/company-credit-data-credit-limit-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: companyCredits/company/{companyId} + "/V1/companyCredits/history": + get: + tags: + - companyCredits/history + description: Returns the credit history for one or more companies. + operationId: GetV1CompanyCreditsHistory + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/company-credit-data-history-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: companyCredits/history + "/V1/companyCredits/history/{historyId}": + put: + tags: + - companyCredits/history/{historyId} + description: Update the PO Number and/or comment for a Reimburse transaction. + operationId: PutV1CompanyCreditsHistoryHistoryId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: historyId + in: path + type: integer + required: true + - name: PutV1CompanyCreditsHistoryHistoryIdBody + in: body + schema: + properties: + purchaseOrder: + type: string + description: "[optional]" + comment: + type: string + description: "[optional]" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: companyCredits/history/{historyId} + "/V1/companyCredits/{creditId}": + get: + tags: + - companyCredits/{creditId} + description: Returns data on the credit limit for a specified credit limit ID. + operationId: GetV1CompanyCreditsCreditId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: creditId + in: path + type: integer + required: true + - name: reload + in: query + type: boolean + description: "[optional]" + required: false + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/company-credit-data-credit-limit-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: companyCredits/{creditId} + "/V1/companyCredits/{creditId}/decreaseBalance": + post: + tags: + - companyCredits/{creditId}/decreaseBalance + description: Decreases the company credit with an Update, Reimburse, or Purchase + transaction. This transaction increases company's outstanding balance and + decreases company's available credit. + operationId: PostV1CompanyCreditsCreditIdDecreaseBalance + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: creditId + in: path + type: integer + required: true + - name: PostV1CompanyCreditsCreditIdDecreaseBalanceBody + in: body + schema: + required: + - value + - currency + - operationType + properties: + value: + type: number + currency: + type: string + operationType: + type: integer + comment: + type: string + description: "[optional]" + options: + "$ref": "#/definitions/company-credit-data-credit-balance-options-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: companyCredits/{creditId}/decreaseBalance + "/V1/companyCredits/{creditId}/increaseBalance": + post: + tags: + - companyCredits/{creditId}/increaseBalance + description: Increases the company credit with an Allocate, Update, Refund, + Revert, or Reimburse transaction. This transaction decreases company's outstanding + balance and increases company's available credit. + operationId: PostV1CompanyCreditsCreditIdIncreaseBalance + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: creditId + in: path + type: integer + required: true + - name: PostV1CompanyCreditsCreditIdIncreaseBalanceBody + in: body + schema: + required: + - value + - currency + - operationType + properties: + value: + type: number + currency: + type: string + operationType: + type: integer + comment: + type: string + description: "[optional]" + options: + "$ref": "#/definitions/company-credit-data-credit-balance-options-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: companyCredits/{creditId}/increaseBalance + "/V1/companyCredits/{id}": + put: + tags: + - companyCredits/{id} + description: 'Update the following company credit attributes: credit currency, + credit limit and setting to exceed credit.' + operationId: PutV1CompanyCreditsId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: string + required: true + - name: PutV1CompanyCreditsIdBody + in: body + schema: + required: + - creditLimit + properties: + creditLimit: + "$ref": "#/definitions/company-credit-data-credit-limit-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/company-credit-data-credit-limit-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: companyCredits/{id} + "/V1/configurable-products/variation": + put: + tags: + - configurable-products/variation + description: Generate variation based on same product + operationId: PutV1ConfigurableproductsVariation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1ConfigurableproductsVariationBody + in: body + schema: + required: + - product + - options + properties: + product: + "$ref": "#/definitions/catalog-data-product-interface" + options: + type: array + items: + "$ref": "#/definitions/configurable-product-data-option-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-product-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: configurable-products/variation + "/V1/configurable-products/{sku}/child": + post: + tags: + - configurable-products/{sku}/child + description: '' + operationId: PostV1ConfigurableproductsSkuChild + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: PostV1ConfigurableproductsSkuChildBody + in: body + schema: + required: + - childSku + properties: + childSku: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: configurable-products/{sku}/child + "/V1/configurable-products/{sku}/children": + get: + tags: + - configurable-products/{sku}/children + description: Get all children for Configurable product + operationId: GetV1ConfigurableproductsSkuChildren + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-product-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: configurable-products/{sku}/children + "/V1/configurable-products/{sku}/children/{childSku}": + delete: + tags: + - configurable-products/{sku}/children/{childSku} + description: Remove configurable product option + operationId: DeleteV1ConfigurableproductsSkuChildrenChildSku + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: childSku + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: configurable-products/{sku}/children/{childSku} + "/V1/configurable-products/{sku}/options": + post: + tags: + - configurable-products/{sku}/options + description: Save option + operationId: PostV1ConfigurableproductsSkuOptions + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: PostV1ConfigurableproductsSkuOptionsBody + in: body + schema: + required: + - option + properties: + option: + "$ref": "#/definitions/configurable-product-data-option-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: configurable-products/{sku}/options + "/V1/configurable-products/{sku}/options/all": + get: + tags: + - configurable-products/{sku}/options/all + description: Get all options for configurable product + operationId: GetV1ConfigurableproductsSkuOptionsAll + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/configurable-product-data-option-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: configurable-products/{sku}/options/all + "/V1/configurable-products/{sku}/options/{id}": + get: + tags: + - configurable-products/{sku}/options/{id} + description: Get option for configurable product + operationId: GetV1ConfigurableproductsSkuOptionsId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: id + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/configurable-product-data-option-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: configurable-products/{sku}/options/{id} + put: + tags: + - configurable-products/{sku}/options/{id} + description: Save option + operationId: PutV1ConfigurableproductsSkuOptionsId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: id + in: path + type: string + required: true + - name: PutV1ConfigurableproductsSkuOptionsIdBody + in: body + schema: + required: + - option + properties: + option: + "$ref": "#/definitions/configurable-product-data-option-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: configurable-products/{sku}/options/{id} + delete: + tags: + - configurable-products/{sku}/options/{id} + description: Remove option from configurable product + operationId: DeleteV1ConfigurableproductsSkuOptionsId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: id + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: configurable-products/{sku}/options/{id} + "/V1/coupons": + post: + tags: + - coupons + description: Save a coupon. + operationId: PostV1Coupons + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CouponsBody + in: body + schema: + required: + - coupon + properties: + coupon: + "$ref": "#/definitions/sales-rule-data-coupon-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-rule-data-coupon-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: coupons + "/V1/coupons/deleteByCodes": + post: + tags: + - coupons/deleteByCodes + description: Delete coupon by coupon codes. + operationId: PostV1CouponsDeleteByCodes + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CouponsDeleteByCodesBody + in: body + schema: + required: + - codes + properties: + codes: + type: array + items: + type: string + ignoreInvalidCoupons: + type: boolean + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-rule-data-coupon-mass-delete-result-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: coupons/deleteByCodes + "/V1/coupons/deleteByIds": + post: + tags: + - coupons/deleteByIds + description: Delete coupon by coupon ids. + operationId: PostV1CouponsDeleteByIds + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CouponsDeleteByIdsBody + in: body + schema: + required: + - ids + properties: + ids: + type: array + items: + type: integer + ignoreInvalidCoupons: + type: boolean + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-rule-data-coupon-mass-delete-result-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: coupons/deleteByIds + "/V1/coupons/generate": + post: + tags: + - coupons/generate + description: Generate coupon for a rule + operationId: PostV1CouponsGenerate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CouponsGenerateBody + in: body + schema: + required: + - couponSpec + properties: + couponSpec: + "$ref": "#/definitions/sales-rule-data-coupon-generation-spec-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + items: + type: string + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: coupons/generate + "/V1/coupons/search": + get: + tags: + - coupons/search + description: Retrieve a coupon using the specified search criteria. This call + returns an array of objects, but detailed information about each object’s + attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#CouponRepositoryInterface + to determine which call to use to get detailed information about all attributes + for an object. + operationId: GetV1CouponsSearch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-rule-data-coupon-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: coupons/search + "/V1/coupons/{couponId}": + get: + tags: + - coupons/{couponId} + description: Get coupon by coupon id. + operationId: GetV1CouponsCouponId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: couponId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-rule-data-coupon-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: coupons/{couponId} + put: + tags: + - coupons/{couponId} + description: Save a coupon. + operationId: PutV1CouponsCouponId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: couponId + in: path + type: string + required: true + - name: PutV1CouponsCouponIdBody + in: body + schema: + required: + - coupon + properties: + coupon: + "$ref": "#/definitions/sales-rule-data-coupon-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-rule-data-coupon-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: coupons/{couponId} + delete: + tags: + - coupons/{couponId} + description: Delete coupon by coupon id. + operationId: DeleteV1CouponsCouponId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: couponId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: coupons/{couponId} + "/V1/creditmemo": + post: + tags: + - creditmemo + description: Performs persist operations for a specified credit memo. + operationId: PostV1Creditmemo + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CreditmemoBody + in: body + schema: + required: + - entity + properties: + entity: + "$ref": "#/definitions/sales-data-creditmemo-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-creditmemo-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: creditmemo + "/V1/creditmemo/refund": + post: + tags: + - creditmemo/refund + description: Prepare creditmemo to refund and save it. + operationId: PostV1CreditmemoRefund + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CreditmemoRefundBody + in: body + schema: + required: + - creditmemo + properties: + creditmemo: + "$ref": "#/definitions/sales-data-creditmemo-interface" + offlineRequested: + type: boolean + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-creditmemo-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: creditmemo/refund + "/V1/creditmemo/{id}": + put: + tags: + - creditmemo/{id} + description: Cancels a specified credit memo. + operationId: PutV1CreditmemoId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The credit memo ID. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: creditmemo/{id} + get: + tags: + - creditmemo/{id} + description: Loads a specified credit memo. + operationId: GetV1CreditmemoId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The credit memo ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-creditmemo-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: creditmemo/{id} + "/V1/creditmemo/{id}/comments": + get: + tags: + - creditmemo/{id}/comments + description: Lists comments for a specified credit memo. + operationId: GetV1CreditmemoIdComments + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The credit memo ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-creditmemo-comment-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: creditmemo/{id}/comments + post: + tags: + - creditmemo/{id}/comments + description: Performs persist operations for a specified entity. + operationId: PostV1CreditmemoIdComments + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: string + required: true + - name: PostV1CreditmemoIdCommentsBody + in: body + schema: + required: + - entity + properties: + entity: + "$ref": "#/definitions/sales-data-creditmemo-comment-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-creditmemo-comment-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: creditmemo/{id}/comments + "/V1/creditmemo/{id}/emails": + post: + tags: + - creditmemo/{id}/emails + description: Emails a user a specified credit memo. + operationId: PostV1CreditmemoIdEmails + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The credit memo ID. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: creditmemo/{id}/emails + "/V1/creditmemos": + get: + tags: + - creditmemos + description: Lists credit memos that match specified search criteria. This call + returns an array of objects, but detailed information about each object’s + attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#CreditmemoRepositoryInterface + to determine which call to use to get detailed information about all attributes + for an object. + operationId: GetV1Creditmemos + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-creditmemo-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: creditmemos + "/V1/customerGroups": + post: + tags: + - customerGroups + description: Save customer group. + operationId: PostV1CustomerGroups + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CustomerGroupsBody + in: body + schema: + required: + - group + properties: + group: + "$ref": "#/definitions/customer-data-group-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-group-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customerGroups + "/V1/customerGroups/default": + get: + tags: + - customerGroups/default + description: Get default customer group. + operationId: GetV1CustomerGroupsDefault + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: storeId + in: query + type: integer + required: false + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-group-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customerGroups/default + "/V1/customerGroups/default/{id}": + put: + tags: + - customerGroups/default/{id} + description: Set system default customer group. + operationId: PutV1CustomerGroupsDefaultId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: integer + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customerGroups/default/{id} + "/V1/customerGroups/default/{storeId}": + get: + tags: + - customerGroups/default/{storeId} + description: Get default customer group. + operationId: GetV1CustomerGroupsDefaultStoreId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: storeId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-group-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customerGroups/default/{storeId} + "/V1/customerGroups/search": + get: + tags: + - customerGroups/search + description: Retrieve customer groups. The list of groups can be filtered to + exclude the NOT_LOGGED_IN group using the first parameter and/or it can be + filtered by tax class. This call returns an array of objects, but detailed + information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#GroupRepositoryInterface + to determine which call to use to get detailed information about all attributes + for an object. + operationId: GetV1CustomerGroupsSearch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-group-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customerGroups/search + "/V1/customerGroups/{id}": + get: + tags: + - customerGroups/{id} + description: Get customer group by group ID. + operationId: GetV1CustomerGroupsId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-group-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customerGroups/{id} + put: + tags: + - customerGroups/{id} + description: Save customer group. + operationId: PutV1CustomerGroupsId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: string + required: true + - name: PutV1CustomerGroupsIdBody + in: body + schema: + required: + - group + properties: + group: + "$ref": "#/definitions/customer-data-group-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-group-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customerGroups/{id} + delete: + tags: + - customerGroups/{id} + description: Delete customer group by ID. + operationId: DeleteV1CustomerGroupsId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customerGroups/{id} + "/V1/customerGroups/{id}/permissions": + get: + tags: + - customerGroups/{id}/permissions + description: Check if customer group can be deleted. + operationId: GetV1CustomerGroupsIdPermissions + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customerGroups/{id}/permissions + "/V1/customers": + post: + tags: + - customers + description: Create customer account. Perform necessary business operations + like sending email. + operationId: PostV1Customers + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CustomersBody + in: body + schema: + required: + - customer + properties: + customer: + "$ref": "#/definitions/customer-data-customer-interface" + password: + type: string + redirectUrl: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-customer-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers + "/V1/customers/activate": + post: + tags: + - customers/activate + description: Activate a customer account using a key that was sent in a confirmation + email. + operationId: PostV1CustomersActivate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CustomersActivateBody + in: body + schema: + required: + - email + - confirmationKey + properties: + email: + type: string + confirmationKey: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-customer-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/activate + "/V1/customers/addresses/{addressId}": + get: + tags: + - customers/addresses/{addressId} + description: Retrieve customer address. + operationId: GetV1CustomersAddressesAddressId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: addressId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-address-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/addresses/{addressId} + "/V1/customers/companies": + post: + tags: + - customers/companies + description: Save customer attributes for company. + operationId: PostV1CustomersCompanies + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CustomersCompaniesBody + in: body + schema: + required: + - companyAttributes + properties: + companyAttributes: + "$ref": "#/definitions/company-data-company-customer-interface" + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/companies + get: + tags: + - customers/companies + description: Returns the list of company customer attributes. + operationId: GetV1CustomersCompanies + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: criteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: criteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: criteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: criteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: criteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: criteria[pageSize] + in: query + type: integer + description: Page size. + - name: criteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/company-data-company-customer-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/companies + "/V1/customers/confirm": + post: + tags: + - customers/confirm + description: Resend confirmation email. + operationId: PostV1CustomersConfirm + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CustomersConfirmBody + in: body + schema: + required: + - email + - websiteId + properties: + email: + type: string + websiteId: + type: integer + redirectUrl: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/confirm + "/V1/customers/isEmailAvailable": + post: + tags: + - customers/isEmailAvailable + description: Check if given email is associated with a customer account in given + website. + operationId: PostV1CustomersIsEmailAvailable + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CustomersIsEmailAvailableBody + in: body + schema: + required: + - customerEmail + properties: + customerEmail: + type: string + websiteId: + type: integer + description: If not set, will use the current websiteId + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/isEmailAvailable + "/V1/customers/me": + put: + tags: + - customers/me + description: Create or update a customer. + operationId: PutV1CustomersMe + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1CustomersMeBody + in: body + schema: + required: + - customer + properties: + customer: + "$ref": "#/definitions/customer-data-customer-interface" + passwordHash: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-customer-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/me + get: + tags: + - customers/me + description: Get customer by Customer ID. + operationId: GetV1CustomersMe + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-customer-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/me + "/V1/customers/me/activate": + put: + tags: + - customers/me/activate + description: Activate a customer account using a key that was sent in a confirmation + email. + operationId: PutV1CustomersMeActivate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1CustomersMeActivateBody + in: body + schema: + required: + - confirmationKey + properties: + confirmationKey: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-customer-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/me/activate + "/V1/customers/me/billingAddress": + get: + tags: + - customers/me/billingAddress + description: Retrieve default billing address for the given customerId. + operationId: GetV1CustomersMeBillingAddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-address-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/me/billingAddress + "/V1/customers/me/password": + put: + tags: + - customers/me/password + description: Change customer password. + operationId: PutV1CustomersMePassword + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1CustomersMePasswordBody + in: body + schema: + required: + - currentPassword + - newPassword + properties: + currentPassword: + type: string + newPassword: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/me/password + "/V1/customers/me/shippingAddress": + get: + tags: + - customers/me/shippingAddress + description: Retrieve default shipping address for the given customerId. + operationId: GetV1CustomersMeShippingAddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-address-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/me/shippingAddress + "/V1/customers/password": + put: + tags: + - customers/password + description: Send an email to the customer with a password reset link. + operationId: PutV1CustomersPassword + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1CustomersPasswordBody + in: body + schema: + required: + - email + - template + properties: + email: + type: string + template: + type: string + websiteId: + type: integer + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/password + "/V1/customers/resetPassword": + post: + tags: + - customers/resetPassword + description: Reset customer password. + operationId: PostV1CustomersResetPassword + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CustomersResetPasswordBody + in: body + schema: + required: + - email + - resetToken + - newPassword + properties: + email: + type: string + description: If empty value given then the customer will be matched + by the RP token. + resetToken: + type: string + newPassword: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/resetPassword + "/V1/customers/search": + get: + tags: + - customers/search + description: Retrieve customers which match a specified criteria. This call + returns an array of objects, but detailed information about each object’s + attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#CustomerRepositoryInterface + to determine which call to use to get detailed information about all attributes + for an object. + operationId: GetV1CustomersSearch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-customer-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/search + "/V1/customers/validate": + put: + tags: + - customers/validate + description: Validate customer data. + operationId: PutV1CustomersValidate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1CustomersValidateBody + in: body + schema: + required: + - customer + properties: + customer: + "$ref": "#/definitions/customer-data-customer-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-validation-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/validate + "/V1/customers/{customerId}": + get: + tags: + - customers/{customerId} + description: Get customer by Customer ID. + operationId: GetV1CustomersCustomerId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: customerId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-customer-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/{customerId} + put: + tags: + - customers/{customerId} + description: Create or update a customer. + operationId: PutV1CustomersCustomerId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: customerId + in: path + type: string + required: true + - name: PutV1CustomersCustomerIdBody + in: body + schema: + required: + - customer + properties: + customer: + "$ref": "#/definitions/customer-data-customer-interface" + passwordHash: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-customer-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/{customerId} + delete: + tags: + - customers/{customerId} + description: Delete customer by Customer ID. + operationId: DeleteV1CustomersCustomerId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: customerId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/{customerId} + "/V1/customers/{customerId}/billingAddress": + get: + tags: + - customers/{customerId}/billingAddress + description: Retrieve default billing address for the given customerId. + operationId: GetV1CustomersCustomerIdBillingAddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: customerId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-address-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/{customerId}/billingAddress + "/V1/customers/{customerId}/carts": + post: + tags: + - customers/{customerId}/carts + description: Creates an empty cart and quote for a specified customer if customer + does not have a cart yet. + operationId: PostV1CustomersCustomerIdCarts + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: customerId + in: path + type: integer + required: true + description: The customer ID. + responses: + '200': + description: 200 Success. + schema: + type: integer + description: new cart ID if customer did not have a cart or ID of the + existing cart otherwise. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/{customerId}/carts + "/V1/customers/{customerId}/companies": + get: + tags: + - customers/{customerId}/companies + description: Returns a list of companies the customer is assigned to + operationId: GetV1CustomersCustomerIdCompanies + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: customerId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/company-data-company-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/{customerId}/companies + "/V1/customers/{customerId}/companies/{companyId}": + put: + tags: + - customers/{customerId}/companies/{companyId} + description: Assigns customer as a company user. + operationId: PutV1CustomersCustomerIdCompaniesCompanyId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: companyId + in: path + type: integer + required: true + - name: customerId + in: path + type: integer + required: true + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/{customerId}/companies/{companyId} + delete: + tags: + - customers/{customerId}/companies/{companyId} + description: Unassigns customer from the company. + operationId: DeleteV1CustomersCustomerIdCompaniesCompanyId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: companyId + in: path + type: integer + required: true + - name: customerId + in: path + type: integer + required: true + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/{customerId}/companies/{companyId} + get: + tags: + - customers/{customerId}/companies/{companyId} + description: Returns customer attributes for company by ID. + operationId: GetV1CustomersCustomerIdCompaniesCompanyId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: customerId + in: path + type: integer + required: true + - name: companyId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/company-data-company-customer-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/{customerId}/companies/{companyId} + "/V1/customers/{customerId}/confirm": + get: + tags: + - customers/{customerId}/confirm + description: Gets the account confirmation status. + operationId: GetV1CustomersCustomerIdConfirm + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: customerId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: string + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/{customerId}/confirm + "/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}": + get: + tags: + - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} + description: Check if password reset token is valid. + operationId: GetV1CustomersCustomerIdPasswordResetLinkTokenResetPasswordLinkToken + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: customerId + in: path + type: integer + required: true + description: If null is given then a customer will be matched by the RP token. + - name: resetPasswordLinkToken + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: True if the token is valid + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} + "/V1/customers/{customerId}/permissions/readonly": + get: + tags: + - customers/{customerId}/permissions/readonly + description: Check if customer can be deleted. + operationId: GetV1CustomersCustomerIdPermissionsReadonly + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: customerId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/{customerId}/permissions/readonly + "/V1/customers/{customerId}/shippingAddress": + get: + tags: + - customers/{customerId}/shippingAddress + description: Retrieve default shipping address for the given customerId. + operationId: GetV1CustomersCustomerIdShippingAddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: customerId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-address-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/{customerId}/shippingAddress + "/V1/customers/{customerId}/token": + post: + tags: + - customers/{customerId}/token + description: Generate a customer token based on the provided customer ID. + operationId: PostV1CustomersCustomerIdToken + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: customerId + in: path + type: integer + required: true + description: The ID of the customer for whom the token is to be generated. + responses: + '200': + description: 200 Success. + schema: + type: string + description: The generated customer token. + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/{customerId}/token + "/V1/customers/{email}/activate": + put: + tags: + - customers/{email}/activate + description: Activate a customer account using a key that was sent in a confirmation + email. + operationId: PutV1CustomersEmailActivate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: email + in: path + type: string + required: true + - name: PutV1CustomersEmailActivateBody + in: body + schema: + required: + - confirmationKey + properties: + confirmationKey: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-customer-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/{email}/activate + "/V1/directory/countries": + get: + tags: + - directory/countries + description: Get all countries and regions information for the store. + operationId: GetV1DirectoryCountries + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/directory-data-country-information-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: directory/countries + "/V1/directory/countries/{countryId}": + get: + tags: + - directory/countries/{countryId} + description: Get country and region information for the store. + operationId: GetV1DirectoryCountriesCountryId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: countryId + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/directory-data-country-information-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: directory/countries/{countryId} + "/V1/directory/currency": + get: + tags: + - directory/currency + description: Get currency information for the store. + operationId: GetV1DirectoryCurrency + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/directory-data-currency-information-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: directory/currency + "/V1/eav/attribute-sets": + post: + tags: + - eav/attribute-sets + description: Create attribute set from data + operationId: PostV1EavAttributesets + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1EavAttributesetsBody + in: body + schema: + required: + - entityTypeCode + - attributeSet + - skeletonId + properties: + entityTypeCode: + type: string + attributeSet: + "$ref": "#/definitions/eav-data-attribute-set-interface" + skeletonId: + type: integer + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/eav-data-attribute-set-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: eav/attribute-sets + "/V1/eav/attribute-sets/list": + get: + tags: + - eav/attribute-sets/list + description: Retrieve list of Attribute Sets This call returns an array of objects, + but detailed information about each object’s attributes might not be included. + See https://developer.adobe.com/commerce/webapi/rest/attributes#AttributeSetRepositoryInterface + to determine which call to use to get detailed information about all attributes + for an object. + operationId: GetV1EavAttributesetsList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/eav-data-attribute-set-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: eav/attribute-sets/list + "/V1/eav/attribute-sets/{attributeSetId}": + get: + tags: + - eav/attribute-sets/{attributeSetId} + description: Retrieve attribute set information based on given ID + operationId: GetV1EavAttributesetsAttributeSetId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeSetId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/eav-data-attribute-set-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: eav/attribute-sets/{attributeSetId} + delete: + tags: + - eav/attribute-sets/{attributeSetId} + description: Remove attribute set by given ID + operationId: DeleteV1EavAttributesetsAttributeSetId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeSetId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: eav/attribute-sets/{attributeSetId} + put: + tags: + - eav/attribute-sets/{attributeSetId} + description: Save attribute set data + operationId: PutV1EavAttributesetsAttributeSetId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeSetId + in: path + type: string + required: true + - name: PutV1EavAttributesetsAttributeSetIdBody + in: body + schema: + required: + - attributeSet + properties: + attributeSet: + "$ref": "#/definitions/eav-data-attribute-set-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/eav-data-attribute-set-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: eav/attribute-sets/{attributeSetId} + "/V1/eventing/eventProvider": + get: + tags: + - eventing/eventProvider + description: Returns the list of event providers + operationId: GetV1EventingEventProvider + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: eventing/eventProvider + post: + tags: + - eventing/eventProvider + description: Create or update the event provider + operationId: PostV1EventingEventProvider + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1EventingEventProviderBody + in: body + schema: + required: + - eventProvider + properties: + eventProvider: + "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: eventing/eventProvider + put: + tags: + - eventing/eventProvider + description: Create or update the event provider + operationId: PutV1EventingEventProvider + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1EventingEventProviderBody + in: body + schema: + required: + - eventProvider + properties: + eventProvider: + "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: eventing/eventProvider + "/V1/eventing/eventProvider/{providerId}": + get: + tags: + - eventing/eventProvider/{providerId} + description: Get a single event provider by provider ID + operationId: GetV1EventingEventProviderProviderId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: providerId + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: eventing/eventProvider/{providerId} + delete: + tags: + - eventing/eventProvider/{providerId} + description: Delete an event provider by provider ID + operationId: DeleteV1EventingEventProviderProviderId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: providerId + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: eventing/eventProvider/{providerId} + "/V1/eventing/eventSubscribe": + post: + tags: + - eventing/eventSubscribe + description: Subscribes to the event. + operationId: PostV1EventingEventSubscribe + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1EventingEventSubscribeBody + in: body + schema: + required: + - event + properties: + event: + "$ref": "#/definitions/adobe-commerce-events-client-data-event-data-interface" + force: + type: boolean + type: object + xml: + name: request + responses: + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: eventing/eventSubscribe + "/V1/eventing/eventSubscribe/{name}": + put: + tags: + - eventing/eventSubscribe/{name} + description: Update the event subscription. + operationId: PutV1EventingEventSubscribeName + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: name + in: path + type: string + required: true + - name: PutV1EventingEventSubscribeNameBody + in: body + schema: + required: + - event + properties: + event: + "$ref": "#/definitions/adobe-commerce-events-client-data-event-data-interface" + type: object + xml: + name: request + responses: + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: eventing/eventSubscribe/{name} + "/V1/eventing/eventUnsubscribe/{name}": + post: + tags: + - eventing/eventUnsubscribe/{name} + description: Unsubscribes from the event with the provided name. + operationId: PostV1EventingEventUnsubscribeName + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: name + in: path + type: string + required: true + responses: + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: eventing/eventUnsubscribe/{name} + "/V1/eventing/getEventProviders": + get: + tags: + - eventing/getEventProviders + description: Returns the list of event providers + operationId: GetV1EventingGetEventProviders + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/adobe-commerce-events-client-data-event-provider-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: eventing/getEventProviders + "/V1/eventing/getEventSubscriptions": + get: + tags: + - eventing/getEventSubscriptions + description: Returns the list of all subscribed events + operationId: GetV1EventingGetEventSubscriptions + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/adobe-commerce-events-client-data-event-data-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: eventing/getEventSubscriptions + "/V1/eventing/updateConfiguration": + put: + tags: + - eventing/updateConfiguration + description: Updates eventing configuration + operationId: PutV1EventingUpdateConfiguration + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1EventingUpdateConfigurationBody + in: body + schema: + required: + - config + properties: + config: + "$ref": "#/definitions/adobe-commerce-events-client-data-configuration-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: eventing/updateConfiguration + "/V1/gift-wrappings": + post: + tags: + - gift-wrappings + description: Create/Update new gift wrapping with data object values + operationId: PostV1Giftwrappings + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1GiftwrappingsBody + in: body + schema: + required: + - data + properties: + data: + "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" + storeId: + type: integer + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: gift-wrappings + get: + tags: + - gift-wrappings + description: Return list of gift wrapping data objects based on search criteria + operationId: GetV1Giftwrappings + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/gift-wrapping-data-wrapping-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: gift-wrappings + "/V1/gift-wrappings/{id}": + get: + tags: + - gift-wrappings/{id} + description: Return data object for specified wrapping ID and store. + operationId: GetV1GiftwrappingsId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + - name: storeId + in: query + type: integer + required: false + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: gift-wrappings/{id} + delete: + tags: + - gift-wrappings/{id} + description: Delete gift wrapping + operationId: DeleteV1GiftwrappingsId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: gift-wrappings/{id} + "/V1/gift-wrappings/{wrappingId}": + put: + tags: + - gift-wrappings/{wrappingId} + description: Create/Update new gift wrapping with data object values + operationId: PutV1GiftwrappingsWrappingId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: wrappingId + in: path + type: string + required: true + - name: PutV1GiftwrappingsWrappingIdBody + in: body + schema: + required: + - data + properties: + data: + "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" + storeId: + type: integer + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: gift-wrappings/{wrappingId} + "/V1/giftregistry/mine/estimate-shipping-methods": + post: + tags: + - giftregistry/mine/estimate-shipping-methods + description: Estimate shipping + operationId: PostV1GiftregistryMineEstimateshippingmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1GiftregistryMineEstimateshippingmethodsBody + in: body + schema: + required: + - registryId + properties: + registryId: + type: integer + description: The estimate registry id + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods. + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: giftregistry/mine/estimate-shipping-methods + "/V1/guest-carts": + post: + tags: + - guest-carts + description: Enable an customer or guest user to create an empty cart and quote + for an anonymous customer. + operationId: PostV1Guestcarts + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: string + description: Cart ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts + "/V1/guest-carts/{cartId}": + get: + tags: + - guest-carts/{cartId} + description: Enable a guest user to return information for a specified cart. + operationId: GetV1GuestcartsCartId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-cart-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId} + put: + tags: + - guest-carts/{cartId} + description: Assign a specified customer to a specified shopping cart. + operationId: PutV1GuestcartsCartId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: PutV1GuestcartsCartIdBody + in: body + schema: + required: + - storeId + properties: + storeId: + type: integer + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId} + "/V1/guest-carts/{cartId}/billing-address": + get: + tags: + - guest-carts/{cartId}/billing-address + description: Return the billing address for a specified quote. + operationId: GetV1GuestcartsCartIdBillingaddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-address-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/billing-address + post: + tags: + - guest-carts/{cartId}/billing-address + description: Assign a specified billing address to a specified cart. + operationId: PostV1GuestcartsCartIdBillingaddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: PostV1GuestcartsCartIdBillingaddressBody + in: body + schema: + required: + - address + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + useForShipping: + type: boolean + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Address ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/billing-address + "/V1/guest-carts/{cartId}/collect-totals": + put: + tags: + - guest-carts/{cartId}/collect-totals + description: Set shipping/billing methods and additional data for cart and collect + totals for guest. + operationId: PutV1GuestcartsCartIdCollecttotals + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: PutV1GuestcartsCartIdCollecttotalsBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + shippingCarrierCode: + type: string + description: The carrier code. + shippingMethodCode: + type: string + description: The shipping method code. + additionalData: + "$ref": "#/definitions/quote-data-totals-additional-data-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-totals-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/collect-totals + "/V1/guest-carts/{cartId}/coupons": + get: + tags: + - guest-carts/{cartId}/coupons + description: Return information for a coupon in a specified cart. + operationId: GetV1GuestcartsCartIdCoupons + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + type: string + description: The coupon code data. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/coupons + delete: + tags: + - guest-carts/{cartId}/coupons + description: Delete a coupon from a specified cart. + operationId: DeleteV1GuestcartsCartIdCoupons + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/coupons + "/V1/guest-carts/{cartId}/coupons/{couponCode}": + put: + tags: + - guest-carts/{cartId}/coupons/{couponCode} + description: Add a coupon by code to a specified cart. + operationId: PutV1GuestcartsCartIdCouponsCouponCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: couponCode + in: path + type: string + required: true + description: The coupon code data. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/coupons/{couponCode} + "/V1/guest-carts/{cartId}/estimate-shipping-methods": + post: + tags: + - guest-carts/{cartId}/estimate-shipping-methods + description: Estimate shipping by address and return list of available shipping + methods + operationId: PostV1GuestcartsCartIdEstimateshippingmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdEstimateshippingmethodsBody + in: body + schema: + required: + - address + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/estimate-shipping-methods + "/V1/guest-carts/{cartId}/gift-message": + get: + tags: + - guest-carts/{cartId}/gift-message + description: Return the gift message for a specified order. + operationId: GetV1GuestcartsCartIdGiftmessage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The shopping cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/gift-message-data-message-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/gift-message + post: + tags: + - guest-carts/{cartId}/gift-message + description: Set the gift message for an entire order. + operationId: PostV1GuestcartsCartIdGiftmessage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: PostV1GuestcartsCartIdGiftmessageBody + in: body + schema: + required: + - giftMessage + properties: + giftMessage: + "$ref": "#/definitions/gift-message-data-message-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/gift-message + "/V1/guest-carts/{cartId}/gift-message/{itemId}": + get: + tags: + - guest-carts/{cartId}/gift-message/{itemId} + description: Return the gift message for a specified item in a specified shopping + cart. + operationId: GetV1GuestcartsCartIdGiftmessageItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The shopping cart ID. + - name: itemId + in: path + type: integer + required: true + description: The item ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/gift-message-data-message-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/gift-message/{itemId} + post: + tags: + - guest-carts/{cartId}/gift-message/{itemId} + description: Set the gift message for a specified item in a specified shopping + cart. + operationId: PostV1GuestcartsCartIdGiftmessageItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: itemId + in: path + type: integer + required: true + description: The item ID. + - name: PostV1GuestcartsCartIdGiftmessageItemIdBody + in: body + schema: + required: + - giftMessage + properties: + giftMessage: + "$ref": "#/definitions/gift-message-data-message-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/gift-message/{itemId} + "/V1/guest-carts/{cartId}/items": + get: + tags: + - guest-carts/{cartId}/items + description: List items that are assigned to a specified cart. + operationId: GetV1GuestcartsCartIdItems + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + type: array + description: Array of items. + items: + "$ref": "#/definitions/quote-data-cart-item-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/items + post: + tags: + - guest-carts/{cartId}/items + description: Add/update the specified cart item. + operationId: PostV1GuestcartsCartIdItems + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdItemsBody + in: body + schema: + required: + - cartItem + properties: + cartItem: + "$ref": "#/definitions/quote-data-cart-item-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-cart-item-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/items + "/V1/guest-carts/{cartId}/items/{itemId}": + put: + tags: + - guest-carts/{cartId}/items/{itemId} + description: Add/update the specified cart item. + operationId: PutV1GuestcartsCartIdItemsItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: itemId + in: path + type: string + required: true + - name: PutV1GuestcartsCartIdItemsItemIdBody + in: body + schema: + required: + - cartItem + properties: + cartItem: + "$ref": "#/definitions/quote-data-cart-item-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-cart-item-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/items/{itemId} + delete: + tags: + - guest-carts/{cartId}/items/{itemId} + description: Remove the specified item from the specified cart. + operationId: DeleteV1GuestcartsCartIdItemsItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: itemId + in: path + type: integer + required: true + description: The item ID of the item to be removed. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/items/{itemId} + "/V1/guest-carts/{cartId}/order": + put: + tags: + - guest-carts/{cartId}/order + description: Place an order for a specified cart. + operationId: PutV1GuestcartsCartIdOrder + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: PutV1GuestcartsCartIdOrderBody + in: body + schema: + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/order + "/V1/guest-carts/{cartId}/payment-information": + post: + tags: + - guest-carts/{cartId}/payment-information + description: Set payment information and place order for a specified cart. + operationId: PostV1GuestcartsCartIdPaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdPaymentinformationBody + in: body + schema: + required: + - email + - paymentMethod + properties: + email: + type: string + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/payment-information + get: + tags: + - guest-carts/{cartId}/payment-information + description: Get payment information + operationId: GetV1GuestcartsCartIdPaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/checkout-data-payment-details-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/payment-information + "/V1/guest-carts/{cartId}/payment-methods": + get: + tags: + - guest-carts/{cartId}/payment-methods + description: List available payment methods for a specified shopping cart. This + call returns an array of objects, but detailed information about each object’s + attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#GuestPaymentMethodManagementInterface + to determine which call to use to get detailed information about all attributes + for an object. + operationId: GetV1GuestcartsCartIdPaymentmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + type: array + description: Array of payment methods. + items: + "$ref": "#/definitions/quote-data-payment-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/payment-methods + "/V1/guest-carts/{cartId}/payment-order": + post: + tags: + - guest-carts/{cartId}/payment-order + description: Create a payment order for guest customer + operationId: PostV1GuestcartsCartIdPaymentorder + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdPaymentorderBody + in: body + schema: + required: + - methodCode + - paymentSource + - location + properties: + methodCode: + type: string + paymentSource: + type: string + location: + type: string + vaultIntent: + type: boolean + threeDSMode: + type: string + description: "| null $threeDSMode" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-order-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/payment-order + "/V1/guest-carts/{cartId}/payment-order/{id}": + get: + tags: + - guest-carts/{cartId}/payment-order/{id} + description: Get payment order for guest customer + operationId: GetV1GuestcartsCartIdPaymentorderId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: id + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-order-details-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/payment-order/{id} + post: + tags: + - guest-carts/{cartId}/payment-order/{id} + description: Sync payment order for guest customer + operationId: PostV1GuestcartsCartIdPaymentorderId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: id + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/payment-order/{id} + "/V1/guest-carts/{cartId}/selected-payment-method": + get: + tags: + - guest-carts/{cartId}/selected-payment-method + description: Return the payment method for a specified shopping cart. + operationId: GetV1GuestcartsCartIdSelectedpaymentmethod + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-payment-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/selected-payment-method + put: + tags: + - guest-carts/{cartId}/selected-payment-method + description: Add a specified payment method to a specified shopping cart. + operationId: PutV1GuestcartsCartIdSelectedpaymentmethod + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: PutV1GuestcartsCartIdSelectedpaymentmethodBody + in: body + schema: + required: + - method + properties: + method: + "$ref": "#/definitions/quote-data-payment-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Payment method ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/selected-payment-method + "/V1/guest-carts/{cartId}/set-payment-information": + post: + tags: + - guest-carts/{cartId}/set-payment-information + description: Set payment information for a specified cart. + operationId: PostV1GuestcartsCartIdSetpaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdSetpaymentinformationBody + in: body + schema: + required: + - email + - paymentMethod + properties: + email: + type: string + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/set-payment-information + "/V1/guest-carts/{cartId}/shipping-information": + post: + tags: + - guest-carts/{cartId}/shipping-information + description: '' + operationId: PostV1GuestcartsCartIdShippinginformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdShippinginformationBody + in: body + schema: + required: + - addressInformation + properties: + addressInformation: + "$ref": "#/definitions/checkout-data-shipping-information-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/checkout-data-payment-details-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/shipping-information + "/V1/guest-carts/{cartId}/shipping-methods": + get: + tags: + - guest-carts/{cartId}/shipping-methods + description: List applicable shipping methods for a specified quote. + operationId: GetV1GuestcartsCartIdShippingmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The shopping cart ID. + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods. + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/shipping-methods + "/V1/guest-carts/{cartId}/totals": + get: + tags: + - guest-carts/{cartId}/totals + description: Return quote totals data for a specified cart. + operationId: GetV1GuestcartsCartIdTotals + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-totals-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/totals + "/V1/guest-carts/{cartId}/totals-information": + post: + tags: + - guest-carts/{cartId}/totals-information + description: Calculate quote totals based on address and shipping method. + operationId: PostV1GuestcartsCartIdTotalsinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdTotalsinformationBody + in: body + schema: + required: + - addressInformation + properties: + addressInformation: + "$ref": "#/definitions/checkout-data-totals-information-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-totals-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/totals-information + "/V1/guest-giftregistry/{cartId}/estimate-shipping-methods": + post: + tags: + - guest-giftregistry/{cartId}/estimate-shipping-methods + description: Estimate shipping + operationId: PostV1GuestgiftregistryCartIdEstimateshippingmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The shopping cart ID. + - name: PostV1GuestgiftregistryCartIdEstimateshippingmethodsBody + in: body + schema: + required: + - registryId + properties: + registryId: + type: integer + description: The estimate registry id + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods. + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-giftregistry/{cartId}/estimate-shipping-methods + "/V1/hierarchy/move/{id}": + put: + tags: + - hierarchy/move/{id} + description: Moves teams and users within the company structure. + operationId: PutV1HierarchyMoveId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + - name: PutV1HierarchyMoveIdBody + in: body + schema: + required: + - newParentId + properties: + newParentId: + type: integer + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: hierarchy/move/{id} + "/V1/hierarchy/{id}": + get: + tags: + - hierarchy/{id} + description: Returns the list of teams and company users in the company structure. + operationId: GetV1HierarchyId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/company-data-hierarchy-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: hierarchy/{id} + "/V1/import/csv": + post: + tags: + - import/csv + description: Start import operation + operationId: PostV1ImportCsv + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ImportCsvBody + in: body + schema: + required: + - source + properties: + source: + "$ref": "#/definitions/import-csv-api-data-localized-source-data-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + items: + type: string + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: import/csv + "/V1/import/json": + post: + tags: + - import/json + description: Starts import operation. + operationId: PostV1ImportJson + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ImportJsonBody + in: body + schema: + required: + - source + properties: + source: + "$ref": "#/definitions/import-json-api-data-source-data-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + items: + type: string + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: import/json + "/V1/integration/admin/token": + post: + tags: + - integration/admin/token + description: Create access token for admin given the admin credentials. + operationId: PostV1IntegrationAdminToken + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1IntegrationAdminTokenBody + in: body + schema: + required: + - username + - password + properties: + username: + type: string + password: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + description: Token created + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: integration/admin/token + "/V1/integration/customer/revoke-customer-token": + post: + tags: + - integration/customer/revoke-customer-token + description: Revoke token by customer id. + operationId: PostV1IntegrationCustomerRevokecustomertoken + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: integration/customer/revoke-customer-token + "/V1/integration/customer/token": + post: + tags: + - integration/customer/token + description: Create access token for admin given the customer credentials. + operationId: PostV1IntegrationCustomerToken + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1IntegrationCustomerTokenBody + in: body + schema: + required: + - username + - password + properties: + username: + type: string + password: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + description: Token created + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: integration/customer/token + "/V1/inventory/are-product-salable-for-requested-qty/": + get: + tags: + - inventory/are-product-salable-for-requested-qty/ + description: Get whether products are salable in requested Qty for given set + of SKUs in specified stock. + operationId: GetV1InventoryAreproductsalableforrequestedqty + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: skuRequests[0][sku] + in: query + type: string + description: Product sku. + - name: skuRequests[0][qty] + in: query + type: number + description: Product quantity. + - name: stockId + in: query + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/inventory-sales-api-data-is-product-salable-for-requested-qty-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/are-product-salable-for-requested-qty/ + "/V1/inventory/are-products-salable": + get: + tags: + - inventory/are-products-salable + description: Get products salable status for given SKUs and given Stock. + operationId: GetV1InventoryAreproductssalable + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: skus + in: query + type: array + items: + type: string + required: true + - name: stockId + in: query + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/inventory-sales-api-data-is-product-salable-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/are-products-salable + "/V1/inventory/bulk-partial-source-transfer": + post: + tags: + - inventory/bulk-partial-source-transfer + description: Run bulk partial inventory transfer for specified items. + operationId: PostV1InventoryBulkpartialsourcetransfer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1InventoryBulkpartialsourcetransferBody + in: body + schema: + required: + - originSourceCode + - destinationSourceCode + - items + properties: + originSourceCode: + type: string + destinationSourceCode: + type: string + items: + type: array + items: + "$ref": "#/definitions/inventory-catalog-api-data-partial-inventory-transfer-item-interface" + type: object + xml: + name: request + responses: + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/bulk-partial-source-transfer + "/V1/inventory/bulk-product-source-assign": + post: + tags: + - inventory/bulk-product-source-assign + description: Run mass product to source assignment + operationId: PostV1InventoryBulkproductsourceassign + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1InventoryBulkproductsourceassignBody + in: body + schema: + required: + - skus + - sourceCodes + properties: + skus: + type: array + items: + type: string + sourceCodes: + type: array + items: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/bulk-product-source-assign + "/V1/inventory/bulk-product-source-transfer": + post: + tags: + - inventory/bulk-product-source-transfer + description: Run bulk inventory transfer + operationId: PostV1InventoryBulkproductsourcetransfer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1InventoryBulkproductsourcetransferBody + in: body + schema: + required: + - skus + - originSource + - destinationSource + - unassignFromOrigin + properties: + skus: + type: array + items: + type: string + originSource: + type: string + destinationSource: + type: string + unassignFromOrigin: + type: boolean + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/bulk-product-source-transfer + "/V1/inventory/bulk-product-source-unassign": + post: + tags: + - inventory/bulk-product-source-unassign + description: Run mass product to source un-assignment + operationId: PostV1InventoryBulkproductsourceunassign + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1InventoryBulkproductsourceunassignBody + in: body + schema: + required: + - skus + - sourceCodes + properties: + skus: + type: array + items: + type: string + sourceCodes: + type: array + items: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/bulk-product-source-unassign + "/V1/inventory/dump-stock-index-data/{salesChannelType}/{salesChannelCode}": + get: + tags: + - inventory/dump-stock-index-data/{salesChannelType}/{salesChannelCode} + description: Provides stock index export from inventory_stock_% table + operationId: GetV1InventoryDumpstockindexdataSalesChannelTypeSalesChannelCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: salesChannelType + in: path + type: string + required: true + - name: salesChannelCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/inventory-export-stock-api-data-product-stock-index-data-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/dump-stock-index-data/{salesChannelType}/{salesChannelCode} + "/V1/inventory/export-stock-salable-qty/{salesChannelType}/{salesChannelCode}": + get: + tags: + - inventory/export-stock-salable-qty/{salesChannelType}/{salesChannelCode} + description: Export product stock data filtered by search criteria. + operationId: GetV1InventoryExportstocksalableqtySalesChannelTypeSalesChannelCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: salesChannelType + in: path + type: string + required: true + - name: salesChannelCode + in: path + type: string + required: true + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/inventory-export-stock-api-data-export-stock-salable-qty-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/export-stock-salable-qty/{salesChannelType}/{salesChannelCode} + "/V1/inventory/get-distance": + get: + tags: + - inventory/get-distance + description: Get distance between two points + operationId: GetV1InventoryGetdistance + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: source[lat] + in: query + type: number + description: Latitude + - name: source[lng] + in: query + type: number + description: Longitude + - name: destination[lat] + in: query + type: number + description: Latitude + - name: destination[lng] + in: query + type: number + description: Longitude + responses: + '200': + description: 200 Success. + schema: + type: number + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/get-distance + "/V1/inventory/get-distance-provider-code": + get: + tags: + - inventory/get-distance-provider-code + description: Get Default distance provider code + operationId: GetV1InventoryGetdistanceprovidercode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: string + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/get-distance-provider-code + "/V1/inventory/get-latlng-from-address": + get: + tags: + - inventory/get-latlng-from-address + description: Get latitude and longitude object from address + operationId: GetV1InventoryGetlatlngfromaddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: address[country] + in: query + type: string + description: Shipping country + - name: address[postcode] + in: query + type: string + description: Shipping postcode + - name: address[street] + in: query + type: string + description: Shipping street address + - name: address[region] + in: query + type: string + description: Shipping region + - name: address[city] + in: query + type: string + description: Shipping city + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/inventory-distance-based-source-selection-api-data-lat-lng-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/get-latlng-from-address + "/V1/inventory/get-latslngs-from-address": + get: + tags: + - inventory/get-latslngs-from-address + description: Get all available latitude and longitude objects from address. + operationId: GetV1InventoryGetlatslngsfromaddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: address[country] + in: query + type: string + description: Shipping country + - name: address[postcode] + in: query + type: string + description: Shipping postcode + - name: address[street] + in: query + type: string + description: Shipping street address + - name: address[region] + in: query + type: string + description: Shipping region + - name: address[city] + in: query + type: string + description: Shipping city + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/inventory-distance-based-source-selection-api-data-lat-lng-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/get-latslngs-from-address + "/V1/inventory/get-product-salable-quantity/{sku}/{stockId}": + get: + tags: + - inventory/get-product-salable-quantity/{sku}/{stockId} + description: Get Product Quantity for given SKU and Stock + operationId: GetV1InventoryGetproductsalablequantitySkuStockId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: stockId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: number + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/get-product-salable-quantity/{sku}/{stockId} + "/V1/inventory/get-sources-assigned-to-stock-ordered-by-priority/{stockId}": + get: + tags: + - inventory/get-sources-assigned-to-stock-ordered-by-priority/{stockId} + description: Get Sources assigned to Stock ordered by priority If Stock with + given id doesn't exist then return an empty array + operationId: GetV1InventoryGetsourcesassignedtostockorderedbypriorityStockId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: stockId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/inventory-api-data-source-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/get-sources-assigned-to-stock-ordered-by-priority/{stockId} + "/V1/inventory/in-store-pickup/pickup-locations/": + get: + tags: + - inventory/in-store-pickup/pickup-locations/ + description: Get Pickup Locations according to the results of filtration by + Search Request. + operationId: GetV1InventoryInstorepickupPickuplocations + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchRequest[area][radius] + in: query + type: integer + description: Search radius in KM. + - name: searchRequest[area][searchTerm] + in: query + type: string + description: Search term string. + - name: searchRequest[filters][country][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][country][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][postcode][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][postcode][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][region][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][region][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][regionId][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][regionId][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][city][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][city][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][street][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][street][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][name][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][name][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][pickupLocationCode][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][pickupLocationCode][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[pageSize] + in: query + type: integer + description: Page size. + - name: searchRequest[currentPage] + in: query + type: integer + description: Current page. + - name: searchRequest[scopeType] + in: query + type: string + description: Sales Channel Type. + - name: searchRequest[scopeCode] + in: query + type: string + description: Sales Channel code. + - name: searchRequest[sort][0][field] + in: query + type: string + description: Sorting field. + - name: searchRequest[sort][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchRequest[extensionAttributes][productsInfo][0][sku] + in: query + type: string + description: Product SKU. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-result-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/in-store-pickup/pickup-locations/ + post: + tags: + - inventory/in-store-pickup/pickup-locations/ + description: Get Pickup Locations according to the results of filtration by + Search Request. + operationId: PostV1InventoryInstorepickupPickuplocations + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1InventoryInstorepickupPickuplocationsBody + in: body + schema: + required: + - searchRequest + properties: + searchRequest: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-result-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/in-store-pickup/pickup-locations/ + "/V1/inventory/is-product-salable-for-requested-qty/{sku}/{stockId}/{requestedQty}": + get: + tags: + - inventory/is-product-salable-for-requested-qty/{sku}/{stockId}/{requestedQty} + description: Get is product salable for given SKU in a given Stock for a certain + Qty + operationId: GetV1InventoryIsproductsalableforrequestedqtySkuStockIdRequestedQty + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: stockId + in: path + type: integer + required: true + - name: requestedQty + in: path + type: number + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/inventory-sales-api-data-product-salable-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/is-product-salable-for-requested-qty/{sku}/{stockId}/{requestedQty} + "/V1/inventory/is-product-salable/{sku}/{stockId}": + get: + tags: + - inventory/is-product-salable/{sku}/{stockId} + description: Get is product in salable for given SKU in a given Stock + operationId: GetV1InventoryIsproductsalableSkuStockId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: stockId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/is-product-salable/{sku}/{stockId} + "/V1/inventory/low-quantity-notification": + post: + tags: + - inventory/low-quantity-notification + description: Save an array of SourceItemConfigurationInterface objects passed + as parameter. + operationId: PostV1InventoryLowquantitynotification + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1InventoryLowquantitynotificationBody + in: body + schema: + required: + - sourceItemConfigurations + properties: + sourceItemConfigurations: + type: array + items: + "$ref": "#/definitions/inventory-low-quantity-notification-api-data-source-item-configuration-interface" + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/low-quantity-notification + "/V1/inventory/low-quantity-notification/{sourceCode}/{sku}": + get: + tags: + - inventory/low-quantity-notification/{sourceCode}/{sku} + description: Get the source item configuration + operationId: GetV1InventoryLowquantitynotificationSourceCodeSku + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sourceCode + in: path + type: string + required: true + - name: sku + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/inventory-low-quantity-notification-api-data-source-item-configuration-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/low-quantity-notification/{sourceCode}/{sku} + "/V1/inventory/low-quantity-notifications-delete": + post: + tags: + - inventory/low-quantity-notifications-delete + description: Delete multiple source items configuration for low quantity + operationId: PostV1InventoryLowquantitynotificationsdelete + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1InventoryLowquantitynotificationsdeleteBody + in: body + schema: + required: + - sourceItems + properties: + sourceItems: + type: array + items: + "$ref": "#/definitions/inventory-api-data-source-item-interface" + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/low-quantity-notifications-delete + "/V1/inventory/source-items": + get: + tags: + - inventory/source-items + description: Find SourceItems by SearchCriteria We need to have this method + for direct work with SourceItems because this object contains additional data + like as qty, status (for example can be searchable by additional field) + operationId: GetV1InventorySourceitems + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/inventory-api-data-source-item-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/source-items + post: + tags: + - inventory/source-items + description: Save Multiple Source item data + operationId: PostV1InventorySourceitems + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1InventorySourceitemsBody + in: body + schema: + required: + - sourceItems + properties: + sourceItems: + type: array + items: + "$ref": "#/definitions/inventory-api-data-source-item-interface" + type: object + xml: + name: request + responses: + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/source-items + "/V1/inventory/source-items-delete": + post: + tags: + - inventory/source-items-delete + description: Delete Multiple Source item data + operationId: PostV1InventorySourceitemsdelete + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1InventorySourceitemsdeleteBody + in: body + schema: + required: + - sourceItems + properties: + sourceItems: + type: array + items: + "$ref": "#/definitions/inventory-api-data-source-item-interface" + type: object + xml: + name: request + responses: + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/source-items-delete + "/V1/inventory/source-selection-algorithm-list": + get: + tags: + - inventory/source-selection-algorithm-list + description: Returns a list of registered Source Selection Algorithm (SSA) data + interfaces available in the system. + operationId: GetV1InventorySourceselectionalgorithmlist + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/inventory-source-selection-api-data-source-selection-algorithm-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/source-selection-algorithm-list + "/V1/inventory/source-selection-algorithm-result": + post: + tags: + - inventory/source-selection-algorithm-result + description: Executes the source selection service using the provided inventory + request and algorithm code. + operationId: PostV1InventorySourceselectionalgorithmresult + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1InventorySourceselectionalgorithmresultBody + in: body + schema: + required: + - inventoryRequest + - algorithmCode + properties: + inventoryRequest: + "$ref": "#/definitions/inventory-source-selection-api-data-inventory-request-interface" + algorithmCode: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/inventory-source-selection-api-data-source-selection-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/source-selection-algorithm-result + "/V1/inventory/sources": + get: + tags: + - inventory/sources + description: Find Sources by SearchCriteria SearchCriteria is not required because + load all stocks is useful case + operationId: GetV1InventorySources + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/inventory-api-data-source-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/sources + post: + tags: + - inventory/sources + description: Save Source data + operationId: PostV1InventorySources + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1InventorySourcesBody + in: body + schema: + required: + - source + properties: + source: + "$ref": "#/definitions/inventory-api-data-source-interface" + type: object + xml: + name: request + responses: + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/sources + "/V1/inventory/sources/{sourceCode}": + get: + tags: + - inventory/sources/{sourceCode} + description: Get Source data by given code. If you want to create plugin on + get method, also you need to create separate Plugin on getList method, because + entity loading way is different for these methods + operationId: GetV1InventorySourcesSourceCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sourceCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/inventory-api-data-source-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/sources/{sourceCode} + put: + tags: + - inventory/sources/{sourceCode} + description: Save Source data + operationId: PutV1InventorySourcesSourceCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sourceCode + in: path + type: string + required: true + - name: PutV1InventorySourcesSourceCodeBody + in: body + schema: + required: + - source + properties: + source: + "$ref": "#/definitions/inventory-api-data-source-interface" + type: object + xml: + name: request + responses: + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/sources/{sourceCode} + "/V1/inventory/stock-resolver/{type}/{code}": + get: + tags: + - inventory/stock-resolver/{type}/{code} + description: Resolve Stock by Sales Channel type and code + operationId: GetV1InventoryStockresolverTypeCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: type + in: path + type: string + required: true + - name: code + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/inventory-api-data-stock-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/stock-resolver/{type}/{code} + "/V1/inventory/stock-source-links": + get: + tags: + - inventory/stock-source-links + description: Find StockSourceLink list by given SearchCriteria + operationId: GetV1InventoryStocksourcelinks + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/inventory-api-data-stock-source-link-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/stock-source-links + post: + tags: + - inventory/stock-source-links + description: Save StockSourceLink list data + operationId: PostV1InventoryStocksourcelinks + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1InventoryStocksourcelinksBody + in: body + schema: + required: + - links + properties: + links: + type: array + items: + "$ref": "#/definitions/inventory-api-data-stock-source-link-interface" + type: object + xml: + name: request + responses: + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/stock-source-links + "/V1/inventory/stock-source-links-delete": + post: + tags: + - inventory/stock-source-links-delete + description: Remove StockSourceLink list list + operationId: PostV1InventoryStocksourcelinksdelete + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1InventoryStocksourcelinksdeleteBody + in: body + schema: + required: + - links + properties: + links: + type: array + items: + "$ref": "#/definitions/inventory-api-data-stock-source-link-interface" + type: object + xml: + name: request + responses: + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/stock-source-links-delete + "/V1/inventory/stocks": + get: + tags: + - inventory/stocks + description: Find Stocks by given SearchCriteria SearchCriteria is not required + because load all stocks is useful case + operationId: GetV1InventoryStocks + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/inventory-api-data-stock-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/stocks + post: + tags: + - inventory/stocks + description: Save Stock data + operationId: PostV1InventoryStocks + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1InventoryStocksBody + in: body + schema: + required: + - stock + properties: + stock: + "$ref": "#/definitions/inventory-api-data-stock-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/stocks + "/V1/inventory/stocks/{stockId}": + get: + tags: + - inventory/stocks/{stockId} + description: Get Stock data by given stockId. If you want to create plugin on + get method, also you need to create separate Plugin on getList method, because + entity loading way is different for these methods + operationId: GetV1InventoryStocksStockId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: stockId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/inventory-api-data-stock-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/stocks/{stockId} + delete: + tags: + - inventory/stocks/{stockId} + description: Delete the Stock data by stockId. If stock is not found do nothing + operationId: DeleteV1InventoryStocksStockId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: stockId + in: path + type: integer + required: true + responses: + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/stocks/{stockId} + put: + tags: + - inventory/stocks/{stockId} + description: Save Stock data + operationId: PutV1InventoryStocksStockId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: stockId + in: path + type: string + required: true + - name: PutV1InventoryStocksStockIdBody + in: body + schema: + required: + - stock + properties: + stock: + "$ref": "#/definitions/inventory-api-data-stock-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/stocks/{stockId} + "/V1/invoice/{invoiceId}/refund": + post: + tags: + - invoice/{invoiceId}/refund + description: Create refund for invoice + operationId: PostV1InvoiceInvoiceIdRefund + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: invoiceId + in: path + type: integer + required: true + - name: PostV1InvoiceInvoiceIdRefundBody + in: body + schema: + properties: + items: + type: array + items: + "$ref": "#/definitions/sales-data-creditmemo-item-creation-interface" + isOnline: + type: boolean + notify: + type: boolean + appendComment: + type: boolean + comment: + "$ref": "#/definitions/sales-data-creditmemo-comment-creation-interface" + arguments: + "$ref": "#/definitions/sales-data-creditmemo-creation-arguments-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: invoice/{invoiceId}/refund + "/V1/invoices": + get: + tags: + - invoices + description: Lists invoices that match specified search criteria. This call + returns an array of objects, but detailed information about each object’s + attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#InvoiceRepositoryInterface + to determine which call to use to get detailed information about all attributes + for an object. + operationId: GetV1Invoices + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-invoice-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: invoices + "/V1/invoices/": + post: + tags: + - invoices/ + description: Performs persist operations for a specified invoice. + operationId: PostV1Invoices + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1InvoicesBody + in: body + schema: + required: + - entity + properties: + entity: + "$ref": "#/definitions/sales-data-invoice-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-invoice-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: invoices/ + "/V1/invoices/comments": + post: + tags: + - invoices/comments + description: Performs persist operations for a specified invoice comment. + operationId: PostV1InvoicesComments + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1InvoicesCommentsBody + in: body + schema: + required: + - entity + properties: + entity: + "$ref": "#/definitions/sales-data-invoice-comment-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-invoice-comment-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: invoices/comments + "/V1/invoices/{id}": + get: + tags: + - invoices/{id} + description: Loads a specified invoice. + operationId: GetV1InvoicesId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The invoice ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-invoice-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: invoices/{id} + "/V1/invoices/{id}/capture": + post: + tags: + - invoices/{id}/capture + description: Sets invoice capture. + operationId: PostV1InvoicesIdCapture + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: string + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: invoices/{id}/capture + "/V1/invoices/{id}/comments": + get: + tags: + - invoices/{id}/comments + description: Lists comments for a specified invoice. + operationId: GetV1InvoicesIdComments + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The invoice ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-invoice-comment-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: invoices/{id}/comments + "/V1/invoices/{id}/emails": + post: + tags: + - invoices/{id}/emails + description: Emails a user a specified invoice. + operationId: PostV1InvoicesIdEmails + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The invoice ID. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: invoices/{id}/emails + "/V1/invoices/{id}/void": + post: + tags: + - invoices/{id}/void + description: Voids a specified invoice. + operationId: PostV1InvoicesIdVoid + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The invoice ID. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: invoices/{id}/void + "/V1/modules": + get: + tags: + - modules + description: Returns an array of enabled modules + operationId: GetV1Modules + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + type: string + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: modules + "/V1/negotiable-cart-item-note": + post: + tags: + - negotiable-cart-item-note + description: Set the note for an item in negotiable quote. + operationId: PostV1Negotiablecartitemnote + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiablecartitemnoteBody + in: body + schema: + required: + - itemNote + properties: + itemNote: + "$ref": "#/definitions/negotiable-quote-data-item-note-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-cart-item-note + "/V1/negotiable-cart-item-note/search": + get: + tags: + - negotiable-cart-item-note/search + description: Get list of item notes + operationId: GetV1NegotiablecartitemnoteSearch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/negotiable-quote-data-item-note-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-cart-item-note/search + "/V1/negotiable-cart-item-note/{noteId}": + get: + tags: + - negotiable-cart-item-note/{noteId} + description: Get item note by ID + operationId: GetV1NegotiablecartitemnoteNoteId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: noteId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/negotiable-quote-data-item-note-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-cart-item-note/{noteId} + delete: + tags: + - negotiable-cart-item-note/{noteId} + description: Delete item note by ID. + operationId: DeleteV1NegotiablecartitemnoteNoteId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: noteId + in: path + type: integer + required: true + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-cart-item-note/{noteId} + "/V1/negotiable-carts/{cartId}/billing-address": + get: + tags: + - negotiable-carts/{cartId}/billing-address + description: Returns the billing address for a specified quote. + operationId: GetV1NegotiablecartsCartIdBillingaddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-address-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/billing-address + post: + tags: + - negotiable-carts/{cartId}/billing-address + description: Assigns a specified billing address to a specified cart. + operationId: PostV1NegotiablecartsCartIdBillingaddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + - name: PostV1NegotiablecartsCartIdBillingaddressBody + in: body + schema: + required: + - address + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + useForShipping: + type: boolean + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Address ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/billing-address + "/V1/negotiable-carts/{cartId}/coupons": + delete: + tags: + - negotiable-carts/{cartId}/coupons + description: Deletes a coupon from a specified cart. + operationId: DeleteV1NegotiablecartsCartIdCoupons + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/coupons + "/V1/negotiable-carts/{cartId}/coupons/{couponCode}": + put: + tags: + - negotiable-carts/{cartId}/coupons/{couponCode} + description: Adds a coupon by code to a specified cart. + operationId: PutV1NegotiablecartsCartIdCouponsCouponCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + - name: couponCode + in: path + type: string + required: true + description: The coupon code data. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/coupons/{couponCode} + "/V1/negotiable-carts/{cartId}/estimate-shipping-methods": + post: + tags: + - negotiable-carts/{cartId}/estimate-shipping-methods + description: Estimate shipping by address and return list of available shipping + methods + operationId: PostV1NegotiablecartsCartIdEstimateshippingmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1NegotiablecartsCartIdEstimateshippingmethodsBody + in: body + schema: + required: + - address + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/estimate-shipping-methods + "/V1/negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id": + post: + tags: + - negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id + description: Estimate shipping + operationId: PostV1NegotiablecartsCartIdEstimateshippingmethodsbyaddressid + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The shopping cart ID. + - name: PostV1NegotiablecartsCartIdEstimateshippingmethodsbyaddressidBody + in: body + schema: + required: + - addressId + properties: + addressId: + type: integer + description: The estimate address id + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods. + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id + "/V1/negotiable-carts/{cartId}/giftCards": + post: + tags: + - negotiable-carts/{cartId}/giftCards + description: '' + operationId: PostV1NegotiablecartsCartIdGiftCards + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: PostV1NegotiablecartsCartIdGiftCardsBody + in: body + schema: + required: + - giftCardAccountData + properties: + giftCardAccountData: + "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/giftCards + "/V1/negotiable-carts/{cartId}/giftCards/{giftCardCode}": + delete: + tags: + - negotiable-carts/{cartId}/giftCards/{giftCardCode} + description: Remove GiftCard Account entity + operationId: DeleteV1NegotiablecartsCartIdGiftCardsGiftCardCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: giftCardCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/giftCards/{giftCardCode} + "/V1/negotiable-carts/{cartId}/payment-information": + post: + tags: + - negotiable-carts/{cartId}/payment-information + description: Set payment information and place order for a specified cart. + operationId: PostV1NegotiablecartsCartIdPaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1NegotiablecartsCartIdPaymentinformationBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/payment-information + get: + tags: + - negotiable-carts/{cartId}/payment-information + description: Get payment information + operationId: GetV1NegotiablecartsCartIdPaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/checkout-data-payment-details-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/payment-information + "/V1/negotiable-carts/{cartId}/po-payment-information": + post: + tags: + - negotiable-carts/{cartId}/po-payment-information + description: Set payment information and place purchase order for a specified + negotiable quote. + operationId: PostV1NegotiablecartsCartIdPopaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: PostV1NegotiablecartsCartIdPopaymentinformationBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Purchase Order ID. + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/po-payment-information + "/V1/negotiable-carts/{cartId}/set-payment-information": + post: + tags: + - negotiable-carts/{cartId}/set-payment-information + description: Set payment information for a specified cart. + operationId: PostV1NegotiablecartsCartIdSetpaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: PostV1NegotiablecartsCartIdSetpaymentinformationBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/set-payment-information + "/V1/negotiable-carts/{cartId}/shipping-information": + post: + tags: + - negotiable-carts/{cartId}/shipping-information + description: '' + operationId: PostV1NegotiablecartsCartIdShippinginformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: PostV1NegotiablecartsCartIdShippinginformationBody + in: body + schema: + required: + - addressInformation + properties: + addressInformation: + "$ref": "#/definitions/checkout-data-shipping-information-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/checkout-data-payment-details-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/shipping-information + "/V1/negotiable-carts/{cartId}/totals": + get: + tags: + - negotiable-carts/{cartId}/totals + description: Returns quote totals data for a specified cart. + operationId: GetV1NegotiablecartsCartIdTotals + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-totals-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/totals + "/V1/negotiableQuote/attachmentContent": + get: + tags: + - negotiableQuote/attachmentContent + description: Returns content for one or more files attached on the quote comment. + operationId: GetV1NegotiableQuoteAttachmentContent + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attachmentIds + in: query + type: array + items: + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuote/attachmentContent + "/V1/negotiableQuote/decline": + post: + tags: + - negotiableQuote/decline + description: Decline the B2B quote. All custom pricing will be removed from + this quote. The buyer will be able to place an order using their standard + catalog prices and discounts. + operationId: PostV1NegotiableQuoteDecline + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiableQuoteDeclineBody + in: body + schema: + required: + - quoteId + - reason + properties: + quoteId: + type: integer + reason: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuote/decline + "/V1/negotiableQuote/draft": + post: + tags: + - negotiableQuote/draft + description: Create a new empty B2B quote with NegotiableQuoteInterface::STATUS_DRAFT_BY_ADMIN + status. + operationId: PostV1NegotiableQuoteDraft + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiableQuoteDraftBody + in: body + schema: + required: + - customerId + properties: + customerId: + type: integer + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Quote Id + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuote/draft + "/V1/negotiableQuote/pricesUpdated": + post: + tags: + - negotiableQuote/pricesUpdated + description: Refreshes item prices, taxes, discounts, cart rules in the negotiable + quote as per the latest changes in the catalog / shared catalog and in the + price rules. Depending on the negotiable quote state and totals, all or just + some of quote numbers will be recalculated. 'Update Prices' parameter forces + refresh on any quote that is not locked for admin user, including the quotes + with a negotiated price. The request can be applied to one or more quotes + at the same time. + operationId: PostV1NegotiableQuotePricesUpdated + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiableQuotePricesUpdatedBody + in: body + schema: + required: + - quoteIds + properties: + quoteIds: + type: array + items: + type: integer + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuote/pricesUpdated + "/V1/negotiableQuote/request": + post: + tags: + - negotiableQuote/request + description: Create a B2B quote based on a regular Magento quote. If the B2B + quote requires a shipping address (for negotiation or tax calculations), add + it to the regular quote before you create a B2B quote. + operationId: PostV1NegotiableQuoteRequest + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiableQuoteRequestBody + in: body + schema: + required: + - quoteId + - quoteName + properties: + quoteId: + type: integer + quoteName: + type: string + comment: + type: string + files: + type: array + items: + "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuote/request + "/V1/negotiableQuote/submitToCustomer": + post: + tags: + - negotiableQuote/submitToCustomer + description: Submit the B2B quote to the customer. The quote status for the + customer will be changed to 'Updated', and the customer can work with the + quote. + operationId: PostV1NegotiableQuoteSubmitToCustomer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiableQuoteSubmitToCustomerBody + in: body + schema: + required: + - quoteId + properties: + quoteId: + type: integer + comment: + type: string + files: + type: array + items: + "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuote/submitToCustomer + "/V1/negotiableQuote/{negotiableQuoteId}/duplicate": + post: + tags: + - negotiableQuote/{negotiableQuoteId}/duplicate + description: Duplicate Negotiable Quote based on the ID of existing negotiable + quote. Returns ID of a duplicated quote. + operationId: PostV1NegotiableQuoteNegotiableQuoteIdDuplicate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: negotiableQuoteId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: integer + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuote/{negotiableQuoteId}/duplicate + "/V1/negotiableQuote/{quoteId}": + put: + tags: + - negotiableQuote/{quoteId} + description: Save quote + operationId: PutV1NegotiableQuoteQuoteId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: quoteId + in: path + type: string + required: true + - name: PutV1NegotiableQuoteQuoteIdBody + in: body + schema: + required: + - quote + properties: + quote: + "$ref": "#/definitions/quote-data-cart-interface" + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuote/{quoteId} + "/V1/negotiableQuote/{quoteId}/comments": + get: + tags: + - negotiableQuote/{quoteId}/comments + description: Returns comments for a specified negotiable quote. + operationId: GetV1NegotiableQuoteQuoteIdComments + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: quoteId + in: path + type: integer + required: true + description: Negotiable Quote ID. + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of quote comments. + items: + "$ref": "#/definitions/negotiable-quote-data-comment-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuote/{quoteId}/comments + "/V1/negotiableQuote/{quoteId}/shippingMethod": + put: + tags: + - negotiableQuote/{quoteId}/shippingMethod + description: Updates the shipping method on a negotiable quote. + operationId: PutV1NegotiableQuoteQuoteIdShippingMethod + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: quoteId + in: path + type: integer + required: true + description: Negotiable Quote id + - name: PutV1NegotiableQuoteQuoteIdShippingMethodBody + in: body + schema: + required: + - shippingMethod + properties: + shippingMethod: + type: string + description: The shipping method code. + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuote/{quoteId}/shippingMethod + "/V1/negotiableQuoteTemplate": + get: + tags: + - negotiableQuoteTemplate + description: Get list of quote templates + operationId: GetV1NegotiableQuoteTemplate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/framework-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate + put: + tags: + - negotiableQuoteTemplate + description: Edit a quote template. + operationId: PutV1NegotiableQuoteTemplate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1NegotiableQuoteTemplateBody + in: body + schema: + required: + - template + properties: + template: + "$ref": "#/definitions/negotiable-quote-template-data-template-interface" + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate + "/V1/negotiableQuoteTemplate/accept": + post: + tags: + - negotiableQuoteTemplate/accept + description: Create quote template from quote + operationId: PostV1NegotiableQuoteTemplateAccept + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiableQuoteTemplateAcceptBody + in: body + schema: + required: + - templateId + properties: + templateId: + type: integer + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/accept + "/V1/negotiableQuoteTemplate/cancel": + post: + tags: + - negotiableQuoteTemplate/cancel + description: Cancel a quote template. + operationId: PostV1NegotiableQuoteTemplateCancel + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiableQuoteTemplateCancelBody + in: body + schema: + required: + - templateId + properties: + templateId: + type: integer + comment: + type: string + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/cancel + "/V1/negotiableQuoteTemplate/cancel/me": + post: + tags: + - negotiableQuoteTemplate/cancel/me + description: Cancel a quote template. + operationId: PostV1NegotiableQuoteTemplateCancelMe + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiableQuoteTemplateCancelMeBody + in: body + schema: + required: + - templateId + properties: + templateId: + type: integer + comment: + type: string + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/cancel/me + "/V1/negotiableQuoteTemplate/decline": + post: + tags: + - negotiableQuoteTemplate/decline + description: Decline a quote template. + operationId: PostV1NegotiableQuoteTemplateDecline + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiableQuoteTemplateDeclineBody + in: body + schema: + required: + - templateId + - reason + properties: + templateId: + type: integer + reason: + type: string + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/decline + "/V1/negotiableQuoteTemplate/draft": + post: + tags: + - negotiableQuoteTemplate/draft + description: Create a new empty B2B quote template with NegotiableQuoteInterface::STATUS_DRAFT_BY_ADMIN + status. + operationId: PostV1NegotiableQuoteTemplateDraft + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiableQuoteTemplateDraftBody + in: body + schema: + required: + - customerId + properties: + customerId: + type: integer + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/negotiable-quote-template-data-template-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/draft + "/V1/negotiableQuoteTemplate/generateQuote": + post: + tags: + - negotiableQuoteTemplate/generateQuote + description: Generate quote from template + operationId: PostV1NegotiableQuoteTemplateGenerateQuote + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiableQuoteTemplateGenerateQuoteBody + in: body + schema: + required: + - templateId + properties: + templateId: + type: integer + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/generateQuote + "/V1/negotiableQuoteTemplate/me": + put: + tags: + - negotiableQuoteTemplate/me + description: Edit a quote template. + operationId: PutV1NegotiableQuoteTemplateMe + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1NegotiableQuoteTemplateMeBody + in: body + schema: + required: + - template + properties: + template: + "$ref": "#/definitions/negotiable-quote-template-data-template-interface" + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/me + "/V1/negotiableQuoteTemplate/me/{templateId}": + delete: + tags: + - negotiableQuoteTemplate/me/{templateId} + description: Delete a quote template. + operationId: DeleteV1NegotiableQuoteTemplateMeTemplateId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: templateId + in: path + type: integer + required: true + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/me/{templateId} + "/V1/negotiableQuoteTemplate/open": + post: + tags: + - negotiableQuoteTemplate/open + description: Open template + operationId: PostV1NegotiableQuoteTemplateOpen + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiableQuoteTemplateOpenBody + in: body + schema: + required: + - templateId + properties: + templateId: + type: integer + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/open + "/V1/negotiableQuoteTemplate/open/me": + post: + tags: + - negotiableQuoteTemplate/open/me + description: Open template + operationId: PostV1NegotiableQuoteTemplateOpenMe + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiableQuoteTemplateOpenMeBody + in: body + schema: + required: + - templateId + properties: + templateId: + type: integer + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/open/me + "/V1/negotiableQuoteTemplate/referenceDocumentLink": + get: + tags: + - negotiableQuoteTemplate/referenceDocumentLink + description: Get list of reference document links + operationId: GetV1NegotiableQuoteTemplateReferenceDocumentLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/framework-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/referenceDocumentLink + put: + tags: + - negotiableQuoteTemplate/referenceDocumentLink + description: Save reference document link + operationId: PutV1NegotiableQuoteTemplateReferenceDocumentLink + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1NegotiableQuoteTemplateReferenceDocumentLinkBody + in: body + schema: + required: + - referenceDocumentLink + properties: + referenceDocumentLink: + "$ref": "#/definitions/negotiable-quote-template-data-reference-document-link-interface" + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/referenceDocumentLink + "/V1/negotiableQuoteTemplate/referenceDocumentLink/{linkId}": + get: + tags: + - negotiableQuoteTemplate/referenceDocumentLink/{linkId} + description: Get reference document link by id + operationId: GetV1NegotiableQuoteTemplateReferenceDocumentLinkLinkId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: linkId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/negotiable-quote-template-data-reference-document-link-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/referenceDocumentLink/{linkId} + delete: + tags: + - negotiableQuoteTemplate/referenceDocumentLink/{linkId} + description: Delete a quote template reference document link + operationId: DeleteV1NegotiableQuoteTemplateReferenceDocumentLinkLinkId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: linkId + in: path + type: integer + required: true + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/referenceDocumentLink/{linkId} + "/V1/negotiableQuoteTemplate/request": + post: + tags: + - negotiableQuoteTemplate/request + description: Create a template for a quote. + operationId: PostV1NegotiableQuoteTemplateRequest + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiableQuoteTemplateRequestBody + in: body + schema: + required: + - quoteId + properties: + quoteId: + type: integer + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/negotiable-quote-template-data-template-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/request + "/V1/negotiableQuoteTemplate/request/me": + post: + tags: + - negotiableQuoteTemplate/request/me + description: Create a template for a quote. + operationId: PostV1NegotiableQuoteTemplateRequestMe + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiableQuoteTemplateRequestMeBody + in: body + schema: + required: + - quoteId + properties: + quoteId: + type: integer + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/negotiable-quote-template-data-template-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/request/me + "/V1/negotiableQuoteTemplate/submitToCustomer": + post: + tags: + - negotiableQuoteTemplate/submitToCustomer + description: Seller send action + operationId: PostV1NegotiableQuoteTemplateSubmitToCustomer + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiableQuoteTemplateSubmitToCustomerBody + in: body + schema: + required: + - templateId + properties: + templateId: + type: integer + commentText: + type: string + files: + type: array + items: + "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface" + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/submitToCustomer + "/V1/negotiableQuoteTemplate/submitToSeller": + post: + tags: + - negotiableQuoteTemplate/submitToSeller + description: Send template to seller + operationId: PostV1NegotiableQuoteTemplateSubmitToSeller + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiableQuoteTemplateSubmitToSellerBody + in: body + schema: + required: + - templateId + properties: + templateId: + type: integer + commentText: + type: string + files: + type: array + items: + "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface" + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/submitToSeller + "/V1/negotiableQuoteTemplate/{templateId}": + get: + tags: + - negotiableQuoteTemplate/{templateId} + description: Return the negotiable quote template for a specified quote ID. + operationId: GetV1NegotiableQuoteTemplateTemplateId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: templateId + in: path + type: integer + required: true + description: template id + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/negotiable-quote-template-data-template-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/{templateId} + delete: + tags: + - negotiableQuoteTemplate/{templateId} + description: Delete a quote template. + operationId: DeleteV1NegotiableQuoteTemplateTemplateId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: templateId + in: path + type: integer + required: true + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/{templateId} + "/V1/order/notify-orders-are-ready-for-pickup": + post: + tags: + - order/notify-orders-are-ready-for-pickup + description: Notify customer that the orders is ready for pickup. + operationId: PostV1OrderNotifyordersarereadyforpickup + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1OrderNotifyordersarereadyforpickupBody + in: body + schema: + required: + - orderIds + properties: + orderIds: + type: array + items: + type: integer + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/inventory-in-store-pickup-sales-api-data-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: order/notify-orders-are-ready-for-pickup + "/V1/order/{orderId}/invoice": + post: + tags: + - order/{orderId}/invoice + description: '' + operationId: PostV1OrderOrderIdInvoice + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: orderId + in: path + type: integer + required: true + - name: PostV1OrderOrderIdInvoiceBody + in: body + schema: + properties: + capture: + type: boolean + items: + type: array + items: + "$ref": "#/definitions/sales-data-invoice-item-creation-interface" + notify: + type: boolean + appendComment: + type: boolean + comment: + "$ref": "#/definitions/sales-data-invoice-comment-creation-interface" + arguments: + "$ref": "#/definitions/sales-data-invoice-creation-arguments-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: order/{orderId}/invoice + "/V1/order/{orderId}/refund": + post: + tags: + - order/{orderId}/refund + description: Create offline refund for order + operationId: PostV1OrderOrderIdRefund + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: orderId + in: path + type: integer + required: true + - name: PostV1OrderOrderIdRefundBody + in: body + schema: + properties: + items: + type: array + items: + "$ref": "#/definitions/sales-data-creditmemo-item-creation-interface" + notify: + type: boolean + appendComment: + type: boolean + comment: + "$ref": "#/definitions/sales-data-creditmemo-comment-creation-interface" + arguments: + "$ref": "#/definitions/sales-data-creditmemo-creation-arguments-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: order/{orderId}/refund + "/V1/order/{orderId}/ship": + post: + tags: + - order/{orderId}/ship + description: Creates new Shipment for given Order. + operationId: PostV1OrderOrderIdShip + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: orderId + in: path + type: integer + required: true + - name: PostV1OrderOrderIdShipBody + in: body + schema: + properties: + items: + type: array + items: + "$ref": "#/definitions/sales-data-shipment-item-creation-interface" + notify: + type: boolean + appendComment: + type: boolean + comment: + "$ref": "#/definitions/sales-data-shipment-comment-creation-interface" + tracks: + type: array + items: + "$ref": "#/definitions/sales-data-shipment-track-creation-interface" + packages: + type: array + items: + "$ref": "#/definitions/sales-data-shipment-package-creation-interface" + arguments: + "$ref": "#/definitions/sales-data-shipment-creation-arguments-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Id of created Shipment. + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: order/{orderId}/ship + "/V1/orders": + get: + tags: + - orders + description: Lists orders that match specified search criteria. This call returns + an array of objects, but detailed information about each object’s attributes + might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#OrderRepositoryInterface + to determine which call to use to get detailed information about all attributes + for an object. + operationId: GetV1Orders + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-order-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: orders + post: + tags: + - orders + description: Performs persist operations for a specified order. + operationId: PostV1Orders + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1OrdersBody + in: body + schema: + required: + - entity + properties: + entity: + "$ref": "#/definitions/sales-data-order-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-order-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: orders + "/V1/orders/create": + put: + tags: + - orders/create + description: Performs persist operations for a specified order. + operationId: PutV1OrdersCreate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1OrdersCreateBody + in: body + schema: + required: + - entity + properties: + entity: + "$ref": "#/definitions/sales-data-order-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-order-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: orders/create + "/V1/orders/items": + get: + tags: + - orders/items + description: Lists order items that match specified search criteria. This call + returns an array of objects, but detailed information about each object’s + attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#OrderItemRepositoryInterface + to determine which call to use to get detailed information about all attributes + for an object. + operationId: GetV1OrdersItems + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-order-item-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: orders/items + "/V1/orders/items/{id}": + get: + tags: + - orders/items/{id} + description: Loads a specified order item. + operationId: GetV1OrdersItemsId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The order item ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-order-item-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: orders/items/{id} + "/V1/orders/{id}": + get: + tags: + - orders/{id} + description: Loads a specified order. + operationId: GetV1OrdersId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The order ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-order-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: orders/{id} + "/V1/orders/{id}/cancel": + post: + tags: + - orders/{id}/cancel + description: Cancels a specified order. + operationId: PostV1OrdersIdCancel + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The order ID. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: orders/{id}/cancel + "/V1/orders/{id}/comments": + post: + tags: + - orders/{id}/comments + description: Adds a comment to a specified order. + operationId: PostV1OrdersIdComments + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The order ID. + - name: PostV1OrdersIdCommentsBody + in: body + schema: + required: + - statusHistory + properties: + statusHistory: + "$ref": "#/definitions/sales-data-order-status-history-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: orders/{id}/comments + get: + tags: + - orders/{id}/comments + description: Lists comments for a specified order. + operationId: GetV1OrdersIdComments + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The order ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-order-status-history-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: orders/{id}/comments + "/V1/orders/{id}/emails": + post: + tags: + - orders/{id}/emails + description: Emails a user a specified order. + operationId: PostV1OrdersIdEmails + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The order ID. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: orders/{id}/emails + "/V1/orders/{id}/hold": + post: + tags: + - orders/{id}/hold + description: Holds a specified order. + operationId: PostV1OrdersIdHold + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The order ID. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: orders/{id}/hold + "/V1/orders/{id}/statuses": + get: + tags: + - orders/{id}/statuses + description: Gets the status for a specified order. + operationId: GetV1OrdersIdStatuses + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The order ID. + responses: + '200': + description: 200 Success. + schema: + type: string + description: Order status. + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: orders/{id}/statuses + "/V1/orders/{id}/unhold": + post: + tags: + - orders/{id}/unhold + description: Releases a specified order from hold status. + operationId: PostV1OrdersIdUnhold + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The order ID. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: orders/{id}/unhold + "/V1/orders/{parent_id}": + put: + tags: + - orders/{parent_id} + description: Performs persist operations for a specified order address. + operationId: PutV1OrdersParent_id + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: parent_id + in: path + type: string + required: true + - name: PutV1OrdersParent_idBody + in: body + schema: + required: + - entity + properties: + entity: + "$ref": "#/definitions/sales-data-order-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-order-address-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: orders/{parent_id} + "/V1/payment-order/completeOrder": + post: + tags: + - payment-order/completeOrder + description: Rest API endpoint to place an order + operationId: PostV1PaymentorderCompleteOrder + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1PaymentorderCompleteOrderBody + in: body + schema: + required: + - orderId + properties: + orderId: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payment-order/completeOrder + "/V1/payments-config/apple-pay/{location}": + get: + tags: + - payments-config/apple-pay/{location} + description: Get Apple Pay Config. + operationId: GetV1PaymentsconfigApplepayLocation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + description: sdk location. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-apple-pay-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-config/apple-pay/{location} + "/V1/payments-config/google-pay/{location}": + get: + tags: + - payments-config/google-pay/{location} + description: Get Google Pay Config. + operationId: GetV1PaymentsconfigGooglepayLocation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + description: sdk location. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-config/google-pay/{location} + "/V1/payments-config/hosted-fields/{location}": + get: + tags: + - payments-config/hosted-fields/{location} + description: Get Hosted Fields Config. + operationId: GetV1PaymentsconfigHostedfieldsLocation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + description: sdk location. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-hosted-fields-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-config/hosted-fields/{location} + "/V1/payments-config/smart-buttons/{location}": + get: + tags: + - payments-config/smart-buttons/{location} + description: Get Smart Buttons Config. + operationId: GetV1PaymentsconfigSmartbuttonsLocation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + description: sdk location. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-config/smart-buttons/{location} + "/V1/payments-config/{location}": + get: + tags: + - payments-config/{location} + description: Get Config. + operationId: GetV1PaymentsconfigLocation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + description: sdk location. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-payment-config-response-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-config/{location} + "/V1/payments-sdk/{location}": + get: + tags: + - payments-sdk/{location} + description: Get payment sdk url by location + operationId: GetV1PaymentssdkLocation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/payment-services-paypal-data-payment-sdk-params-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-sdk/{location} + "/V1/payments-sdk/{location}/{methodCode}": + get: + tags: + - payments-sdk/{location}/{methodCode} + description: Get payment sdk url by location and methodCode + operationId: GetV1PaymentssdkLocationMethodCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + - name: methodCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-sdk-params-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-sdk/{location}/{methodCode} + "/V1/paypal/lineItems": + post: + tags: + - paypal/lineItems + description: Rest endpoint to calculate totals and line items + operationId: PostV1PaypalLineItems + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1PaypalLineItemsBody + in: body + schema: + required: + - method + - cartId + properties: + method: + type: string + cartId: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: paypal/lineItems + "/V1/paypal/oneClick": + post: + tags: + - paypal/oneClick + description: Rest endpoint to add product to cart (mainly use for PayPal button + from PDP) + operationId: PostV1PaypalOneClick + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1PaypalOneClickBody + in: body + schema: + required: + - method + - productData + properties: + method: + type: string + productData: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: paypal/oneClick + "/V1/paypal/validatePhoneNumber": + post: + tags: + - paypal/validatePhoneNumber + description: Get & validate phone number and get shipping/billing email address + operationId: PostV1PaypalValidatePhoneNumber + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1PaypalValidatePhoneNumberBody + in: body + schema: + required: + - cartId + properties: + cartId: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: paypal/validatePhoneNumber + "/V1/products": + post: + tags: + - products + description: Create product + operationId: PostV1Products + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ProductsBody + in: body + schema: + required: + - product + properties: + product: + "$ref": "#/definitions/catalog-data-product-interface" + saveOptions: + type: boolean + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-product-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products + get: + tags: + - products + description: Get product list + operationId: GetV1Products + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-product-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products + "/V1/products-render-info": + get: + tags: + - products-render-info + description: Collect and retrieve the list of product render info. This info + contains raw prices and formatted prices, product name, stock status, store_id, + etc. + operationId: GetV1Productsrenderinfo + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + - name: storeId + in: query + type: integer + required: true + - name: currencyCode + in: query + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-product-render-search-results-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products-render-info + "/V1/products/attribute-sets": + post: + tags: + - products/attribute-sets + description: Create attribute set from data + operationId: PostV1ProductsAttributesets + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ProductsAttributesetsBody + in: body + schema: + required: + - attributeSet + - skeletonId + properties: + attributeSet: + "$ref": "#/definitions/eav-data-attribute-set-interface" + skeletonId: + type: integer + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/eav-data-attribute-set-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attribute-sets + "/V1/products/attribute-sets/attributes": + post: + tags: + - products/attribute-sets/attributes + description: Assign attribute to attribute set + operationId: PostV1ProductsAttributesetsAttributes + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ProductsAttributesetsAttributesBody + in: body + schema: + required: + - attributeSetId + - attributeGroupId + - attributeCode + - sortOrder + properties: + attributeSetId: + type: integer + attributeGroupId: + type: integer + attributeCode: + type: string + sortOrder: + type: integer + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attribute-sets/attributes + "/V1/products/attribute-sets/groups": + post: + tags: + - products/attribute-sets/groups + description: Save attribute group + operationId: PostV1ProductsAttributesetsGroups + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ProductsAttributesetsGroupsBody + in: body + schema: + required: + - group + properties: + group: + "$ref": "#/definitions/eav-data-attribute-group-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/eav-data-attribute-group-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attribute-sets/groups + "/V1/products/attribute-sets/groups/list": + get: + tags: + - products/attribute-sets/groups/list + description: Retrieve list of attribute groups + operationId: GetV1ProductsAttributesetsGroupsList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/eav-data-attribute-group-search-results-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attribute-sets/groups/list + "/V1/products/attribute-sets/groups/{groupId}": + delete: + tags: + - products/attribute-sets/groups/{groupId} + description: Remove attribute group by id + operationId: DeleteV1ProductsAttributesetsGroupsGroupId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: groupId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attribute-sets/groups/{groupId} + "/V1/products/attribute-sets/sets/list": + get: + tags: + - products/attribute-sets/sets/list + description: Retrieve list of Attribute Sets + operationId: GetV1ProductsAttributesetsSetsList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/eav-data-attribute-set-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attribute-sets/sets/list + "/V1/products/attribute-sets/{attributeSetId}": + get: + tags: + - products/attribute-sets/{attributeSetId} + description: Retrieve attribute set information based on given ID + operationId: GetV1ProductsAttributesetsAttributeSetId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeSetId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/eav-data-attribute-set-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attribute-sets/{attributeSetId} + delete: + tags: + - products/attribute-sets/{attributeSetId} + description: Remove attribute set by given ID + operationId: DeleteV1ProductsAttributesetsAttributeSetId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeSetId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attribute-sets/{attributeSetId} + put: + tags: + - products/attribute-sets/{attributeSetId} + description: Save attribute set data + operationId: PutV1ProductsAttributesetsAttributeSetId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeSetId + in: path + type: string + required: true + - name: PutV1ProductsAttributesetsAttributeSetIdBody + in: body + schema: + required: + - attributeSet + properties: + attributeSet: + "$ref": "#/definitions/eav-data-attribute-set-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/eav-data-attribute-set-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attribute-sets/{attributeSetId} + "/V1/products/attribute-sets/{attributeSetId}/attributes": + get: + tags: + - products/attribute-sets/{attributeSetId}/attributes + description: Retrieve related attributes based on given attribute set ID + operationId: GetV1ProductsAttributesetsAttributeSetIdAttributes + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeSetId + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-product-attribute-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attribute-sets/{attributeSetId}/attributes + "/V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}": + delete: + tags: + - products/attribute-sets/{attributeSetId}/attributes/{attributeCode} + description: Remove attribute from attribute set + operationId: DeleteV1ProductsAttributesetsAttributeSetIdAttributesAttributeCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeSetId + in: path + type: string + required: true + - name: attributeCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attribute-sets/{attributeSetId}/attributes/{attributeCode} + "/V1/products/attribute-sets/{attributeSetId}/groups": + put: + tags: + - products/attribute-sets/{attributeSetId}/groups + description: Save attribute group + operationId: PutV1ProductsAttributesetsAttributeSetIdGroups + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeSetId + in: path + type: string + required: true + - name: PutV1ProductsAttributesetsAttributeSetIdGroupsBody + in: body + schema: + required: + - group + properties: + group: + "$ref": "#/definitions/eav-data-attribute-group-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/eav-data-attribute-group-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attribute-sets/{attributeSetId}/groups + "/V1/products/attributes": + get: + tags: + - products/attributes + description: Retrieve all attributes for entity type + operationId: GetV1ProductsAttributes + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-product-attribute-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attributes + post: + tags: + - products/attributes + description: Save attribute data + operationId: PostV1ProductsAttributes + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ProductsAttributesBody + in: body + schema: + required: + - attribute + properties: + attribute: + "$ref": "#/definitions/catalog-data-product-attribute-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-product-attribute-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attributes + "/V1/products/attributes/types": + get: + tags: + - products/attributes/types + description: Retrieve list of product attribute types + operationId: GetV1ProductsAttributesTypes + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-product-attribute-type-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attributes/types + "/V1/products/attributes/{attributeCode}": + get: + tags: + - products/attributes/{attributeCode} + description: Retrieve specific attribute + operationId: GetV1ProductsAttributesAttributeCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-product-attribute-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attributes/{attributeCode} + put: + tags: + - products/attributes/{attributeCode} + description: Save attribute data + operationId: PutV1ProductsAttributesAttributeCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeCode + in: path + type: string + required: true + - name: PutV1ProductsAttributesAttributeCodeBody + in: body + schema: + required: + - attribute + properties: + attribute: + "$ref": "#/definitions/catalog-data-product-attribute-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-product-attribute-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attributes/{attributeCode} + delete: + tags: + - products/attributes/{attributeCode} + description: Delete Attribute by id + operationId: DeleteV1ProductsAttributesAttributeCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attributes/{attributeCode} + "/V1/products/attributes/{attributeCode}/is-filterable": + get: + tags: + - products/attributes/{attributeCode}/is-filterable + description: Retrieve 'is_filterable' property for specific attribute as integer + operationId: GetV1ProductsAttributesAttributeCodeIsfilterable + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: integer + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attributes/{attributeCode}/is-filterable + "/V1/products/attributes/{attributeCode}/is-filterable/{isFilterable}": + put: + tags: + - products/attributes/{attributeCode}/is-filterable/{isFilterable} + description: Set 'is_filterable' property for specific attribute as integer + operationId: PutV1ProductsAttributesAttributeCodeIsfilterableIsFilterable + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeCode + in: path + type: string + required: true + - name: isFilterable + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attributes/{attributeCode}/is-filterable/{isFilterable} + "/V1/products/attributes/{attributeCode}/options": + get: + tags: + - products/attributes/{attributeCode}/options + description: Retrieve list of attribute options + operationId: GetV1ProductsAttributesAttributeCodeOptions + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/eav-data-attribute-option-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attributes/{attributeCode}/options + post: + tags: + - products/attributes/{attributeCode}/options + description: Add option to attribute + operationId: PostV1ProductsAttributesAttributeCodeOptions + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeCode + in: path + type: string + required: true + - name: PostV1ProductsAttributesAttributeCodeOptionsBody + in: body + schema: + required: + - option + properties: + option: + "$ref": "#/definitions/eav-data-attribute-option-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attributes/{attributeCode}/options + "/V1/products/attributes/{attributeCode}/options/{optionId}": + delete: + tags: + - products/attributes/{attributeCode}/options/{optionId} + description: Delete option from attribute + operationId: DeleteV1ProductsAttributesAttributeCodeOptionsOptionId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeCode + in: path + type: string + required: true + - name: optionId + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attributes/{attributeCode}/options/{optionId} + put: + tags: + - products/attributes/{attributeCode}/options/{optionId} + description: Update attribute option + operationId: PutV1ProductsAttributesAttributeCodeOptionsOptionId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeCode + in: path + type: string + required: true + - name: optionId + in: path + type: integer + required: true + - name: PutV1ProductsAttributesAttributeCodeOptionsOptionIdBody + in: body + schema: + required: + - option + properties: + option: + "$ref": "#/definitions/eav-data-attribute-option-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/attributes/{attributeCode}/options/{optionId} + "/V1/products/base-prices": + post: + tags: + - products/base-prices + description: Add or update product prices. Input item should correspond \Magento\Catalog\Api\Data\CostInterface. + If any items will have invalid price, store id or sku, they will be marked + as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] + with problem description will be returned. If there were no failed items during + update empty array will be returned. If error occurred during the update exception + will be thrown. + operationId: PostV1ProductsBaseprices + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ProductsBasepricesBody + in: body + schema: + required: + - prices + properties: + prices: + type: array + items: + "$ref": "#/definitions/catalog-data-base-price-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-price-update-result-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/base-prices + "/V1/products/base-prices-information": + post: + tags: + - products/base-prices-information + description: Return product prices. In case of at least one of skus is not found + exception will be thrown. + operationId: PostV1ProductsBasepricesinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ProductsBasepricesinformationBody + in: body + schema: + required: + - skus + properties: + skus: + type: array + items: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-base-price-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/base-prices-information + "/V1/products/cost": + post: + tags: + - products/cost + description: Add or update product cost. Input item should correspond to \Magento\Catalog\Api\Data\CostInterface. + If any items will have invalid cost, store id or sku, they will be marked + as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] + with problem description will be returned. If there were no failed items during + update empty array will be returned. If error occurred during the update exception + will be thrown. + operationId: PostV1ProductsCost + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ProductsCostBody + in: body + schema: + required: + - prices + properties: + prices: + type: array + items: + "$ref": "#/definitions/catalog-data-cost-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-price-update-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/cost + "/V1/products/cost-delete": + post: + tags: + - products/cost-delete + description: Delete product cost. In case of at least one of skus is not found + exception will be thrown. If error occurred during the delete exception will + be thrown. + operationId: PostV1ProductsCostdelete + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ProductsCostdeleteBody + in: body + schema: + required: + - skus + properties: + skus: + type: array + items: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: Will return True if deleted. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/cost-delete + "/V1/products/cost-information": + post: + tags: + - products/cost-information + description: Return product prices. In case of at least one of skus is not found + exception will be thrown. + operationId: PostV1ProductsCostinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ProductsCostinformationBody + in: body + schema: + required: + - skus + properties: + skus: + type: array + items: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-cost-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/cost-information + "/V1/products/downloadable-links/samples/{id}": + delete: + tags: + - products/downloadable-links/samples/{id} + description: Delete downloadable sample + operationId: DeleteV1ProductsDownloadablelinksSamplesId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/downloadable-links/samples/{id} + "/V1/products/downloadable-links/{id}": + delete: + tags: + - products/downloadable-links/{id} + description: Delete downloadable link + operationId: DeleteV1ProductsDownloadablelinksId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/downloadable-links/{id} + "/V1/products/links/types": + get: + tags: + - products/links/types + description: Retrieve information about available product link types + operationId: GetV1ProductsLinksTypes + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-product-link-type-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/links/types + "/V1/products/links/{type}/attributes": + get: + tags: + - products/links/{type}/attributes + description: Provide a list of the product link type attributes + operationId: GetV1ProductsLinksTypeAttributes + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: type + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-product-link-attribute-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/links/{type}/attributes + "/V1/products/media/types/{attributeSetName}": + get: + tags: + - products/media/types/{attributeSetName} + description: Retrieve the list of media attributes (fronted input type is media_image) + assigned to the given attribute set. + operationId: GetV1ProductsMediaTypesAttributeSetName + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeSetName + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + description: list of media attributes + items: + "$ref": "#/definitions/catalog-data-product-attribute-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/media/types/{attributeSetName} + "/V1/products/options": + post: + tags: + - products/options + description: Save Custom Option + operationId: PostV1ProductsOptions + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ProductsOptionsBody + in: body + schema: + required: + - option + properties: + option: + "$ref": "#/definitions/catalog-data-product-custom-option-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-product-custom-option-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/options + "/V1/products/options/types": + get: + tags: + - products/options/types + description: Get custom option types + operationId: GetV1ProductsOptionsTypes + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-product-custom-option-type-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/options/types + "/V1/products/options/{optionId}": + put: + tags: + - products/options/{optionId} + description: Save Custom Option + operationId: PutV1ProductsOptionsOptionId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: optionId + in: path + type: string + required: true + - name: PutV1ProductsOptionsOptionIdBody + in: body + schema: + required: + - option + properties: + option: + "$ref": "#/definitions/catalog-data-product-custom-option-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-product-custom-option-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/options/{optionId} + "/V1/products/special-price": + post: + tags: + - products/special-price + description: Add or update product's special price. If any items will have invalid + price, store id, sku or dates, they will be marked as failed and excluded + from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] + with problem description will be returned. If there were no failed items during + update empty array will be returned. If error occurred during the update exception + will be thrown. + operationId: PostV1ProductsSpecialprice + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ProductsSpecialpriceBody + in: body + schema: + required: + - prices + properties: + prices: + type: array + items: + "$ref": "#/definitions/catalog-data-special-price-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-price-update-result-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/special-price + "/V1/products/special-price-delete": + post: + tags: + - products/special-price-delete + description: Delete product's special price. If any items will have invalid + price, store id, sku or dates, they will be marked as failed and excluded + from delete list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] + with problem description will be returned. If there were no failed items during + update empty array will be returned. If error occurred during the delete exception + will be thrown. + operationId: PostV1ProductsSpecialpricedelete + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ProductsSpecialpricedeleteBody + in: body + schema: + required: + - prices + properties: + prices: + type: array + items: + "$ref": "#/definitions/catalog-data-special-price-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-price-update-result-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/special-price-delete + "/V1/products/special-price-information": + post: + tags: + - products/special-price-information + description: Return product's special price. In case of at least one of skus + is not found exception will be thrown. + operationId: PostV1ProductsSpecialpriceinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ProductsSpecialpriceinformationBody + in: body + schema: + required: + - skus + properties: + skus: + type: array + items: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-special-price-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/special-price-information + "/V1/products/tier-prices": + post: + tags: + - products/tier-prices + description: Add or update product prices. If any items will have invalid price, + price type, website id, sku, customer group or quantity, they will be marked + as failed and excluded from update list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] + with problem description will be returned. If there were no failed items during + update empty array will be returned. If error occurred during the update exception + will be thrown. + operationId: PostV1ProductsTierprices + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ProductsTierpricesBody + in: body + schema: + required: + - prices + properties: + prices: + type: array + items: + "$ref": "#/definitions/catalog-data-tier-price-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-price-update-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/tier-prices + put: + tags: + - products/tier-prices + description: Remove existing tier prices and replace them with the new ones. + If any items will have invalid price, price type, website id, sku, customer + group or quantity, they will be marked as failed and excluded from replace + list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] with problem + description will be returned. If there were no failed items during update + empty array will be returned. If error occurred during the update exception + will be thrown. + operationId: PutV1ProductsTierprices + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1ProductsTierpricesBody + in: body + schema: + required: + - prices + properties: + prices: + type: array + items: + "$ref": "#/definitions/catalog-data-tier-price-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-price-update-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/tier-prices + "/V1/products/tier-prices-delete": + post: + tags: + - products/tier-prices-delete + description: Delete product tier prices. If any items will have invalid price, + price type, website id, sku, customer group or quantity, they will be marked + as failed and excluded from delete list and \Magento\Catalog\Api\Data\PriceUpdateResultInterface[] + with problem description will be returned. If there were no failed items during + update empty array will be returned. If error occurred during the update exception + will be thrown. + operationId: PostV1ProductsTierpricesdelete + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ProductsTierpricesdeleteBody + in: body + schema: + required: + - prices + properties: + prices: + type: array + items: + "$ref": "#/definitions/catalog-data-tier-price-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-price-update-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/tier-prices-delete + "/V1/products/tier-prices-information": + post: + tags: + - products/tier-prices-information + description: Return product prices. In case of at least one of skus is not found + exception will be thrown. + operationId: PostV1ProductsTierpricesinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ProductsTierpricesinformationBody + in: body + schema: + required: + - skus + properties: + skus: + type: array + items: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-tier-price-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/tier-prices-information + "/V1/products/types": + get: + tags: + - products/types + description: Retrieve available product types + operationId: GetV1ProductsTypes + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-product-type-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/types + "/V1/products/{productSku}/stockItems/{itemId}": + put: + tags: + - products/{productSku}/stockItems/{itemId} + description: '' + operationId: PutV1ProductsProductSkuStockItemsItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: productSku + in: path + type: string + required: true + - name: itemId + in: path + type: string + required: true + - name: PutV1ProductsProductSkuStockItemsItemIdBody + in: body + schema: + required: + - stockItem + properties: + stockItem: + "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{productSku}/stockItems/{itemId} + "/V1/products/{sku}": + put: + tags: + - products/{sku} + description: Create product + operationId: PutV1ProductsSku + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: PutV1ProductsSkuBody + in: body + schema: + required: + - product + properties: + product: + "$ref": "#/definitions/catalog-data-product-interface" + saveOptions: + type: boolean + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-product-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku} + delete: + tags: + - products/{sku} + description: '' + operationId: DeleteV1ProductsSku + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: Will returned True if deleted + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku} + get: + tags: + - products/{sku} + description: Get info about product by product SKU + operationId: GetV1ProductsSku + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: editMode + in: query + type: boolean + required: false + - name: storeId + in: query + type: integer + required: false + - name: forceReload + in: query + type: boolean + required: false + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-product-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku} + "/V1/products/{sku}/downloadable-links": + get: + tags: + - products/{sku}/downloadable-links + description: List of links with associated samples + operationId: GetV1ProductsSkuDownloadablelinks + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/downloadable-data-link-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/downloadable-links + post: + tags: + - products/{sku}/downloadable-links + description: Update downloadable link of the given product (link type and its + resources cannot be changed) + operationId: PostV1ProductsSkuDownloadablelinks + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: PostV1ProductsSkuDownloadablelinksBody + in: body + schema: + required: + - link + properties: + link: + "$ref": "#/definitions/downloadable-data-link-interface" + isGlobalScopeContent: + type: boolean + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/downloadable-links + "/V1/products/{sku}/downloadable-links/samples": + get: + tags: + - products/{sku}/downloadable-links/samples + description: List of samples for downloadable product + operationId: GetV1ProductsSkuDownloadablelinksSamples + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/downloadable-data-sample-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/downloadable-links/samples + post: + tags: + - products/{sku}/downloadable-links/samples + description: Update downloadable sample of the given product + operationId: PostV1ProductsSkuDownloadablelinksSamples + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: PostV1ProductsSkuDownloadablelinksSamplesBody + in: body + schema: + required: + - sample + properties: + sample: + "$ref": "#/definitions/downloadable-data-sample-interface" + isGlobalScopeContent: + type: boolean + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/downloadable-links/samples + "/V1/products/{sku}/downloadable-links/samples/{id}": + put: + tags: + - products/{sku}/downloadable-links/samples/{id} + description: Update downloadable sample of the given product + operationId: PutV1ProductsSkuDownloadablelinksSamplesId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: id + in: path + type: string + required: true + - name: PutV1ProductsSkuDownloadablelinksSamplesIdBody + in: body + schema: + required: + - sample + properties: + sample: + "$ref": "#/definitions/downloadable-data-sample-interface" + isGlobalScopeContent: + type: boolean + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/downloadable-links/samples/{id} + "/V1/products/{sku}/downloadable-links/{id}": + put: + tags: + - products/{sku}/downloadable-links/{id} + description: Update downloadable link of the given product (link type and its + resources cannot be changed) + operationId: PutV1ProductsSkuDownloadablelinksId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: id + in: path + type: string + required: true + - name: PutV1ProductsSkuDownloadablelinksIdBody + in: body + schema: + required: + - link + properties: + link: + "$ref": "#/definitions/downloadable-data-link-interface" + isGlobalScopeContent: + type: boolean + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/downloadable-links/{id} + "/V1/products/{sku}/group-prices/{customerGroupId}/tiers": + get: + tags: + - products/{sku}/group-prices/{customerGroupId}/tiers + description: Get tier price of product + operationId: GetV1ProductsSkuGrouppricesCustomerGroupIdTiers + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: customerGroupId + in: path + type: string + required: true + description: "'all' can be used to specify 'ALL GROUPS'" + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-product-tier-price-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/group-prices/{customerGroupId}/tiers + "/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}": + delete: + tags: + - products/{sku}/group-prices/{customerGroupId}/tiers/{qty} + description: Remove tier price from product + operationId: DeleteV1ProductsSkuGrouppricesCustomerGroupIdTiersQty + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: customerGroupId + in: path + type: string + required: true + description: "'all' can be used to specify 'ALL GROUPS'" + - name: qty + in: path + type: number + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/group-prices/{customerGroupId}/tiers/{qty} + "/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}": + post: + tags: + - products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price} + description: Create tier price for product + operationId: PostV1ProductsSkuGrouppricesCustomerGroupIdTiersQtyPricePrice + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: customerGroupId + in: path + type: string + required: true + description: "'all' can be used to specify 'ALL GROUPS'" + - name: price + in: path + type: number + required: true + - name: qty + in: path + type: number + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price} + "/V1/products/{sku}/links": + post: + tags: + - products/{sku}/links + description: Assign a product link to another product + operationId: PostV1ProductsSkuLinks + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: PostV1ProductsSkuLinksBody + in: body + schema: + required: + - items + properties: + items: + type: array + items: + "$ref": "#/definitions/catalog-data-product-link-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/links + put: + tags: + - products/{sku}/links + description: Save product link + operationId: PutV1ProductsSkuLinks + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: PutV1ProductsSkuLinksBody + in: body + schema: + required: + - entity + properties: + entity: + "$ref": "#/definitions/catalog-data-product-link-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/links + "/V1/products/{sku}/links/{type}": + get: + tags: + - products/{sku}/links/{type} + description: Provide the list of links for a specific product + operationId: GetV1ProductsSkuLinksType + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: type + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-product-link-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/links/{type} + "/V1/products/{sku}/links/{type}/{linkedProductSku}": + delete: + tags: + - products/{sku}/links/{type}/{linkedProductSku} + description: '' + operationId: DeleteV1ProductsSkuLinksTypeLinkedProductSku + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: type + in: path + type: string + required: true + - name: linkedProductSku + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/links/{type}/{linkedProductSku} + "/V1/products/{sku}/media": + post: + tags: + - products/{sku}/media + description: Create new gallery entry + operationId: PostV1ProductsSkuMedia + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: PostV1ProductsSkuMediaBody + in: body + schema: + required: + - entry + properties: + entry: + "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: gallery entry ID + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/media + get: + tags: + - products/{sku}/media + description: Retrieve the list of gallery entries associated with given product + operationId: GetV1ProductsSkuMedia + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/media + "/V1/products/{sku}/media/{entryId}": + get: + tags: + - products/{sku}/media/{entryId} + description: Return information about gallery entry + operationId: GetV1ProductsSkuMediaEntryId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: entryId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/media/{entryId} + put: + tags: + - products/{sku}/media/{entryId} + description: Update gallery entry + operationId: PutV1ProductsSkuMediaEntryId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: entryId + in: path + type: string + required: true + - name: PutV1ProductsSkuMediaEntryIdBody + in: body + schema: + required: + - entry + properties: + entry: + "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/media/{entryId} + delete: + tags: + - products/{sku}/media/{entryId} + description: Remove gallery entry + operationId: DeleteV1ProductsSkuMediaEntryId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: entryId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/media/{entryId} + "/V1/products/{sku}/options": + get: + tags: + - products/{sku}/options + description: Get the list of custom options for a specific product + operationId: GetV1ProductsSkuOptions + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/catalog-data-product-custom-option-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/options + "/V1/products/{sku}/options/{optionId}": + get: + tags: + - products/{sku}/options/{optionId} + description: Get custom option for a specific product + operationId: GetV1ProductsSkuOptionsOptionId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: optionId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-product-custom-option-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/options/{optionId} + delete: + tags: + - products/{sku}/options/{optionId} + description: '' + operationId: DeleteV1ProductsSkuOptionsOptionId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: optionId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/options/{optionId} + "/V1/products/{sku}/websites": + post: + tags: + - products/{sku}/websites + description: Assign a product to the website + operationId: PostV1ProductsSkuWebsites + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: PostV1ProductsSkuWebsitesBody + in: body + schema: + required: + - productWebsiteLink + properties: + productWebsiteLink: + "$ref": "#/definitions/catalog-data-product-website-link-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: will returned True if website successfully assigned to product + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/websites + put: + tags: + - products/{sku}/websites + description: Assign a product to the website + operationId: PutV1ProductsSkuWebsites + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: PutV1ProductsSkuWebsitesBody + in: body + schema: + required: + - productWebsiteLink + properties: + productWebsiteLink: + "$ref": "#/definitions/catalog-data-product-website-link-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: will returned True if website successfully assigned to product + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/websites + "/V1/products/{sku}/websites/{websiteId}": + delete: + tags: + - products/{sku}/websites/{websiteId} + description: Remove the website assignment from the product by product sku + operationId: DeleteV1ProductsSkuWebsitesWebsiteId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sku + in: path + type: string + required: true + - name: websiteId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: will returned True if website successfully unassigned from + product + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products/{sku}/websites/{websiteId} + "/V1/purchase-order-carts/{cartId}/billing-address": + post: + tags: + - purchase-order-carts/{cartId}/billing-address + description: Assigns a specified billing address to a specified cart. + operationId: PostV1PurchaseordercartsCartIdBillingaddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + - name: PostV1PurchaseordercartsCartIdBillingaddressBody + in: body + schema: + required: + - address + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + useForShipping: + type: boolean + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Address ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: purchase-order-carts/{cartId}/billing-address + "/V1/purchase-order-carts/{cartId}/estimate-shipping-methods": + post: + tags: + - purchase-order-carts/{cartId}/estimate-shipping-methods + description: Estimate shipping by address and return list of available shipping + methods + operationId: PostV1PurchaseordercartsCartIdEstimateshippingmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1PurchaseordercartsCartIdEstimateshippingmethodsBody + in: body + schema: + required: + - address + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: purchase-order-carts/{cartId}/estimate-shipping-methods + "/V1/purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id": + post: + tags: + - purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id + description: Estimate shipping + operationId: PostV1PurchaseordercartsCartIdEstimateshippingmethodsbyaddressid + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The shopping cart ID. + - name: PostV1PurchaseordercartsCartIdEstimateshippingmethodsbyaddressidBody + in: body + schema: + required: + - addressId + properties: + addressId: + type: integer + description: The estimate address id + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods. + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id + "/V1/purchase-order-carts/{cartId}/giftCards": + post: + tags: + - purchase-order-carts/{cartId}/giftCards + description: Add gift card to the cart. + operationId: PostV1PurchaseordercartsCartIdGiftCards + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: PostV1PurchaseordercartsCartIdGiftCardsBody + in: body + schema: + required: + - giftCardAccountData + properties: + giftCardAccountData: + "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: purchase-order-carts/{cartId}/giftCards + "/V1/purchase-order-carts/{cartId}/giftCards/{giftCardCode}": + delete: + tags: + - purchase-order-carts/{cartId}/giftCards/{giftCardCode} + description: Remove GiftCard Account entity + operationId: DeleteV1PurchaseordercartsCartIdGiftCardsGiftCardCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: giftCardCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: purchase-order-carts/{cartId}/giftCards/{giftCardCode} + "/V1/purchase-order-carts/{cartId}/payment-information": + post: + tags: + - purchase-order-carts/{cartId}/payment-information + description: Set payment information and place order for a specified cart. + operationId: PostV1PurchaseordercartsCartIdPaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: PostV1PurchaseordercartsCartIdPaymentinformationBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: purchase-order-carts/{cartId}/payment-information + get: + tags: + - purchase-order-carts/{cartId}/payment-information + description: Get payment information + operationId: GetV1PurchaseordercartsCartIdPaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/checkout-data-payment-details-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: purchase-order-carts/{cartId}/payment-information + "/V1/purchase-order-carts/{cartId}/set-payment-information": + post: + tags: + - purchase-order-carts/{cartId}/set-payment-information + description: Set payment information for a specified cart. + operationId: PostV1PurchaseordercartsCartIdSetpaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: PostV1PurchaseordercartsCartIdSetpaymentinformationBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: purchase-order-carts/{cartId}/set-payment-information + "/V1/purchase-order-carts/{cartId}/totals": + get: + tags: + - purchase-order-carts/{cartId}/totals + description: Returns quote totals data for a specified cart. + operationId: GetV1PurchaseordercartsCartIdTotals + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-totals-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: purchase-order-carts/{cartId}/totals + "/V1/requisition_lists": + post: + tags: + - requisition_lists + description: Save Requisition List + operationId: PostV1Requisition_lists + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1Requisition_listsBody + in: body + schema: + required: + - requisitionList + properties: + requisitionList: + "$ref": "#/definitions/requisition-list-data-requisition-list-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/requisition-list-data-requisition-list-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: requisition_lists + "/V1/returns": + post: + tags: + - returns + description: Save RMA + operationId: PostV1Returns + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ReturnsBody + in: body + schema: + required: + - rmaDataObject + properties: + rmaDataObject: + "$ref": "#/definitions/rma-data-rma-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/rma-data-rma-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: returns + get: + tags: + - returns + description: Return list of rma data objects based on search criteria + operationId: GetV1Returns + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/rma-data-rma-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: returns + "/V1/returns/{id}": + get: + tags: + - returns/{id} + description: Return data object for specified RMA id + operationId: GetV1ReturnsId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/rma-data-rma-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: returns/{id} + delete: + tags: + - returns/{id} + description: Delete RMA + operationId: DeleteV1ReturnsId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: string + required: true + - name: DeleteV1ReturnsIdBody + in: body + schema: + required: + - rmaDataObject + properties: + rmaDataObject: + "$ref": "#/definitions/rma-data-rma-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: returns/{id} + put: + tags: + - returns/{id} + description: Save RMA + operationId: PutV1ReturnsId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: string + required: true + - name: PutV1ReturnsIdBody + in: body + schema: + required: + - rmaDataObject + properties: + rmaDataObject: + "$ref": "#/definitions/rma-data-rma-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/rma-data-rma-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: returns/{id} + "/V1/returns/{id}/comments": + post: + tags: + - returns/{id}/comments + description: Add comment + operationId: PostV1ReturnsIdComments + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: string + required: true + - name: PostV1ReturnsIdCommentsBody + in: body + schema: + required: + - data + properties: + data: + "$ref": "#/definitions/rma-data-comment-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: returns/{id}/comments + get: + tags: + - returns/{id}/comments + description: Comments list + operationId: GetV1ReturnsIdComments + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/rma-data-comment-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: returns/{id}/comments + "/V1/returns/{id}/labels": + get: + tags: + - returns/{id}/labels + description: Get shipping label int the PDF format + operationId: GetV1ReturnsIdLabels + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: string + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: returns/{id}/labels + "/V1/returns/{id}/tracking-numbers": + post: + tags: + - returns/{id}/tracking-numbers + description: Add track + operationId: PostV1ReturnsIdTrackingnumbers + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + - name: PostV1ReturnsIdTrackingnumbersBody + in: body + schema: + required: + - track + properties: + track: + "$ref": "#/definitions/rma-data-track-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: returns/{id}/tracking-numbers + get: + tags: + - returns/{id}/tracking-numbers + description: Get track list + operationId: GetV1ReturnsIdTrackingnumbers + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/rma-data-track-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: returns/{id}/tracking-numbers + "/V1/returns/{id}/tracking-numbers/{trackId}": + delete: + tags: + - returns/{id}/tracking-numbers/{trackId} + description: Remove track by id + operationId: DeleteV1ReturnsIdTrackingnumbersTrackId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + - name: trackId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: returns/{id}/tracking-numbers/{trackId} + "/V1/returnsAttributeMetadata": + get: + tags: + - returnsAttributeMetadata + description: Get all attribute metadata. + operationId: GetV1ReturnsAttributeMetadata + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/customer-data-attribute-metadata-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: returnsAttributeMetadata + "/V1/returnsAttributeMetadata/custom": + get: + tags: + - returnsAttributeMetadata/custom + description: Get custom attribute metadata for the given Data object's attribute + set + operationId: GetV1ReturnsAttributeMetadataCustom + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: dataObjectClassName + in: query + type: string + description: Data object class name + required: false + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/framework-metadata-object-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: returnsAttributeMetadata/custom + "/V1/returnsAttributeMetadata/form/{formCode}": + get: + tags: + - returnsAttributeMetadata/form/{formCode} + description: Retrieve all attributes filtered by form code + operationId: GetV1ReturnsAttributeMetadataFormFormCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: formCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/customer-data-attribute-metadata-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: returnsAttributeMetadata/form/{formCode} + "/V1/returnsAttributeMetadata/{attributeCode}": + get: + tags: + - returnsAttributeMetadata/{attributeCode} + description: Retrieve attribute metadata. + operationId: GetV1ReturnsAttributeMetadataAttributeCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: attributeCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-attribute-metadata-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: returnsAttributeMetadata/{attributeCode} + "/V1/reward/mine/use-reward": + post: + tags: + - reward/mine/use-reward + description: Set reward points to quote + operationId: PostV1RewardMineUsereward + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: reward/mine/use-reward + "/V1/salesRules": + post: + tags: + - salesRules + description: Save sales rule. + operationId: PostV1SalesRules + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1SalesRulesBody + in: body + schema: + required: + - rule + properties: + rule: + "$ref": "#/definitions/sales-rule-data-rule-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-rule-data-rule-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: salesRules + "/V1/salesRules/search": + get: + tags: + - salesRules/search + description: Retrieve sales rules that match te specified criteria. This call + returns an array of objects, but detailed information about each object’s + attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#RuleRepositoryInterface + to determine which call to use to get detailed information about all attributes + for an object. + operationId: GetV1SalesRulesSearch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-rule-data-rule-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: salesRules/search + "/V1/salesRules/{ruleId}": + get: + tags: + - salesRules/{ruleId} + description: Get rule by ID. + operationId: GetV1SalesRulesRuleId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: ruleId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-rule-data-rule-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: salesRules/{ruleId} + put: + tags: + - salesRules/{ruleId} + description: Save sales rule. + operationId: PutV1SalesRulesRuleId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: ruleId + in: path + type: string + required: true + - name: PutV1SalesRulesRuleIdBody + in: body + schema: + required: + - rule + properties: + rule: + "$ref": "#/definitions/sales-rule-data-rule-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-rule-data-rule-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: salesRules/{ruleId} + delete: + tags: + - salesRules/{ruleId} + description: Delete rule by ID. + operationId: DeleteV1SalesRulesRuleId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: ruleId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: salesRules/{ruleId} + "/V1/search": + get: + tags: + - search + description: Make Full Text Search and return found Documents + operationId: GetV1Search + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[requestName] + in: query + type: string + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/framework-search-search-result-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: search + "/V1/sharedCatalog": + post: + tags: + - sharedCatalog + description: Create or update Shared Catalog service. + operationId: PostV1SharedCatalog + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1SharedCatalogBody + in: body + schema: + required: + - sharedCatalog + properties: + sharedCatalog: + "$ref": "#/definitions/shared-catalog-data-shared-catalog-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: sharedCatalog + "/V1/sharedCatalog/": + get: + tags: + - sharedCatalog/ + description: Return the list of shared catalogs and basic properties for each + catalog. + operationId: GetV1SharedCatalog + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/shared-catalog-data-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: sharedCatalog/ + "/V1/sharedCatalog/{id}": + put: + tags: + - sharedCatalog/{id} + description: Create or update Shared Catalog service. + operationId: PutV1SharedCatalogId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: string + required: true + - name: PutV1SharedCatalogIdBody + in: body + schema: + required: + - sharedCatalog + properties: + sharedCatalog: + "$ref": "#/definitions/shared-catalog-data-shared-catalog-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: sharedCatalog/{id} + "/V1/sharedCatalog/{id}/assignCategories": + post: + tags: + - sharedCatalog/{id}/assignCategories + description: Add categories into the shared catalog. + operationId: PostV1SharedCatalogIdAssignCategories + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + - name: PostV1SharedCatalogIdAssignCategoriesBody + in: body + schema: + required: + - categories + properties: + categories: + type: array + items: + "$ref": "#/definitions/catalog-data-category-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: sharedCatalog/{id}/assignCategories + "/V1/sharedCatalog/{id}/assignProducts": + post: + tags: + - sharedCatalog/{id}/assignProducts + description: Add products into the shared catalog. + operationId: PostV1SharedCatalogIdAssignProducts + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + - name: PostV1SharedCatalogIdAssignProductsBody + in: body + schema: + required: + - products + properties: + products: + type: array + items: + "$ref": "#/definitions/catalog-data-product-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: sharedCatalog/{id}/assignProducts + "/V1/sharedCatalog/{id}/categories": + get: + tags: + - sharedCatalog/{id}/categories + description: Return the list of categories in the selected shared catalog. + operationId: GetV1SharedCatalogIdCategories + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + type: integer + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: sharedCatalog/{id}/categories + "/V1/sharedCatalog/{id}/products": + get: + tags: + - sharedCatalog/{id}/products + description: Return the list of product SKUs in the selected shared catalog. + operationId: GetV1SharedCatalogIdProducts + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + type: string + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: sharedCatalog/{id}/products + "/V1/sharedCatalog/{id}/unassignCategories": + post: + tags: + - sharedCatalog/{id}/unassignCategories + description: Remove the specified categories from the shared catalog. + operationId: PostV1SharedCatalogIdUnassignCategories + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + - name: PostV1SharedCatalogIdUnassignCategoriesBody + in: body + schema: + required: + - categories + properties: + categories: + type: array + items: + "$ref": "#/definitions/catalog-data-category-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: sharedCatalog/{id}/unassignCategories + "/V1/sharedCatalog/{id}/unassignProducts": + post: + tags: + - sharedCatalog/{id}/unassignProducts + description: Remove the specified products from the shared catalog. + operationId: PostV1SharedCatalogIdUnassignProducts + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + - name: PostV1SharedCatalogIdUnassignProductsBody + in: body + schema: + required: + - products + properties: + products: + type: array + items: + "$ref": "#/definitions/catalog-data-product-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: sharedCatalog/{id}/unassignProducts + "/V1/sharedCatalog/{sharedCatalogId}": + get: + tags: + - sharedCatalog/{sharedCatalogId} + description: 'Return the following properties for the selected shared catalog: + ID, Store Group ID, Name, Type, Description, Customer Group, Tax Class.' + operationId: GetV1SharedCatalogSharedCatalogId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sharedCatalogId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/shared-catalog-data-shared-catalog-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: sharedCatalog/{sharedCatalogId} + delete: + tags: + - sharedCatalog/{sharedCatalogId} + description: Delete a shared catalog by ID. + operationId: DeleteV1SharedCatalogSharedCatalogId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sharedCatalogId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: sharedCatalog/{sharedCatalogId} + "/V1/sharedCatalog/{sharedCatalogId}/assignCompanies": + post: + tags: + - sharedCatalog/{sharedCatalogId}/assignCompanies + description: Assign companies to a shared catalog. + operationId: PostV1SharedCatalogSharedCatalogIdAssignCompanies + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sharedCatalogId + in: path + type: integer + required: true + - name: PostV1SharedCatalogSharedCatalogIdAssignCompaniesBody + in: body + schema: + required: + - companies + properties: + companies: + type: array + items: + "$ref": "#/definitions/company-data-company-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: sharedCatalog/{sharedCatalogId}/assignCompanies + "/V1/sharedCatalog/{sharedCatalogId}/assignTierPrices": + post: + tags: + - sharedCatalog/{sharedCatalogId}/assignTierPrices + description: Assign custom prices + operationId: PostV1SharedCatalogSharedCatalogIdAssignTierPrices + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sharedCatalogId + in: path + type: integer + required: true + - name: PostV1SharedCatalogSharedCatalogIdAssignTierPricesBody + in: body + schema: + required: + - prices + properties: + prices: + type: array + items: + "$ref": "#/definitions/catalog-data-tier-price-interface" + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: sharedCatalog/{sharedCatalogId}/assignTierPrices + "/V1/sharedCatalog/{sharedCatalogId}/companies": + get: + tags: + - sharedCatalog/{sharedCatalogId}/companies + description: Return the list of company IDs for the companies assigned to the + selected catalog. + operationId: GetV1SharedCatalogSharedCatalogIdCompanies + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sharedCatalogId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: string + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: sharedCatalog/{sharedCatalogId}/companies + "/V1/sharedCatalog/{sharedCatalogId}/resetTierPrices": + post: + tags: + - sharedCatalog/{sharedCatalogId}/resetTierPrices + description: Reset custom prices + operationId: PostV1SharedCatalogSharedCatalogIdResetTierPrices + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sharedCatalogId + in: path + type: integer + required: true + - name: PostV1SharedCatalogSharedCatalogIdResetTierPricesBody + in: body + schema: + required: + - skus + properties: + skus: + type: array + items: + type: string + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: sharedCatalog/{sharedCatalogId}/resetTierPrices + "/V1/sharedCatalog/{sharedCatalogId}/unassignCompanies": + post: + tags: + - sharedCatalog/{sharedCatalogId}/unassignCompanies + description: Unassign companies from a shared catalog. + operationId: PostV1SharedCatalogSharedCatalogIdUnassignCompanies + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: sharedCatalogId + in: path + type: integer + required: true + - name: PostV1SharedCatalogSharedCatalogIdUnassignCompaniesBody + in: body + schema: + required: + - companies + properties: + companies: + type: array + items: + "$ref": "#/definitions/company-data-company-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: sharedCatalog/{sharedCatalogId}/unassignCompanies + "/V1/shipment/": + post: + tags: + - shipment/ + description: Performs persist operations for a specified shipment. + operationId: PostV1Shipment + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ShipmentBody + in: body + schema: + required: + - entity + properties: + entity: + "$ref": "#/definitions/sales-data-shipment-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-shipment-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: shipment/ + "/V1/shipment/track": + post: + tags: + - shipment/track + description: Performs persist operations for a specified shipment track. + operationId: PostV1ShipmentTrack + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1ShipmentTrackBody + in: body + schema: + required: + - entity + properties: + entity: + "$ref": "#/definitions/sales-data-shipment-track-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-shipment-track-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: shipment/track + "/V1/shipment/track/{id}": + delete: + tags: + - shipment/track/{id} + description: Deletes a specified shipment track by ID. + operationId: DeleteV1ShipmentTrackId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The shipment track ID. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: shipment/track/{id} + "/V1/shipment/{id}": + get: + tags: + - shipment/{id} + description: Loads a specified shipment. + operationId: GetV1ShipmentId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The shipment ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-shipment-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: shipment/{id} + "/V1/shipment/{id}/comments": + get: + tags: + - shipment/{id}/comments + description: Lists comments for a specified shipment. + operationId: GetV1ShipmentIdComments + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The shipment ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-shipment-comment-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: shipment/{id}/comments + post: + tags: + - shipment/{id}/comments + description: Performs persist operations for a specified shipment comment. + operationId: PostV1ShipmentIdComments + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: string + required: true + - name: PostV1ShipmentIdCommentsBody + in: body + schema: + required: + - entity + properties: + entity: + "$ref": "#/definitions/sales-data-shipment-comment-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-shipment-comment-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: shipment/{id}/comments + "/V1/shipment/{id}/emails": + post: + tags: + - shipment/{id}/emails + description: Emails user a specified shipment. + operationId: PostV1ShipmentIdEmails + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The shipment ID. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: shipment/{id}/emails + "/V1/shipment/{id}/label": + get: + tags: + - shipment/{id}/label + description: Gets a specified shipment label. + operationId: GetV1ShipmentIdLabel + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The shipment label ID. + responses: + '200': + description: 200 Success. + schema: + type: string + description: Shipment label. + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: shipment/{id}/label + "/V1/shipments": + get: + tags: + - shipments + description: Lists shipments that match specified search criteria. This call + returns an array of objects, but detailed information about each object’s + attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#ShipmentRepositoryInterface + to determine which call to use to get detailed information about all attributes + for an object. + operationId: GetV1Shipments + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-shipment-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: shipments + "/V1/stockItems/lowStock/": + get: + tags: + - stockItems/lowStock/ + description: Retrieves a list of SKU's with low inventory qty + operationId: GetV1StockItemsLowStock + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: scopeId + in: query + type: integer + required: true + - name: qty + in: query + type: number + required: true + - name: currentPage + in: query + type: integer + required: false + - name: pageSize + in: query + type: integer + required: false + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-inventory-data-stock-item-collection-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: stockItems/lowStock/ + "/V1/stockItems/{productSku}": + get: + tags: + - stockItems/{productSku} + description: '' + operationId: GetV1StockItemsProductSku + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: productSku + in: path + type: string + required: true + - name: scopeId + in: query + type: integer + required: false + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: stockItems/{productSku} + "/V1/stockStatuses/{productSku}": + get: + tags: + - stockStatuses/{productSku} + description: '' + operationId: GetV1StockStatusesProductSku + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: productSku + in: path + type: string + required: true + - name: scopeId + in: query + type: integer + required: false + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-inventory-data-stock-status-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: stockStatuses/{productSku} + "/V1/store/storeConfigs": + get: + tags: + - store/storeConfigs + description: '' + operationId: GetV1StoreStoreConfigs + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: storeCodes + in: query + type: array + items: + type: string + required: false + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/store-data-store-config-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: store/storeConfigs + "/V1/store/storeGroups": + get: + tags: + - store/storeGroups + description: Retrieve list of all groups + operationId: GetV1StoreStoreGroups + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/store-data-group-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: store/storeGroups + "/V1/store/storeViews": + get: + tags: + - store/storeViews + description: Retrieve list of all stores + operationId: GetV1StoreStoreViews + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/store-data-store-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: store/storeViews + "/V1/store/websites": + get: + tags: + - store/websites + description: Retrieve list of all websites + operationId: GetV1StoreWebsites + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/store-data-website-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: store/websites + "/V1/taxClasses": + post: + tags: + - taxClasses + description: Create a Tax Class + operationId: PostV1TaxClasses + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TaxClassesBody + in: body + schema: + required: + - taxClass + properties: + taxClass: + "$ref": "#/definitions/tax-data-tax-class-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + description: id for the newly created Tax class + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: taxClasses + "/V1/taxClasses/search": + get: + tags: + - taxClasses/search + description: Retrieve tax classes which match a specific criteria. This call + returns an array of objects, but detailed information about each object’s + attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#TaxClassRepositoryInterface + to determine which call to use to get detailed information about all attributes + for an object. + operationId: GetV1TaxClassesSearch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/tax-data-tax-class-search-results-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: taxClasses/search + "/V1/taxClasses/{classId}": + put: + tags: + - taxClasses/{classId} + description: Create a Tax Class + operationId: PutV1TaxClassesClassId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: classId + in: path + type: string + required: true + - name: PutV1TaxClassesClassIdBody + in: body + schema: + required: + - taxClass + properties: + taxClass: + "$ref": "#/definitions/tax-data-tax-class-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + description: id for the newly created Tax class + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: taxClasses/{classId} + "/V1/taxClasses/{taxClassId}": + get: + tags: + - taxClasses/{taxClassId} + description: Get a tax class with the given tax class id. + operationId: GetV1TaxClassesTaxClassId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: taxClassId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/tax-data-tax-class-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: taxClasses/{taxClassId} + delete: + tags: + - taxClasses/{taxClassId} + description: Delete a tax class with the given tax class id. + operationId: DeleteV1TaxClassesTaxClassId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: taxClassId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: True if the tax class was deleted, false otherwise + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: taxClasses/{taxClassId} + "/V1/taxRates": + post: + tags: + - taxRates + description: Create or update tax rate + operationId: PostV1TaxRates + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TaxRatesBody + in: body + schema: + required: + - taxRate + properties: + taxRate: + "$ref": "#/definitions/tax-data-tax-rate-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/tax-data-tax-rate-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: taxRates + put: + tags: + - taxRates + description: Create or update tax rate + operationId: PutV1TaxRates + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1TaxRatesBody + in: body + schema: + required: + - taxRate + properties: + taxRate: + "$ref": "#/definitions/tax-data-tax-rate-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/tax-data-tax-rate-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: taxRates + "/V1/taxRates/search": + get: + tags: + - taxRates/search + description: Search TaxRates This call returns an array of objects, but detailed + information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#TaxRateRepositoryInterface + to determine which call to use to get detailed information about all attributes + for an object. + operationId: GetV1TaxRatesSearch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/tax-data-tax-rate-search-results-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: taxRates/search + "/V1/taxRates/{rateId}": + get: + tags: + - taxRates/{rateId} + description: Get tax rate + operationId: GetV1TaxRatesRateId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: rateId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/tax-data-tax-rate-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: taxRates/{rateId} + delete: + tags: + - taxRates/{rateId} + description: Delete tax rate + operationId: DeleteV1TaxRatesRateId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: rateId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: taxRates/{rateId} + "/V1/taxRules": + post: + tags: + - taxRules + description: Save TaxRule + operationId: PostV1TaxRules + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TaxRulesBody + in: body + schema: + required: + - rule + properties: + rule: + "$ref": "#/definitions/tax-data-tax-rule-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/tax-data-tax-rule-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: taxRules + put: + tags: + - taxRules + description: Save TaxRule + operationId: PutV1TaxRules + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1TaxRulesBody + in: body + schema: + required: + - rule + properties: + rule: + "$ref": "#/definitions/tax-data-tax-rule-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/tax-data-tax-rule-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: taxRules + "/V1/taxRules/search": + get: + tags: + - taxRules/search + description: Search TaxRules This call returns an array of objects, but detailed + information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#TaxRuleRepositoryInterface + to determine which call to use to get detailed information about all attributes + for an object. + operationId: GetV1TaxRulesSearch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/tax-data-tax-rule-search-results-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: taxRules/search + "/V1/taxRules/{ruleId}": + delete: + tags: + - taxRules/{ruleId} + description: Delete TaxRule + operationId: DeleteV1TaxRulesRuleId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: ruleId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: taxRules/{ruleId} + get: + tags: + - taxRules/{ruleId} + description: Get TaxRule + operationId: GetV1TaxRulesRuleId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: ruleId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/tax-data-tax-rule-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: taxRules/{ruleId} + "/V1/team/": + get: + tags: + - team/ + description: Returns the list of teams for the specified search criteria (team + name or description). + operationId: GetV1Team + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/company-data-team-search-results-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: team/ + "/V1/team/{companyId}": + post: + tags: + - team/{companyId} + description: Create a team in the company structure. + operationId: PostV1TeamCompanyId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: companyId + in: path + type: integer + required: true + - name: PostV1TeamCompanyIdBody + in: body + schema: + required: + - team + properties: + team: + "$ref": "#/definitions/company-data-team-interface" + type: object + xml: + name: request + responses: + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: team/{companyId} + "/V1/team/{teamId}": + get: + tags: + - team/{teamId} + description: Returns data for a team in the company, by entity id. + operationId: GetV1TeamTeamId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: teamId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/company-data-team-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: team/{teamId} + delete: + tags: + - team/{teamId} + description: Delete a team from the company structure. + operationId: DeleteV1TeamTeamId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: teamId + in: path + type: integer + required: true + responses: + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: team/{teamId} + put: + tags: + - team/{teamId} + description: Update a team in the company structure. + operationId: PutV1TeamTeamId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: teamId + in: path + type: string + required: true + - name: PutV1TeamTeamIdBody + in: body + schema: + required: + - team + properties: + team: + "$ref": "#/definitions/company-data-team-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: team/{teamId} + "/V1/tfa/default-provider-code/{userId}": + put: + tags: + - tfa/default-provider-code/{userId} + description: Set default provider code + operationId: PutV1TfaDefaultprovidercodeUserId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: userId + in: path + type: integer + required: true + - name: PutV1TfaDefaultprovidercodeUserIdBody + in: body + schema: + required: + - providerCode + properties: + providerCode: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/default-provider-code/{userId} + get: + tags: + - tfa/default-provider-code/{userId} + description: Get default provider + operationId: GetV1TfaDefaultprovidercodeUserId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: userId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: string + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/default-provider-code/{userId} + "/V1/tfa/forced-providers": + get: + tags: + - tfa/forced-providers + description: Retrieve forced providers list + operationId: GetV1TfaForcedproviders + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/two-factor-auth-provider-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/forced-providers + "/V1/tfa/installed-providers": + get: + tags: + - tfa/installed-providers + description: Get a list of providers + operationId: GetV1TfaInstalledproviders + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/two-factor-auth-provider-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/installed-providers + "/V1/tfa/provider/authy/activate": + post: + tags: + - tfa/provider/authy/activate + description: Activate the provider and get an admin token + operationId: PostV1TfaProviderAuthyActivate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderAuthyActivateBody + in: body + schema: + required: + - tfaToken + - otp + properties: + tfaToken: + type: string + otp: + type: string + type: object + xml: + name: request + responses: + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/authy/activate + "/V1/tfa/provider/authy/authenticate": + post: + tags: + - tfa/provider/authy/authenticate + description: Get an admin token using authy 2fa + operationId: PostV1TfaProviderAuthyAuthenticate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderAuthyAuthenticateBody + in: body + schema: + required: + - username + - password + - otp + properties: + username: + type: string + password: + type: string + otp: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + description: "$otp" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/authy/authenticate + "/V1/tfa/provider/authy/authenticate-onetouch": + post: + tags: + - tfa/provider/authy/authenticate-onetouch + description: Authenticate using the present one touch response and get an admin + token + operationId: PostV1TfaProviderAuthyAuthenticateonetouch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderAuthyAuthenticateonetouchBody + in: body + schema: + required: + - username + - password + properties: + username: + type: string + password: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/authy/authenticate-onetouch + "/V1/tfa/provider/authy/configure": + post: + tags: + - tfa/provider/authy/configure + description: Get the information required to configure google + operationId: PostV1TfaProviderAuthyConfigure + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderAuthyConfigureBody + in: body + schema: + required: + - tfaToken + - deviceData + properties: + tfaToken: + type: string + deviceData: + "$ref": "#/definitions/two-factor-auth-data-authy-device-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/two-factor-auth-data-authy-registration-prompt-response-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/authy/configure + "/V1/tfa/provider/authy/send-token/{via}": + post: + tags: + - tfa/provider/authy/send-token/{via} + description: Send a one time password to a device using authy + operationId: PostV1TfaProviderAuthySendtokenVia + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: via + in: path + type: string + required: true + - name: PostV1TfaProviderAuthySendtokenViaBody + in: body + schema: + required: + - username + - password + properties: + username: + type: string + password: + type: string + type: object + xml: + name: request + responses: + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/authy/send-token/{via} + "/V1/tfa/provider/duo_security/activate": + post: + tags: + - tfa/provider/duo_security/activate + description: Activate the provider and get an admin token + operationId: PostV1TfaProviderDuo_securityActivate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderDuo_securityActivateBody + in: body + schema: + required: + - tfaToken + properties: + tfaToken: + type: string + type: object + xml: + name: request + responses: + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/duo_security/activate + "/V1/tfa/provider/duo_security/authenticate": + post: + tags: + - tfa/provider/duo_security/authenticate + description: Authenticate and get an admin token with passcode + operationId: PostV1TfaProviderDuo_securityAuthenticate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderDuo_securityAuthenticateBody + in: body + schema: + required: + - username + - password + - passcode + properties: + username: + type: string + password: + type: string + passcode: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/duo_security/authenticate + "/V1/tfa/provider/duo_security/configure": + post: + tags: + - tfa/provider/duo_security/configure + description: Configure duo for first time user + operationId: PostV1TfaProviderDuo_securityConfigure + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderDuo_securityConfigureBody + in: body + schema: + required: + - tfaToken + properties: + tfaToken: + type: string + type: object + xml: + name: request + responses: + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/duo_security/configure + "/V1/tfa/provider/google/activate": + post: + tags: + - tfa/provider/google/activate + description: Activate the provider and get an admin token + operationId: PostV1TfaProviderGoogleActivate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderGoogleActivateBody + in: body + schema: + required: + - tfaToken + - otp + properties: + tfaToken: + type: string + otp: + type: string + type: object + xml: + name: request + responses: + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/google/activate + "/V1/tfa/provider/google/authenticate": + post: + tags: + - tfa/provider/google/authenticate + description: Get an admin token by authenticating using google + operationId: PostV1TfaProviderGoogleAuthenticate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderGoogleAuthenticateBody + in: body + schema: + required: + - username + - password + - otp + properties: + username: + type: string + password: + type: string + otp: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/google/authenticate + "/V1/tfa/provider/google/configure": + post: + tags: + - tfa/provider/google/configure + description: Get the information required to configure google + operationId: PostV1TfaProviderGoogleConfigure + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderGoogleConfigureBody + in: body + schema: + required: + - tfaToken + properties: + tfaToken: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/two-factor-auth-data-google-configure-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/google/configure + "/V1/tfa/provider/u2fkey/activate": + post: + tags: + - tfa/provider/u2fkey/activate + description: Activate the provider and get a token + operationId: PostV1TfaProviderU2fkeyActivate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderU2fkeyActivateBody + in: body + schema: + required: + - tfaToken + - publicKeyCredentialJson + properties: + tfaToken: + type: string + publicKeyCredentialJson: + type: string + type: object + xml: + name: request + responses: + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/u2fkey/activate + "/V1/tfa/provider/u2fkey/authentication-challenge": + post: + tags: + - tfa/provider/u2fkey/authentication-challenge + description: Get the information to initiate a WebAuthn registration ceremony + operationId: PostV1TfaProviderU2fkeyAuthenticationchallenge + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderU2fkeyAuthenticationchallengeBody + in: body + schema: + required: + - username + - password + properties: + username: + type: string + password: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/u2fkey/authentication-challenge + "/V1/tfa/provider/u2fkey/configure": + post: + tags: + - tfa/provider/u2fkey/configure + description: Get the information to initiate a WebAuthn registration ceremony + operationId: PostV1TfaProviderU2fkeyConfigure + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderU2fkeyConfigureBody + in: body + schema: + required: + - tfaToken + properties: + tfaToken: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/u2fkey/configure + "/V1/tfa/provider/u2fkey/verify": + post: + tags: + - tfa/provider/u2fkey/verify + description: Authenticate with the provider and get a token + operationId: PostV1TfaProviderU2fkeyVerify + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderU2fkeyVerifyBody + in: body + schema: + required: + - username + - password + - publicKeyCredentialJson + properties: + username: + type: string + password: + type: string + publicKeyCredentialJson: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/u2fkey/verify + "/V1/tfa/providers-to-activate/{userId}": + get: + tags: + - tfa/providers-to-activate/{userId} + description: Returns a list of providers to configure/enroll + operationId: GetV1TfaProviderstoactivateUserId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: userId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/two-factor-auth-provider-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/providers-to-activate/{userId} + "/V1/tfa/tfat-providers-to-activate": + get: + tags: + - tfa/tfat-providers-to-activate + description: Get the providers that the user still needs to configure + operationId: GetV1TfaTfatproviderstoactivate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: tfaToken + in: query + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/two-factor-auth-provider-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/tfat-providers-to-activate + "/V1/tfa/tfat-user-providers": + get: + tags: + - tfa/tfat-user-providers + description: Get the providers that the user is able to use for 2fa + operationId: GetV1TfaTfatuserproviders + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: tfaToken + in: query + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/two-factor-auth-provider-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/tfat-user-providers + "/V1/tfa/user-providers/{userId}": + get: + tags: + - tfa/user-providers/{userId} + description: Get a user provider + operationId: GetV1TfaUserprovidersUserId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: userId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/two-factor-auth-provider-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/user-providers/{userId} + put: + tags: + - tfa/user-providers/{userId} + description: Set providers + operationId: PutV1TfaUserprovidersUserId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: userId + in: path + type: integer + required: true + - name: PutV1TfaUserprovidersUserIdBody + in: body + schema: + required: + - providersCodes + properties: + providersCodes: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/user-providers/{userId} + "/V1/transactions": + get: + tags: + - transactions + description: Lists transactions that match specified search criteria. This call + returns an array of objects, but detailed information about each object’s + attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#TransactionRepositoryInterface + to determine which call to use to get detailed information about all attributes + for an object. + operationId: GetV1Transactions + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-transaction-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: transactions + "/V1/transactions/{id}": + get: + tags: + - transactions/{id} + description: Loads a specified transaction. + operationId: GetV1TransactionsId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: integer + required: true + description: The transaction ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/sales-data-transaction-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: transactions/{id} + "/V1/webhooks/list": + get: + tags: + - webhooks/list + description: Returns the list of all subscribed webhooks + operationId: GetV1WebhooksList + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/adobe-commerce-webhooks-data-webhook-data-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: webhooks/list + "/V1/webhooks/subscribe": + post: + tags: + - webhooks/subscribe + description: Subscribes to the webhook. + operationId: PostV1WebhooksSubscribe + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1WebhooksSubscribeBody + in: body + schema: + required: + - webhook + properties: + webhook: + "$ref": "#/definitions/adobe-commerce-webhooks-data-webhook-data-interface" + type: object + xml: + name: request + responses: + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: webhooks/subscribe + "/V1/webhooks/unsubscribe": + post: + tags: + - webhooks/unsubscribe + description: Unsubscribes from the webhook. + operationId: PostV1WebhooksUnsubscribe + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1WebhooksUnsubscribeBody + in: body + schema: + required: + - webhook + properties: + webhook: + "$ref": "#/definitions/adobe-commerce-webhooks-data-webhook-data-interface" + type: object + xml: + name: request + responses: + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: webhooks/unsubscribe + "/V2/carts/mine/coupons": + get: + tags: + - carts/mine/coupons + description: Returns information for all coupons in a specified cart. + operationId: GetV2CartsMineCoupons + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + description: The coupon code data. + items: + type: string + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/coupons + post: + tags: + - carts/mine/coupons + description: Append the coupon code(s) to cart + operationId: PostV2CartsMineCoupons + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV2CartsMineCouponsBody + in: body + schema: + required: + - couponCodes + properties: + couponCodes: + type: array + items: + type: string + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/coupons + put: + tags: + - carts/mine/coupons + description: Replace the coupon code(s) in cart with the new code(s) + operationId: PutV2CartsMineCoupons + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV2CartsMineCouponsBody + in: body + schema: + required: + - couponCodes + properties: + couponCodes: + type: array + items: + type: string + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/coupons + "/V2/carts/mine/coupons/deleteByCodes": + post: + tags: + - carts/mine/coupons/deleteByCodes + description: Deletes coupon(s) from a specified cart. + operationId: PostV2CartsMineCouponsDeleteByCodes + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV2CartsMineCouponsDeleteByCodesBody + in: body + schema: + properties: + couponCodes: + type: array + description: coupon codes + items: + type: string + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/coupons/deleteByCodes + "/V2/carts/{cartId}/coupons": + get: + tags: + - carts/{cartId}/coupons + description: Returns information for all coupons in a specified cart. + operationId: GetV2CartsCartIdCoupons + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + type: array + description: The coupon code data. + items: + type: string + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/coupons + post: + tags: + - carts/{cartId}/coupons + description: Append the coupon code(s) to cart + operationId: PostV2CartsCartIdCoupons + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: PostV2CartsCartIdCouponsBody + in: body + schema: + required: + - couponCodes + properties: + couponCodes: + type: array + items: + type: string + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/coupons + put: + tags: + - carts/{cartId}/coupons + description: Replace the coupon code(s) in cart with the new code(s) + operationId: PutV2CartsCartIdCoupons + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: PutV2CartsCartIdCouponsBody + in: body + schema: + required: + - couponCodes + properties: + couponCodes: + type: array + items: + type: string + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/coupons + "/V2/carts/{cartId}/coupons/deleteByCodes": + post: + tags: + - carts/{cartId}/coupons/deleteByCodes + description: Deletes coupon(s) from a specified cart. + operationId: PostV2CartsCartIdCouponsDeleteByCodes + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + - name: PostV2CartsCartIdCouponsDeleteByCodesBody + in: body + schema: + properties: + couponCodes: + type: array + description: coupon codes + items: + type: string + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/{cartId}/coupons/deleteByCodes +definitions: + error-response: + type: object + properties: + message: + type: string + description: Error message + errors: + "$ref": "#/definitions/error-errors" + code: + type: integer + description: Error code + parameters: + "$ref": "#/definitions/error-parameters" + trace: + type: string + description: Stack trace + required: + - message + error-errors: + type: array + description: Errors list + items: + "$ref": "#/definitions/error-errors-item" + error-errors-item: + type: object + description: Error details + properties: + message: + type: string + description: Error message + parameters: + "$ref": "#/definitions/error-parameters" + error-parameters: + type: array + description: Error parameters list + items: + "$ref": "#/definitions/error-parameters-item" + error-parameters-item: + type: object + description: Error parameters item + properties: + resources: + type: string + description: ACL resource + fieldName: + type: string + description: Missing or invalid field name + fieldValue: + type: string + description: Incorrect field value + store-data-store-interface: + type: object + description: Store interface + properties: + id: + type: integer + code: + type: string + name: + type: string + description: Store name + website_id: + type: integer + store_group_id: + type: integer + is_active: + type: integer + extension_attributes: + "$ref": "#/definitions/store-data-store-extension-interface" + required: + - id + - code + - name + - website_id + - store_group_id + - is_active + store-data-store-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Store\Api\Data\StoreInterface + store-data-group-interface: + type: object + description: Group interface + properties: + id: + type: integer + website_id: + type: integer + root_category_id: + type: integer + default_store_id: + type: integer + name: + type: string + code: + type: string + description: Group code. + extension_attributes: + "$ref": "#/definitions/store-data-group-extension-interface" + required: + - id + - website_id + - root_category_id + - default_store_id + - name + - code + store-data-group-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Store\Api\Data\GroupInterface + store-data-website-interface: + type: object + description: Website interface + properties: + id: + type: integer + code: + type: string + name: + type: string + description: Website name + default_group_id: + type: integer + extension_attributes: + "$ref": "#/definitions/store-data-website-extension-interface" + required: + - id + - code + - name + - default_group_id + store-data-website-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Store\Api\Data\WebsiteInterface + store-data-store-config-interface: + type: object + description: Interface for store config + properties: + id: + type: integer + description: Store id + code: + type: string + description: Store code + website_id: + type: integer + description: Website id of the store + locale: + type: string + description: Store locale + base_currency_code: + type: string + description: Base currency code + default_display_currency_code: + type: string + description: Default display currency code + timezone: + type: string + description: Timezone of the store + weight_unit: + type: string + description: The unit of weight + base_url: + type: string + description: Base URL for the store + base_link_url: + type: string + description: Base link URL for the store + base_static_url: + type: string + description: Base static URL for the store + base_media_url: + type: string + description: Base media URL for the store + secure_base_url: + type: string + description: Secure base URL for the store + secure_base_link_url: + type: string + description: Secure base link URL for the store + secure_base_static_url: + type: string + description: Secure base static URL for the store + secure_base_media_url: + type: string + description: Secure base media URL for the store + extension_attributes: + "$ref": "#/definitions/store-data-store-config-extension-interface" + required: + - id + - code + - website_id + - locale + - base_currency_code + - default_display_currency_code + - timezone + - weight_unit + - base_url + - base_link_url + - base_static_url + - base_media_url + - secure_base_url + - secure_base_link_url + - secure_base_static_url + - secure_base_media_url + store-data-store-config-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Store\Api\Data\StoreConfigInterface + directory-data-currency-information-interface: + type: object + description: Currency Information interface. + properties: + base_currency_code: + type: string + description: The base currency code for the store. + base_currency_symbol: + type: string + description: The currency symbol of the base currency for the store. + default_display_currency_code: + type: string + description: The default display currency code for the store. + default_display_currency_symbol: + type: string + description: The currency symbol of the default display currency for the store. + available_currency_codes: + type: array + description: The list of allowed currency codes for the store. + items: + type: string + exchange_rates: + type: array + description: The list of exchange rate information for the store. + items: + "$ref": "#/definitions/directory-data-exchange-rate-interface" + extension_attributes: + "$ref": "#/definitions/directory-data-currency-information-extension-interface" + required: + - base_currency_code + - base_currency_symbol + - default_display_currency_code + - default_display_currency_symbol + - available_currency_codes + - exchange_rates + directory-data-exchange-rate-interface: + type: object + description: Exchange Rate interface. + properties: + currency_to: + type: string + description: The currency code associated with the exchange rate. + rate: + type: number + description: The exchange rate for the associated currency and the store's + base currency. + extension_attributes: + "$ref": "#/definitions/directory-data-exchange-rate-extension-interface" + required: + - currency_to + - rate + directory-data-exchange-rate-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Directory\Api\Data\ExchangeRateInterface + directory-data-currency-information-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Directory\Api\Data\CurrencyInformationInterface + directory-data-country-information-interface: + type: object + description: Country Information interface. + properties: + id: + type: string + description: The country id for the store. + two_letter_abbreviation: + type: string + description: The country 2 letter abbreviation for the store. + three_letter_abbreviation: + type: string + description: The country 3 letter abbreviation for the store. + full_name_locale: + type: string + description: The country full name (in store locale) for the store. + full_name_english: + type: string + description: The country full name (in English) for the store. + available_regions: + type: array + description: The available regions for the store. + items: + "$ref": "#/definitions/directory-data-region-information-interface" + extension_attributes: + "$ref": "#/definitions/directory-data-country-information-extension-interface" + required: + - id + - two_letter_abbreviation + - three_letter_abbreviation + - full_name_locale + - full_name_english + directory-data-region-information-interface: + type: object + description: Region Information interface. + properties: + id: + type: string + description: Region id + code: + type: string + description: Region code + name: + type: string + description: Region name + extension_attributes: + "$ref": "#/definitions/directory-data-region-information-extension-interface" + required: + - id + - code + - name + directory-data-region-information-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Directory\Api\Data\RegionInformationInterface + directory-data-country-information-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Directory\Api\Data\CountryInformationInterface + eav-data-attribute-set-search-results-interface: + type: object + description: Interface AttributeSetSearchResultsInterface + properties: + items: + type: array + description: Attribute sets list. + items: + "$ref": "#/definitions/eav-data-attribute-set-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + eav-data-attribute-set-interface: + type: object + description: Interface AttributeSetInterface + properties: + attribute_set_id: + type: integer + description: Attribute set ID + attribute_set_name: + type: string + description: Attribute set name + sort_order: + type: integer + description: Attribute set sort order index + entity_type_id: + type: integer + description: Attribute set entity type id + extension_attributes: + "$ref": "#/definitions/eav-data-attribute-set-extension-interface" + required: + - attribute_set_name + - sort_order + eav-data-attribute-set-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Eav\Api\Data\AttributeSetInterface + framework-search-criteria-interface: + type: object + description: Search criteria interface. + properties: + filter_groups: + type: array + description: A list of filter groups. + items: + "$ref": "#/definitions/framework-search-filter-group" + sort_orders: + type: array + description: Sort order. + items: + "$ref": "#/definitions/framework-sort-order" + page_size: + type: integer + description: Page size. + current_page: + type: integer + description: Current page. + required: + - filter_groups + framework-search-filter-group: + type: object + description: Groups two or more filters together using a logical OR + properties: + filters: + type: array + description: A list of filters in this group + items: + "$ref": "#/definitions/framework-filter" + framework-filter: + type: object + description: Filter which can be used by any methods from service layer. + properties: + field: + type: string + description: Field + value: + type: string + description: Value + condition_type: + type: string + description: Condition type + required: + - field + - value + framework-sort-order: + type: object + description: Data object for sort order. + properties: + field: + type: string + description: Sorting field. + direction: + type: string + description: Sorting direction. + required: + - field + - direction + adobe-io-events-client-configuration-check-result-interface: + type: object + description: Contains configuration status for each necessary config setting + properties: + status: + type: string + description: Ok/error status of the configuration + technical_service_account_configured: + type: boolean + description: The technical service account is configured + technical_service_account_can_connect_to_io_events: + type: boolean + description: Providers are configured to allow the service account to connect + provider_id_configured: + type: string + description: The provider id if configured + provider_id_valid: + type: boolean + description: A configured provider id is valid + required: + - status + - technical_service_account_configured + - technical_service_account_can_connect_to_io_events + - provider_id_configured + - provider_id_valid + customer-data-group-interface: + type: object + description: Customer group interface. + properties: + id: + type: integer + description: Id + code: + type: string + description: Code + tax_class_id: + type: integer + description: Tax class id + tax_class_name: + type: string + description: Tax class name + extension_attributes: + "$ref": "#/definitions/customer-data-group-extension-interface" + required: + - code + - tax_class_id + customer-data-group-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Customer\Api\Data\GroupInterface + properties: + exclude_website_ids: + type: array + items: + type: integer + customer-data-group-search-results-interface: + type: object + description: Interface for customer groups search results. + properties: + items: + type: array + description: Customer groups list. + items: + "$ref": "#/definitions/customer-data-group-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + customer-data-attribute-metadata-interface: + type: object + description: Customer attribute metadata interface. + properties: + frontend_input: + type: string + description: HTML for input element. + input_filter: + type: string + description: Template used for input (e.g. "date") + store_label: + type: string + description: Label of the store. + validation_rules: + type: array + description: Validation rules. + items: + "$ref": "#/definitions/customer-data-validation-rule-interface" + multiline_count: + type: integer + description: Of lines of the attribute value. + visible: + type: boolean + description: Attribute is visible on frontend. + required: + type: boolean + description: Attribute is required. + data_model: + type: string + description: Data model for attribute. + options: + type: array + description: Options of the attribute (key => value pairs for select) + items: + "$ref": "#/definitions/customer-data-option-interface" + frontend_class: + type: string + description: Class which is used to display the attribute on frontend. + user_defined: + type: boolean + description: Current attribute has been defined by a user. + sort_order: + type: integer + description: Attributes sort order. + frontend_label: + type: string + description: Label which supposed to be displayed on frontend. + note: + type: string + description: The note attribute for the element. + system: + type: boolean + description: This is a system attribute. + backend_type: + type: string + description: Backend type. + is_used_in_grid: + type: boolean + description: It is used in customer grid + is_visible_in_grid: + type: boolean + description: It is visible in customer grid + is_filterable_in_grid: + type: boolean + description: It is filterable in customer grid + is_searchable_in_grid: + type: boolean + description: It is searchable in customer grid + attribute_code: + type: string + description: Code of the attribute. + required: + - frontend_input + - input_filter + - store_label + - validation_rules + - multiline_count + - visible + - required + - data_model + - options + - frontend_class + - user_defined + - sort_order + - frontend_label + - note + - system + - backend_type + - attribute_code + customer-data-validation-rule-interface: + type: object + description: Validation rule interface. + properties: + name: + type: string + description: Validation rule name + value: + type: string + description: Validation rule value + required: + - name + - value + customer-data-option-interface: + type: object + description: Option interface. + properties: + label: + type: string + description: Option label + value: + type: string + description: Option value + options: + type: array + description: Nested options + items: + "$ref": "#/definitions/customer-data-option-interface" + required: + - label + customer-data-customer-interface: + type: object + description: Customer entity interface for API handling. + properties: + id: + type: integer + description: Customer id + group_id: + type: integer + description: Group id + default_billing: + type: string + description: Default billing address id + default_shipping: + type: string + description: Default shipping address id + confirmation: + type: string + description: Confirmation + created_at: + type: string + description: Created at time + updated_at: + type: string + description: Updated at time + created_in: + type: string + description: Created in area + dob: + type: string + description: In keeping with current security and privacy best practices, + be sure you are aware of any potential legal and security risks associated + with the storage of customers’ full date of birth (month, day, year) along + with other personal identifiers (e.g., full name) before collecting or processing + such data. + email: + type: string + description: Email address + firstname: + type: string + description: First name + lastname: + type: string + description: Last name + middlename: + type: string + description: Middle name + prefix: + type: string + description: Prefix + suffix: + type: string + description: Suffix + gender: + type: integer + description: Gender + store_id: + type: integer + description: Store id + taxvat: + type: string + description: Tax Vat + website_id: + type: integer + description: Website id + addresses: + type: array + description: Customer addresses. + items: + "$ref": "#/definitions/customer-data-address-interface" + disable_auto_group_change: + type: integer + description: Disable auto group change flag. + extension_attributes: + "$ref": "#/definitions/customer-data-customer-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + required: + - email + - firstname + - lastname + customer-data-address-interface: + type: object + description: Customer address interface. + properties: + id: + type: integer + description: ID + customer_id: + type: integer + description: Customer ID + region: + "$ref": "#/definitions/customer-data-region-interface" + region_id: + type: integer + description: Region ID + country_id: + type: string + description: Country code in ISO_3166-2 format + street: + type: array + description: Street + items: + type: string + company: + type: string + description: Company + telephone: + type: string + description: Telephone number + fax: + type: string + description: Fax number + postcode: + type: string + description: Postcode + city: + type: string + description: City name + firstname: + type: string + description: First name + lastname: + type: string + description: Last name + middlename: + type: string + description: Middle name + prefix: + type: string + description: Prefix + suffix: + type: string + description: Suffix + vat_id: + type: string + description: Vat id + default_shipping: + type: boolean + description: If this address is default shipping address. + default_billing: + type: boolean + description: If this address is default billing address + extension_attributes: + "$ref": "#/definitions/customer-data-address-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + customer-data-region-interface: + type: object + description: Customer address region interface. + properties: + region_code: + type: string + description: Region code + region: + type: string + description: Region + region_id: + type: integer + description: Region id + extension_attributes: + "$ref": "#/definitions/customer-data-region-extension-interface" + required: + - region_code + - region + - region_id + customer-data-region-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Customer\Api\Data\RegionInterface + customer-data-address-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Customer\Api\Data\AddressInterface + framework-attribute-interface: + type: object + description: Interface for custom attribute value. + properties: + attribute_code: + type: string + description: Attribute code + value: + type: string + description: Attribute value + required: + - attribute_code + - value + customer-data-customer-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Customer\Api\Data\CustomerInterface + properties: + company_attributes: + "$ref": "#/definitions/company-data-company-customer-interface" + all_company_attributes: + type: array + items: + "$ref": "#/definitions/company-data-company-customer-interface" + is_subscribed: + type: boolean + assistance_allowed: + type: integer + company-data-company-customer-interface: + type: object + description: Extended customer custom attributes interface. + properties: + customer_id: + type: integer + description: Customer ID. + company_id: + type: integer + description: Company ID. + job_title: + type: string + description: Job title. + status: + type: integer + description: Customer status. + telephone: + type: string + description: Telephone. + is_default: + type: boolean + description: Is default + extension_attributes: + "$ref": "#/definitions/company-data-company-customer-extension-interface" + company-data-company-customer-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyCustomerInterface + customer-data-customer-search-results-interface: + type: object + description: Interface for customer search results. + properties: + items: + type: array + description: Customers list. + items: + "$ref": "#/definitions/customer-data-customer-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + customer-data-validation-results-interface: + type: object + description: Validation results interface. + properties: + valid: + type: boolean + description: If the provided data is valid. + messages: + type: array + description: Error messages as array in case of validation failure, else return + empty array. + items: + type: string + required: + - valid + - messages + adobe-commerce-events-client-data-event-data-interface: + type: object + description: Interface for event data from webapi requests + properties: + name: + type: string + description: Event name + parent: + type: string + description: Event parent name + fields: + type: array + description: Event fields + items: + "$ref": "#/definitions/adobe-commerce-events-client-data-event-field-interface" + rules: + type: array + description: Event fields + items: + "$ref": "#/definitions/adobe-commerce-events-client-data-event-rule-interface" + destination: + type: string + description: Event destination + priority: + type: boolean + description: Event priority + hipaa_audit_required: + type: boolean + description: If event is required to be HIPAA audited + provider_id: + type: string + description: Event provider id + required: + - name + - parent + - fields + - rules + - destination + - priority + - hipaa_audit_required + - provider_id + adobe-commerce-events-client-data-event-field-interface: + type: object + description: Interface for event field data from webapi requests + properties: + name: + type: string + description: Event field name + converter: + type: string + description: Event field converter + source: + type: string + description: Event field source + required: + - name + - converter + - source + adobe-commerce-events-client-data-event-rule-interface: + type: object + description: Interface for event rule data from webapi requests + properties: + field: + type: string + description: Event rule field name + operator: + type: string + description: Event rule operator + value: + type: string + description: Event rule value + required: + - field + - operator + - value + adobe-commerce-events-client-data-configuration-interface: + type: object + description: Eventing configuration + properties: + enabled: + type: boolean + description: If is enabled + merchant_id: + type: string + description: Merchant id + environment_id: + type: string + description: Environment id + provider_id: + type: string + description: Provider id + instance_id: + type: string + description: Instance id + workspace_configuration: + type: string + description: Workspace configuration + required: + - enabled + - merchant_id + - environment_id + - provider_id + - instance_id + - workspace_configuration + adobe-commerce-events-client-data-event-provider-interface: + type: object + description: Interface for event provider + properties: + id: + type: integer + description: ID of the event provider record + provider_id: + type: string + description: Event provider id + instance_id: + type: string + description: Event provider instance id + label: + type: string + description: Event provider label + description: + type: string + description: Event provider description + workspace_configuration: + type: string + description: Event provider workspace configuration + required: + - provider_id + - instance_id + - label + - description + - workspace_configuration + framework-search-search-result-interface: + type: object + description: Interface SearchResultInterface + properties: + items: + type: array + items: + "$ref": "#/definitions/framework-search-document-interface" + aggregations: + "$ref": "#/definitions/framework-search-aggregation-interface" + search_criteria: + "$ref": "#/definitions/framework-search-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - aggregations + - search_criteria + - total_count + framework-search-document-interface: + type: object + description: Interface Search Document + properties: + id: + type: integer + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + required: + - id + framework-search-aggregation-interface: + type: object + description: Interface Aggregation to get faceted data + properties: + buckets: + type: array + description: All Document fields + items: + "$ref": "#/definitions/framework-search-bucket-interface" + bucket_names: + type: array + description: Document field names + items: + type: string + required: + - buckets + - bucket_names + framework-search-bucket-interface: + type: object + description: Interface for facet Bucket + properties: + name: + type: string + description: Field name + values: + type: array + description: Field values + items: + "$ref": "#/definitions/framework-search-aggregation-value-interface" + required: + - name + - values + framework-search-aggregation-value-interface: + type: object + description: Interface Aggregation Value + properties: + value: + type: string + description: Aggregation + metrics: + type: array + description: Metrics + items: + type: string + required: + - value + - metrics + framework-search-search-criteria-interface: + type: object + description: Interface SearchCriteriaInterface + properties: + request_name: + type: string + filter_groups: + type: array + description: A list of filter groups. + items: + "$ref": "#/definitions/framework-search-filter-group" + sort_orders: + type: array + description: Sort order. + items: + "$ref": "#/definitions/framework-sort-order" + page_size: + type: integer + description: Page size. + current_page: + type: integer + description: Current page. + required: + - request_name + - filter_groups + cms-data-page-interface: + type: object + description: CMS page interface. + properties: + id: + type: integer + description: ID + identifier: + type: string + description: Identifier + title: + type: string + description: Title + page_layout: + type: string + description: Page layout + meta_title: + type: string + description: Meta title + meta_keywords: + type: string + description: Meta keywords + meta_description: + type: string + description: Meta description + content_heading: + type: string + description: Content heading + content: + type: string + description: Content + creation_time: + type: string + description: Creation time + update_time: + type: string + description: Update time + sort_order: + type: string + description: Sort order + layout_update_xml: + type: string + description: Layout update xml + custom_theme: + type: string + description: Custom theme + custom_root_template: + type: string + description: Custom root template + custom_layout_update_xml: + type: string + description: Custom layout update xml + custom_theme_from: + type: string + description: Custom theme from + custom_theme_to: + type: string + description: Custom theme to + active: + type: boolean + description: Active + required: + - identifier + cms-data-page-search-results-interface: + type: object + description: Interface for cms page search results. + properties: + items: + type: array + description: Pages list. + items: + "$ref": "#/definitions/cms-data-page-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + cms-data-block-interface: + type: object + description: CMS block interface. + properties: + id: + type: integer + description: ID + identifier: + type: string + description: Identifier + title: + type: string + description: Title + content: + type: string + description: Content + creation_time: + type: string + description: Creation time + update_time: + type: string + description: Update time + active: + type: boolean + description: Active + required: + - identifier + cms-data-block-search-results-interface: + type: object + description: Interface for cms block search results. + properties: + items: + type: array + description: Blocks list. + items: + "$ref": "#/definitions/cms-data-block-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + catalog-data-product-interface: + type: object + description: '' + properties: + id: + type: integer + description: Id + sku: + type: string + description: Sku + name: + type: string + description: Name + attribute_set_id: + type: integer + description: Attribute set id + price: + type: number + description: Price + status: + type: integer + description: Status + visibility: + type: integer + description: Visibility + type_id: + type: string + description: Type id + created_at: + type: string + description: Created date + updated_at: + type: string + description: Updated date + weight: + type: number + description: Weight + extension_attributes: + "$ref": "#/definitions/catalog-data-product-extension-interface" + product_links: + type: array + description: Product links info + items: + "$ref": "#/definitions/catalog-data-product-link-interface" + options: + type: array + description: List of product options + items: + "$ref": "#/definitions/catalog-data-product-custom-option-interface" + media_gallery_entries: + type: array + description: Media gallery entries + items: + "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface" + tier_prices: + type: array + description: List of product tier prices + items: + "$ref": "#/definitions/catalog-data-product-tier-price-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + required: + - sku + catalog-data-product-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductInterface + properties: + website_ids: + type: array + items: + type: integer + category_links: + type: array + items: + "$ref": "#/definitions/catalog-data-category-link-interface" + stock_item: + "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" + discounts: + type: array + items: + "$ref": "#/definitions/sales-rule-data-rule-discount-interface" + bundle_product_options: + type: array + items: + "$ref": "#/definitions/bundle-data-option-interface" + downloadable_product_links: + type: array + items: + "$ref": "#/definitions/downloadable-data-link-interface" + downloadable_product_samples: + type: array + items: + "$ref": "#/definitions/downloadable-data-sample-interface" + giftcard_amounts: + type: array + items: + "$ref": "#/definitions/gift-card-data-giftcard-amount-interface" + configurable_product_options: + type: array + items: + "$ref": "#/definitions/configurable-product-data-option-interface" + configurable_product_links: + type: array + items: + type: integer + catalog-data-category-link-interface: + type: object + description: '' + properties: + position: + type: integer + category_id: + type: string + description: Category id + extension_attributes: + "$ref": "#/definitions/catalog-data-category-link-extension-interface" + required: + - category_id + catalog-data-category-link-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CategoryLinkInterface + catalog-inventory-data-stock-item-interface: + type: object + description: Interface StockItem + properties: + item_id: + type: integer + product_id: + type: integer + stock_id: + type: integer + description: Stock identifier + qty: + type: number + is_in_stock: + type: boolean + description: Stock Availability + is_qty_decimal: + type: boolean + show_default_notification_message: + type: boolean + use_config_min_qty: + type: boolean + min_qty: + type: number + description: Minimal quantity available for item status in stock + use_config_min_sale_qty: + type: integer + min_sale_qty: + type: number + description: Minimum Qty Allowed in Shopping Cart or NULL when there is no + limitation + use_config_max_sale_qty: + type: boolean + max_sale_qty: + type: number + description: Maximum Qty Allowed in Shopping Cart data wrapper + use_config_backorders: + type: boolean + backorders: + type: integer + description: Backorders status + use_config_notify_stock_qty: + type: boolean + notify_stock_qty: + type: number + description: Notify for Quantity Below data wrapper + use_config_qty_increments: + type: boolean + qty_increments: + type: number + description: Quantity Increments data wrapper + use_config_enable_qty_inc: + type: boolean + enable_qty_increments: + type: boolean + description: Whether Quantity Increments is enabled + use_config_manage_stock: + type: boolean + manage_stock: + type: boolean + description: Can Manage Stock + low_stock_date: + type: string + is_decimal_divided: + type: boolean + stock_status_changed_auto: + type: integer + extension_attributes: + "$ref": "#/definitions/catalog-inventory-data-stock-item-extension-interface" + required: + - qty + - is_in_stock + - is_qty_decimal + - show_default_notification_message + - use_config_min_qty + - min_qty + - use_config_min_sale_qty + - min_sale_qty + - use_config_max_sale_qty + - max_sale_qty + - use_config_backorders + - backorders + - use_config_notify_stock_qty + - notify_stock_qty + - use_config_qty_increments + - qty_increments + - use_config_enable_qty_inc + - enable_qty_increments + - use_config_manage_stock + - manage_stock + - low_stock_date + - is_decimal_divided + - stock_status_changed_auto + catalog-inventory-data-stock-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\CatalogInventory\Api\Data\StockItemInterface + sales-rule-data-rule-discount-interface: + type: object + description: Rule discount Interface + properties: + discount_data: + "$ref": "#/definitions/sales-rule-data-discount-data-interface" + rule_label: + type: string + description: Rule Label + rule_i_d: + type: integer + description: Rule ID + required: + - discount_data + - rule_label + - rule_i_d + sales-rule-data-discount-data-interface: + type: object + description: Discount Data Interface + properties: + amount: + type: number + description: Amount + base_amount: + type: number + description: Base Amount + original_amount: + type: number + description: Original Amount + base_original_amount: + type: number + description: Base Original Amount + required: + - amount + - base_amount + - original_amount + - base_original_amount + bundle-data-option-interface: + type: object + description: Interface OptionInterface + properties: + option_id: + type: integer + description: Option id + title: + type: string + description: Option title + required: + type: boolean + description: Is required option + type: + type: string + description: Input type + position: + type: integer + description: Option position + sku: + type: string + description: Product sku + product_links: + type: array + description: Product links + items: + "$ref": "#/definitions/bundle-data-link-interface" + extension_attributes: + "$ref": "#/definitions/bundle-data-option-extension-interface" + bundle-data-link-interface: + type: object + description: Interface LinkInterface + properties: + id: + type: string + description: The identifier + sku: + type: string + description: Linked product sku + option_id: + type: integer + description: Option id + qty: + type: number + description: Qty + position: + type: integer + description: Position + is_default: + type: boolean + description: Is default + price: + type: number + description: Price + price_type: + type: integer + description: Price type + can_change_quantity: + type: integer + description: Whether quantity could be changed + extension_attributes: + "$ref": "#/definitions/bundle-data-link-extension-interface" + required: + - is_default + - price + - price_type + bundle-data-link-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\LinkInterface + bundle-data-option-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\OptionInterface + downloadable-data-link-interface: + type: object + description: '' + properties: + id: + type: integer + description: Sample(or link) id + title: + type: string + sort_order: + type: integer + is_shareable: + type: integer + description: Shareable status + price: + type: number + description: Price + number_of_downloads: + type: integer + description: Of downloads per user + link_type: + type: string + link_file: + type: string + description: relative file path + link_file_content: + "$ref": "#/definitions/downloadable-data-file-content-interface" + link_url: + type: string + description: Link url or null when type is 'file' + sample_type: + type: string + sample_file: + type: string + description: relative file path + sample_file_content: + "$ref": "#/definitions/downloadable-data-file-content-interface" + sample_url: + type: string + description: file URL + extension_attributes: + "$ref": "#/definitions/downloadable-data-link-extension-interface" + required: + - sort_order + - is_shareable + - price + - link_type + - sample_type + downloadable-data-file-content-interface: + type: object + description: '' + properties: + file_data: + type: string + description: Data (base64 encoded content) + name: + type: string + description: File name + extension_attributes: + "$ref": "#/definitions/downloadable-data-file-content-extension-interface" + required: + - file_data + - name + downloadable-data-file-content-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Downloadable\Api\Data\File\ContentInterface + downloadable-data-link-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Downloadable\Api\Data\LinkInterface + downloadable-data-sample-interface: + type: object + description: '' + properties: + id: + type: integer + description: Sample(or link) id + title: + type: string + description: Title + sort_order: + type: integer + description: Order index for sample + sample_type: + type: string + sample_file: + type: string + description: relative file path + sample_file_content: + "$ref": "#/definitions/downloadable-data-file-content-interface" + sample_url: + type: string + description: file URL + extension_attributes: + "$ref": "#/definitions/downloadable-data-sample-extension-interface" + required: + - title + - sort_order + - sample_type + downloadable-data-sample-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Downloadable\Api\Data\SampleInterface + gift-card-data-giftcard-amount-interface: + type: object + description: 'Interface GiftcardAmountInterface: this interface is used to serialize + and deserialize EAV attribute giftcard_amounts' + properties: + attribute_id: + type: integer + description: AttributeId + website_id: + type: integer + description: WebsiteId + value: + type: number + description: Value + website_value: + type: number + description: WebsiteValue + extension_attributes: + "$ref": "#/definitions/gift-card-data-giftcard-amount-extension-interface" + required: + - attribute_id + - website_id + - value + - website_value + gift-card-data-giftcard-amount-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftcardAmountInterface + configurable-product-data-option-interface: + type: object + description: Interface OptionInterface + properties: + id: + type: integer + attribute_id: + type: string + label: + type: string + position: + type: integer + is_use_default: + type: boolean + values: + type: array + items: + "$ref": "#/definitions/configurable-product-data-option-value-interface" + extension_attributes: + "$ref": "#/definitions/configurable-product-data-option-extension-interface" + product_id: + type: integer + configurable-product-data-option-value-interface: + type: object + description: Interface OptionValueInterface + properties: + value_index: + type: integer + extension_attributes: + "$ref": "#/definitions/configurable-product-data-option-value-extension-interface" + required: + - value_index + configurable-product-data-option-value-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\OptionValueInterface + configurable-product-data-option-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\OptionInterface + catalog-data-product-link-interface: + type: object + description: '' + properties: + sku: + type: string + description: SKU + link_type: + type: string + description: Link type + linked_product_sku: + type: string + description: Linked product sku + linked_product_type: + type: string + description: Linked product type (simple, virtual, etc) + position: + type: integer + description: Linked item position + extension_attributes: + "$ref": "#/definitions/catalog-data-product-link-extension-interface" + required: + - sku + - link_type + - linked_product_sku + - linked_product_type + - position + catalog-data-product-link-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductLinkInterface + properties: + qty: + type: number + catalog-data-product-custom-option-interface: + type: object + description: '' + properties: + product_sku: + type: string + description: Product SKU + option_id: + type: integer + description: Option id + title: + type: string + description: Option title + type: + type: string + description: Option type + sort_order: + type: integer + description: Sort order + is_require: + type: boolean + description: Is require + price: + type: number + description: Price + price_type: + type: string + description: Price type + sku: + type: string + description: Sku + file_extension: + type: string + description: File extension + max_characters: + type: integer + description: Max characters + image_size_x: + type: integer + description: Image x size + image_size_y: + type: integer + description: Image Y size + values: + type: array + description: Values + items: + "$ref": "#/definitions/catalog-data-product-custom-option-values-interface" + extension_attributes: + "$ref": "#/definitions/catalog-data-product-custom-option-extension-interface" + required: + - product_sku + - title + - type + - sort_order + - is_require + catalog-data-product-custom-option-values-interface: + type: object + description: '' + properties: + title: + type: string + description: Option title + sort_order: + type: integer + description: Sort order + price: + type: number + description: Price + price_type: + type: string + description: Price type + sku: + type: string + description: Sku + option_type_id: + type: integer + description: Option type id + required: + - title + - sort_order + - price + - price_type + catalog-data-product-custom-option-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductCustomOptionInterface + catalog-data-product-attribute-media-gallery-entry-interface: + type: object + description: '' + properties: + id: + type: integer + description: Gallery entry ID + media_type: + type: string + description: Media type + label: + type: string + description: Gallery entry alternative text + position: + type: integer + description: Gallery entry position (sort order) + disabled: + type: boolean + description: If gallery entry is hidden from product page + types: + type: array + description: Gallery entry image types (thumbnail, image, small_image etc) + items: + type: string + file: + type: string + description: File path + content: + "$ref": "#/definitions/framework-data-image-content-interface" + extension_attributes: + "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-extension-interface" + required: + - media_type + - label + - position + - disabled + - types + framework-data-image-content-interface: + type: object + description: Image Content data interface + properties: + base64_encoded_data: + type: string + description: Media data (base64 encoded content) + type: + type: string + description: MIME type + name: + type: string + description: Image name + required: + - base64_encoded_data + - type + - name + catalog-data-product-attribute-media-gallery-entry-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductAttributeMediaGalleryEntryInterface + properties: + video_content: + "$ref": "#/definitions/framework-data-video-content-interface" + framework-data-video-content-interface: + type: object + description: Video Content data interface + properties: + media_type: + type: string + description: MIME type + video_provider: + type: string + description: Provider + video_url: + type: string + description: Video URL + video_title: + type: string + description: Title + video_description: + type: string + description: Video Description + video_metadata: + type: string + description: Metadata + required: + - media_type + - video_provider + - video_url + - video_title + - video_description + - video_metadata + catalog-data-product-tier-price-interface: + type: object + description: '' + properties: + customer_group_id: + type: integer + description: Customer group id + qty: + type: number + description: Tier qty + value: + type: number + description: Price value + extension_attributes: + "$ref": "#/definitions/catalog-data-product-tier-price-extension-interface" + required: + - customer_group_id + - qty + - value + catalog-data-product-tier-price-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductTierPriceInterface + properties: + percentage_value: + type: number + website_id: + type: integer + catalog-data-product-search-results-interface: + type: object + description: '' + properties: + items: + type: array + description: Attributes list. + items: + "$ref": "#/definitions/catalog-data-product-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + catalog-data-product-attribute-type-interface: + type: object + description: '' + properties: + value: + type: string + description: Value + label: + type: string + description: Type label + extension_attributes: + "$ref": "#/definitions/catalog-data-product-attribute-type-extension-interface" + required: + - value + - label + catalog-data-product-attribute-type-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductAttributeTypeInterface + catalog-data-product-attribute-interface: + type: object + description: '' + properties: + extension_attributes: + "$ref": "#/definitions/eav-data-attribute-extension-interface" + is_wysiwyg_enabled: + type: boolean + description: WYSIWYG flag + is_html_allowed_on_front: + type: boolean + description: The HTML tags are allowed on the frontend + used_for_sort_by: + type: boolean + description: It is used for sorting in product listing + is_filterable: + type: boolean + description: It used in layered navigation + is_filterable_in_search: + type: boolean + description: It is used in search results layered navigation + is_used_in_grid: + type: boolean + description: It is used in catalog product grid + is_visible_in_grid: + type: boolean + description: It is visible in catalog product grid + is_filterable_in_grid: + type: boolean + description: It is filterable in catalog product grid + position: + type: integer + description: Position + apply_to: + type: array + description: Apply to value for the element + items: + type: string + is_searchable: + type: string + description: The attribute can be used in Quick Search + is_visible_in_advanced_search: + type: string + description: The attribute can be used in Advanced Search + is_comparable: + type: string + description: The attribute can be compared on the frontend + is_used_for_promo_rules: + type: string + description: The attribute can be used for promo rules + is_visible_on_front: + type: string + description: The attribute is visible on the frontend + used_in_product_listing: + type: string + description: The attribute can be used in product listing + is_visible: + type: boolean + description: Attribute is visible on frontend. + scope: + type: string + description: Attribute scope + attribute_id: + type: integer + description: Id of the attribute. + attribute_code: + type: string + description: Code of the attribute. + frontend_input: + type: string + description: HTML for input element. + entity_type_id: + type: string + description: Entity type id + is_required: + type: boolean + description: Attribute is required. + options: + type: array + description: Options of the attribute (key => value pairs for select) + items: + "$ref": "#/definitions/eav-data-attribute-option-interface" + is_user_defined: + type: boolean + description: Current attribute has been defined by a user. + default_frontend_label: + type: string + description: Frontend label for default store + frontend_labels: + type: array + description: Frontend label for each store + items: + "$ref": "#/definitions/eav-data-attribute-frontend-label-interface" + note: + type: string + description: The note attribute for the element. + backend_type: + type: string + description: Backend type. + backend_model: + type: string + description: Backend model + source_model: + type: string + description: Source model + default_value: + type: string + description: Default value for the element. + is_unique: + type: string + description: This is a unique attribute + frontend_class: + type: string + description: Frontend class of attribute + validation_rules: + type: array + description: Validation rules. + items: + "$ref": "#/definitions/eav-data-attribute-validation-rule-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + required: + - attribute_code + - frontend_input + - entity_type_id + - is_required + - frontend_labels + eav-data-attribute-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Eav\Api\Data\AttributeInterface + properties: + is_pagebuilder_enabled: + type: boolean + eav-data-attribute-option-interface: + type: object + description: 'Created from:' + properties: + label: + type: string + description: Option label + value: + type: string + description: Option value + sort_order: + type: integer + description: Option order + is_default: + type: boolean + description: Default + store_labels: + type: array + description: Option label for store scopes + items: + "$ref": "#/definitions/eav-data-attribute-option-label-interface" + required: + - label + - value + eav-data-attribute-option-label-interface: + type: object + description: Interface AttributeOptionLabelInterface + properties: + store_id: + type: integer + description: Store id + label: + type: string + description: Option label + eav-data-attribute-frontend-label-interface: + type: object + description: Interface AttributeFrontendLabelInterface + properties: + store_id: + type: integer + description: Store id + label: + type: string + description: Option label + eav-data-attribute-validation-rule-interface: + type: object + description: Interface AttributeValidationRuleInterface + properties: + key: + type: string + description: Object key + value: + type: string + description: Object value + required: + - key + - value + catalog-data-product-attribute-search-results-interface: + type: object + description: '' + properties: + items: + type: array + description: Attributes list. + items: + "$ref": "#/definitions/catalog-data-product-attribute-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + catalog-data-category-attribute-interface: + type: object + description: '' + properties: + is_wysiwyg_enabled: + type: boolean + description: WYSIWYG flag + is_html_allowed_on_front: + type: boolean + description: The HTML tags are allowed on the frontend + used_for_sort_by: + type: boolean + description: It is used for sorting in product listing + is_filterable: + type: boolean + description: It used in layered navigation + is_filterable_in_search: + type: boolean + description: It is used in search results layered navigation + is_used_in_grid: + type: boolean + description: It is used in catalog product grid + is_visible_in_grid: + type: boolean + description: It is visible in catalog product grid + is_filterable_in_grid: + type: boolean + description: It is filterable in catalog product grid + position: + type: integer + description: Position + apply_to: + type: array + description: Apply to value for the element + items: + type: string + is_searchable: + type: string + description: The attribute can be used in Quick Search + is_visible_in_advanced_search: + type: string + description: The attribute can be used in Advanced Search + is_comparable: + type: string + description: The attribute can be compared on the frontend + is_used_for_promo_rules: + type: string + description: The attribute can be used for promo rules + is_visible_on_front: + type: string + description: The attribute is visible on the frontend + used_in_product_listing: + type: string + description: The attribute can be used in product listing + is_visible: + type: boolean + description: Attribute is visible on frontend. + scope: + type: string + description: Attribute scope + extension_attributes: + "$ref": "#/definitions/catalog-data-eav-attribute-extension-interface" + attribute_id: + type: integer + description: Id of the attribute. + attribute_code: + type: string + description: Code of the attribute. + frontend_input: + type: string + description: HTML for input element. + entity_type_id: + type: string + description: Entity type id + is_required: + type: boolean + description: Attribute is required. + options: + type: array + description: Options of the attribute (key => value pairs for select) + items: + "$ref": "#/definitions/eav-data-attribute-option-interface" + is_user_defined: + type: boolean + description: Current attribute has been defined by a user. + default_frontend_label: + type: string + description: Frontend label for default store + frontend_labels: + type: array + description: Frontend label for each store + items: + "$ref": "#/definitions/eav-data-attribute-frontend-label-interface" + note: + type: string + description: The note attribute for the element. + backend_type: + type: string + description: Backend type. + backend_model: + type: string + description: Backend model + source_model: + type: string + description: Source model + default_value: + type: string + description: Default value for the element. + is_unique: + type: string + description: This is a unique attribute + frontend_class: + type: string + description: Frontend class of attribute + validation_rules: + type: array + description: Validation rules. + items: + "$ref": "#/definitions/eav-data-attribute-validation-rule-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + required: + - attribute_code + - frontend_input + - entity_type_id + - is_required + - frontend_labels + catalog-data-eav-attribute-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\EavAttributeInterface + catalog-data-category-attribute-search-results-interface: + type: object + description: '' + properties: + items: + type: array + description: Attributes list. + items: + "$ref": "#/definitions/catalog-data-category-attribute-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + catalog-data-product-type-interface: + type: object + description: Product type details + properties: + name: + type: string + description: Product type code + label: + type: string + description: Product type label + extension_attributes: + "$ref": "#/definitions/catalog-data-product-type-extension-interface" + required: + - name + - label + catalog-data-product-type-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductTypeInterface + eav-data-attribute-group-search-results-interface: + type: object + description: Interface AttributeGroupSearchResultsInterface + properties: + items: + type: array + description: Attribute sets list. + items: + "$ref": "#/definitions/eav-data-attribute-group-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + eav-data-attribute-group-interface: + type: object + description: Interface AttributeGroupInterface + properties: + attribute_group_id: + type: string + description: Id + attribute_group_name: + type: string + description: Name + attribute_set_id: + type: integer + description: Attribute set id + extension_attributes: + "$ref": "#/definitions/eav-data-attribute-group-extension-interface" + eav-data-attribute-group-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Eav\Api\Data\AttributeGroupInterface + properties: + attribute_group_code: + type: string + sort_order: + type: string + catalog-data-tier-price-interface: + type: object + description: Tier price interface. + properties: + price: + type: number + description: Tier price. + price_type: + type: string + description: Tier price type. + website_id: + type: integer + description: Website id. + sku: + type: string + description: SKU. + customer_group: + type: string + description: Customer group. + quantity: + type: number + description: Quantity. + extension_attributes: + "$ref": "#/definitions/catalog-data-tier-price-extension-interface" + required: + - price + - price_type + - website_id + - sku + - customer_group + - quantity + catalog-data-tier-price-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\TierPriceInterface + catalog-data-price-update-result-interface: + type: object + description: Interface returned in case of incorrect price passed to efficient + price API. + properties: + message: + type: string + description: Error message, that contains description of error occurred during + price update. + parameters: + type: array + description: Parameters, that could be displayed in error message placeholders. + items: + type: string + extension_attributes: + "$ref": "#/definitions/catalog-data-price-update-result-extension-interface" + required: + - message + - parameters + catalog-data-price-update-result-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\PriceUpdateResultInterface + catalog-data-base-price-interface: + type: object + description: Price interface. + properties: + price: + type: number + description: Price. + store_id: + type: integer + description: Store id. + sku: + type: string + description: SKU. + extension_attributes: + "$ref": "#/definitions/catalog-data-base-price-extension-interface" + required: + - price + - store_id + - sku + catalog-data-base-price-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\BasePriceInterface + catalog-data-cost-interface: + type: object + description: Cost interface. + properties: + cost: + type: number + description: Cost value. + store_id: + type: integer + description: Store id. + sku: + type: string + description: SKU. + extension_attributes: + "$ref": "#/definitions/catalog-data-cost-extension-interface" + required: + - cost + - store_id + - sku + catalog-data-cost-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CostInterface + catalog-data-special-price-interface: + type: object + description: Product Special Price Interface is used to encapsulate data that + can be processed by efficient price API. + properties: + price: + type: number + description: Product special price value. + store_id: + type: integer + description: ID of store, that contains special price value. + sku: + type: string + description: SKU of product, that contains special price value. + price_from: + type: string + description: Start date for special price in Y-m-d H:i:s format. + price_to: + type: string + description: End date for special price in Y-m-d H:i:s format. + extension_attributes: + "$ref": "#/definitions/catalog-data-special-price-extension-interface" + required: + - price + - store_id + - sku + - price_from + - price_to + catalog-data-special-price-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\SpecialPriceInterface + catalog-data-category-interface: + type: object + description: Category data interface. + properties: + id: + type: integer + description: Category id. + parent_id: + type: integer + description: Parent category ID + name: + type: string + description: Category name + is_active: + type: boolean + description: Whether category is active + position: + type: integer + description: Category position + level: + type: integer + description: Category level + children: + type: string + description: Children ids comma separated. + created_at: + type: string + description: Category creation date and time. + updated_at: + type: string + description: Category last update date and time. + path: + type: string + description: Category full path. + available_sort_by: + type: array + description: Available sort by for category. + items: + type: string + include_in_menu: + type: boolean + description: Category is included in menu. + extension_attributes: + "$ref": "#/definitions/catalog-data-category-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + catalog-data-category-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CategoryInterface + catalog-data-category-tree-interface: + type: object + description: '' + properties: + id: + type: integer + description: Id + parent_id: + type: integer + description: Parent category ID + name: + type: string + description: Category name + is_active: + type: boolean + description: Whether category is active + position: + type: integer + description: Category position + level: + type: integer + description: Category level + product_count: + type: integer + description: Product count + children_data: + type: array + description: Children Data + items: + "$ref": "#/definitions/catalog-data-category-tree-interface" + required: + - parent_id + - name + - is_active + - position + - level + - product_count + - children_data + catalog-data-category-search-results-interface: + type: object + description: '' + properties: + items: + type: array + description: Categories + items: + "$ref": "#/definitions/catalog-data-category-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + catalog-data-product-custom-option-type-interface: + type: object + description: '' + properties: + label: + type: string + description: Option type label + code: + type: string + description: Option type code + group: + type: string + description: Option type group + extension_attributes: + "$ref": "#/definitions/catalog-data-product-custom-option-type-extension-interface" + required: + - label + - code + - group + catalog-data-product-custom-option-type-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductCustomOptionTypeInterface + catalog-data-product-link-type-interface: + type: object + description: '' + properties: + code: + type: integer + description: Link type code + name: + type: string + description: Link type name + extension_attributes: + "$ref": "#/definitions/catalog-data-product-link-type-extension-interface" + required: + - code + - name + catalog-data-product-link-type-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductLinkTypeInterface + catalog-data-product-link-attribute-interface: + type: object + description: '' + properties: + code: + type: string + description: Attribute code + type: + type: string + description: Attribute type + extension_attributes: + "$ref": "#/definitions/catalog-data-product-link-attribute-extension-interface" + required: + - code + - type + catalog-data-product-link-attribute-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductLinkAttributeInterface + catalog-data-category-product-link-interface: + type: object + description: '' + properties: + sku: + type: string + position: + type: integer + category_id: + type: string + description: Category id + extension_attributes: + "$ref": "#/definitions/catalog-data-category-product-link-extension-interface" + required: + - category_id + catalog-data-category-product-link-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CategoryProductLinkInterface + catalog-data-product-website-link-interface: + type: object + description: '' + properties: + sku: + type: string + website_id: + type: integer + description: Website ids + required: + - sku + - website_id + catalog-data-product-render-search-results-interface: + type: object + description: Dto that holds render information about products + properties: + items: + type: array + description: List of products rendered information + items: + "$ref": "#/definitions/catalog-data-product-render-interface" + required: + - items + catalog-data-product-render-interface: + type: object + description: Represents Data Object which holds enough information to render product + This information is put into part as Add To Cart or Add to Compare Data or Price + Data + properties: + add_to_cart_button: + "$ref": "#/definitions/catalog-data-product-render-button-interface" + add_to_compare_button: + "$ref": "#/definitions/catalog-data-product-render-button-interface" + price_info: + "$ref": "#/definitions/catalog-data-product-render-price-info-interface" + images: + type: array + description: Enough information, that needed to render image on front + items: + "$ref": "#/definitions/catalog-data-product-render-image-interface" + url: + type: string + description: Product url + id: + type: integer + description: Product identifier + name: + type: string + description: Product name + type: + type: string + description: Product type. Such as bundle, grouped, simple, etc... + is_salable: + type: string + description: Information about product saleability (In Stock) + store_id: + type: integer + description: Information about current store id or requested store id + currency_code: + type: string + description: Current or desired currency code to product + extension_attributes: + "$ref": "#/definitions/catalog-data-product-render-extension-interface" + required: + - add_to_cart_button + - add_to_compare_button + - price_info + - images + - url + - id + - name + - type + - is_salable + - store_id + - currency_code + - extension_attributes + catalog-data-product-render-button-interface: + type: object + description: 'Button interface. This interface represents all manner of product + buttons: add to cart, add to compare, etc... The buttons describes by this interface + should have interaction with backend' + properties: + post_data: + type: string + description: Post data + url: + type: string + description: Url, needed to add product to cart + required_options: + type: boolean + description: Flag whether a product has options or not + extension_attributes: + "$ref": "#/definitions/catalog-data-product-render-button-extension-interface" + required: + - post_data + - url + - required_options + catalog-data-product-render-button-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ButtonInterface + catalog-data-product-render-price-info-interface: + type: object + description: Price interface. + properties: + final_price: + type: number + description: Final price + max_price: + type: number + description: Max price of a product + max_regular_price: + type: number + description: Max regular price + minimal_regular_price: + type: number + description: Minimal regular price + special_price: + type: number + description: Special price + minimal_price: + type: number + description: Minimal price + regular_price: + type: number + description: Regular price + formatted_prices: + "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-interface" + extension_attributes: + "$ref": "#/definitions/catalog-data-product-render-price-info-extension-interface" + required: + - final_price + - max_price + - max_regular_price + - minimal_regular_price + - special_price + - minimal_price + - regular_price + - formatted_prices + catalog-data-product-render-formatted-price-info-interface: + type: object + description: 'Formatted Price interface. Aggregate formatted html with price representations. + E.g.: $9.00 Consider currency, rounding and html' + properties: + final_price: + type: string + description: Html with final price + max_price: + type: string + description: Max price of a product + minimal_price: + type: string + description: The minimal price of the product or variation + max_regular_price: + type: string + description: Max regular price + minimal_regular_price: + type: string + description: Minimal regular price + special_price: + type: string + description: Special price + regular_price: + type: string + description: Price - is price of product without discounts and special price + with taxes and fixed product tax + extension_attributes: + "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-extension-interface" + required: + - final_price + - max_price + - minimal_price + - max_regular_price + - minimal_regular_price + - special_price + - regular_price + catalog-data-product-render-formatted-price-info-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\FormattedPriceInfoInterface + catalog-data-product-render-price-info-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\PriceInfoInterface + properties: + msrp: + "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-interface" + tax_adjustments: + "$ref": "#/definitions/catalog-data-product-render-price-info-interface" + weee_attributes: + type: array + items: + "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-interface" + weee_adjustment: + type: string + msrp-data-product-render-msrp-price-info-interface: + type: object + description: Price interface. + properties: + msrp_price: + type: string + is_applicable: + type: string + is_shown_price_on_gesture: + type: string + msrp_message: + type: string + explanation_message: + type: string + extension_attributes: + "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-extension-interface" + required: + - msrp_price + - is_applicable + - is_shown_price_on_gesture + - msrp_message + - explanation_message + msrp-data-product-render-msrp-price-info-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Msrp\Api\Data\ProductRender\MsrpPriceInfoInterface + weee-data-product-render-weee-adjustment-attribute-interface: + type: object + description: List of all weee attributes, their amounts, etc.., that product has + properties: + amount: + type: string + description: Weee attribute amount + tax_amount: + type: string + description: Tax which is calculated to fixed product tax attribute + tax_amount_incl_tax: + type: string + description: Tax amount of weee attribute + amount_excl_tax: + type: string + description: Product amount exclude tax + attribute_code: + type: string + description: Weee attribute code + extension_attributes: + "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-extension-interface" + required: + - amount + - tax_amount + - tax_amount_incl_tax + - amount_excl_tax + - attribute_code + - extension_attributes + weee-data-product-render-weee-adjustment-attribute-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Weee\Api\Data\ProductRender\WeeeAdjustmentAttributeInterface + catalog-data-product-render-image-interface: + type: object + description: Product Render image interface. Represents physical characteristics + of image, that can be used in product listing or product view + properties: + url: + type: string + description: Image url + code: + type: string + description: Image code + height: + type: number + description: Image height + width: + type: number + description: Image width in px + label: + type: string + description: Image label + resized_width: + type: number + description: Resize width + resized_height: + type: number + description: Resize height + extension_attributes: + "$ref": "#/definitions/catalog-data-product-render-image-extension-interface" + required: + - url + - code + - height + - width + - label + - resized_width + - resized_height + catalog-data-product-render-image-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ImageInterface + catalog-data-product-render-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRenderInterface + properties: + wishlist_button: + "$ref": "#/definitions/catalog-data-product-render-button-interface" + review_html: + type: string + quote-data-cart-interface: + type: object + description: Interface CartInterface + properties: + id: + type: integer + description: Cart/quote ID. + created_at: + type: string + description: Cart creation date and time. Otherwise, null. + updated_at: + type: string + description: Cart last update date and time. Otherwise, null. + converted_at: + type: string + description: Cart conversion date and time. Otherwise, null. + is_active: + type: boolean + description: Active status flag value. Otherwise, null. + is_virtual: + type: boolean + description: Virtual flag value. Otherwise, null. + items: + type: array + description: Array of items. Otherwise, null. + items: + "$ref": "#/definitions/quote-data-cart-item-interface" + items_count: + type: integer + description: Number of different items or products in the cart. Otherwise, + null. + items_qty: + type: number + description: Total quantity of all cart items. Otherwise, null. + customer: + "$ref": "#/definitions/customer-data-customer-interface" + billing_address: + "$ref": "#/definitions/quote-data-address-interface" + reserved_order_id: + type: string + description: Reserved order ID. Otherwise, null. + orig_order_id: + type: integer + description: Original order ID. Otherwise, null. + currency: + "$ref": "#/definitions/quote-data-currency-interface" + customer_is_guest: + type: boolean + description: For guest customers, false for logged in customers + customer_note: + type: string + description: Notice text + customer_note_notify: + type: boolean + description: Customer notification flag + customer_tax_class_id: + type: integer + description: Customer tax class ID. + store_id: + type: integer + description: Store identifier + extension_attributes: + "$ref": "#/definitions/quote-data-cart-extension-interface" + required: + - id + - customer + - store_id + quote-data-cart-item-interface: + type: object + description: Interface CartItemInterface + properties: + item_id: + type: integer + description: Item ID. Otherwise, null. + sku: + type: string + description: Product SKU. Otherwise, null. + qty: + type: number + description: Product quantity. + name: + type: string + description: Product name. Otherwise, null. + price: + type: number + description: Product price. Otherwise, null. + product_type: + type: string + description: Product type. Otherwise, null. + quote_id: + type: string + description: Quote id. + product_option: + "$ref": "#/definitions/quote-data-product-option-interface" + extension_attributes: + "$ref": "#/definitions/quote-data-cart-item-extension-interface" + required: + - qty + - quote_id + quote-data-product-option-interface: + type: object + description: Product option interface + properties: + extension_attributes: + "$ref": "#/definitions/quote-data-product-option-extension-interface" + quote-data-product-option-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ProductOptionInterface + properties: + custom_options: + type: array + items: + "$ref": "#/definitions/catalog-data-custom-option-interface" + bundle_options: + type: array + items: + "$ref": "#/definitions/bundle-data-bundle-option-interface" + downloadable_option: + "$ref": "#/definitions/downloadable-data-downloadable-option-interface" + giftcard_item_option: + "$ref": "#/definitions/gift-card-data-gift-card-option-interface" + configurable_item_options: + type: array + items: + "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-interface" + grouped_options: + type: array + items: + "$ref": "#/definitions/grouped-product-data-grouped-options-interface" + catalog-data-custom-option-interface: + type: object + description: Interface CustomOptionInterface + properties: + option_id: + type: string + description: Option id + option_value: + type: string + description: Option value + extension_attributes: + "$ref": "#/definitions/catalog-data-custom-option-extension-interface" + required: + - option_id + - option_value + catalog-data-custom-option-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface + properties: + file_info: + "$ref": "#/definitions/framework-data-image-content-interface" + bundle-data-bundle-option-interface: + type: object + description: Interface BundleOptionInterface + properties: + option_id: + type: integer + description: Bundle option id. + option_qty: + type: integer + description: Bundle option quantity. + option_selections: + type: array + description: Bundle option selection ids. + items: + type: integer + extension_attributes: + "$ref": "#/definitions/bundle-data-bundle-option-extension-interface" + required: + - option_id + - option_qty + - option_selections + bundle-data-bundle-option-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface + downloadable-data-downloadable-option-interface: + type: object + description: Downloadable Option + properties: + downloadable_links: + type: array + description: The list of downloadable links + items: + type: integer + required: + - downloadable_links + gift-card-data-gift-card-option-interface: + type: object + description: Interface GiftCardOptionInterface + properties: + giftcard_amount: + type: string + description: Gift card amount. + custom_giftcard_amount: + type: number + description: Gift card open amount value. + giftcard_sender_name: + type: string + description: Gift card sender name. + giftcard_recipient_name: + type: string + description: Gift card recipient name. + giftcard_sender_email: + type: string + description: Gift card sender email. + giftcard_recipient_email: + type: string + description: Gift card recipient email. + giftcard_message: + type: string + description: Giftcard message. + extension_attributes: + "$ref": "#/definitions/gift-card-data-gift-card-option-extension-interface" + required: + - giftcard_amount + - giftcard_sender_name + - giftcard_recipient_name + - giftcard_sender_email + - giftcard_recipient_email + gift-card-data-gift-card-option-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftCardOptionInterface + properties: + giftcard_created_codes: + type: array + items: + type: string + configurable-product-data-configurable-item-option-value-interface: + type: object + description: Interface ConfigurableItemOptionValueInterface + properties: + option_id: + type: string + description: Option SKU + option_value: + type: integer + description: Item id + extension_attributes: + "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-extension-interface" + required: + - option_id + configurable-product-data-configurable-item-option-value-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface + grouped-product-data-grouped-options-interface: + type: object + description: Represents `product item id with qty` of a grouped product. + properties: + id: + type: integer + description: Associated product id + qty: + type: integer + description: Associated product qty + extension_attributes: + "$ref": "#/definitions/grouped-product-data-grouped-options-extension-interface" + grouped-product-data-grouped-options-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\GroupedProduct\Api\Data\GroupedOptionsInterface + quote-data-cart-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface + properties: + discounts: + type: array + items: + "$ref": "#/definitions/sales-rule-data-rule-discount-interface" + negotiable_quote_item: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-interface" + negotiable-quote-data-negotiable-quote-item-interface: + type: object + description: Interface CompanyQuoteConfigInterface + properties: + item_id: + type: integer + description: Quote item id + original_price: + type: number + description: Quote item original price + original_tax_amount: + type: number + description: Quote item original tax amount + original_discount_amount: + type: number + description: Quote item original discount amount + extension_attributes: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-extension-interface" + required: + - item_id + - original_price + - original_tax_amount + - original_discount_amount + negotiable-quote-data-negotiable-quote-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemInterface + properties: + negotiated_price_type: + type: integer + negotiated_price_value: + type: number + last_item_notes: + type: array + items: + "$ref": "#/definitions/negotiable-quote-data-item-note-interface" + is_discounting_locked: + type: boolean + min_qty: + type: number + max_qty: + type: number + negotiable-quote-data-item-note-interface: + type: object + description: Interface ItemNoteInterface + properties: + note_id: + type: integer + description: Note ID. + negotiable_quote_item_id: + type: integer + description: Negotiable quote item Id + creator_type: + type: integer + description: The note creator type. + creator_id: + type: integer + description: Note creator ID. + note: + type: string + description: Note. + created_at: + type: string + description: Comment created at. + extension_attributes: + "$ref": "#/definitions/negotiable-quote-data-item-note-extension-interface" + required: + - negotiable_quote_item_id + - creator_type + - creator_id + - note + negotiable-quote-data-item-note-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\ItemNoteInterface + quote-data-address-interface: + type: object + description: Interface AddressInterface + properties: + id: + type: integer + description: Id + region: + type: string + description: Region name + region_id: + type: integer + description: Region id + region_code: + type: string + description: Region code + country_id: + type: string + description: Country id + street: + type: array + description: Street + items: + type: string + company: + type: string + description: Company + telephone: + type: string + description: Telephone number + fax: + type: string + description: Fax number + postcode: + type: string + description: Postcode + city: + type: string + description: City name + firstname: + type: string + description: First name + lastname: + type: string + description: Last name + middlename: + type: string + description: Middle name + prefix: + type: string + description: Prefix + suffix: + type: string + description: Suffix + vat_id: + type: string + description: Vat id + customer_id: + type: integer + description: Customer id + email: + type: string + description: Billing/shipping email + same_as_billing: + type: integer + description: Same as billing flag + customer_address_id: + type: integer + description: Customer address id + save_in_address_book: + type: integer + description: Save in address book flag + extension_attributes: + "$ref": "#/definitions/quote-data-address-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + required: + - region + - region_id + - region_code + - country_id + - street + - telephone + - postcode + - city + - firstname + - lastname + - email + quote-data-address-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface + properties: + discounts: + type: array + items: + "$ref": "#/definitions/sales-rule-data-rule-discount-interface" + gift_registry_id: + type: integer + pickup_location_code: + type: string + quote-data-currency-interface: + type: object + description: Interface CurrencyInterface + properties: + global_currency_code: + type: string + description: Global currency code + base_currency_code: + type: string + description: Base currency code + store_currency_code: + type: string + description: Store currency code + quote_currency_code: + type: string + description: Quote currency code + store_to_base_rate: + type: number + description: Store currency to base currency rate + store_to_quote_rate: + type: number + description: Store currency to quote currency rate + base_to_global_rate: + type: number + description: Base currency to global currency rate + base_to_quote_rate: + type: number + description: Base currency to quote currency rate + extension_attributes: + "$ref": "#/definitions/quote-data-currency-extension-interface" + quote-data-currency-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CurrencyInterface + quote-data-cart-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartInterface + properties: + shipping_assignments: + type: array + items: + "$ref": "#/definitions/quote-data-shipping-assignment-interface" + negotiable_quote: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-interface" + company_id: + type: integer + coupon_codes: + type: array + items: + type: string + quote-data-shipping-assignment-interface: + type: object + description: Interface ShippingAssignmentInterface + properties: + shipping: + "$ref": "#/definitions/quote-data-shipping-interface" + items: + type: array + items: + "$ref": "#/definitions/quote-data-cart-item-interface" + extension_attributes: + "$ref": "#/definitions/quote-data-shipping-assignment-extension-interface" + required: + - shipping + - items + quote-data-shipping-interface: + type: object + description: Interface ShippingInterface + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + method: + type: string + description: Shipping method + extension_attributes: + "$ref": "#/definitions/quote-data-shipping-extension-interface" + required: + - address + - method + quote-data-shipping-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingInterface + quote-data-shipping-assignment-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingAssignmentInterface + negotiable-quote-data-negotiable-quote-interface: + type: object + description: Interface NegotiableQuoteInterface + properties: + quote_id: + type: integer + description: Negotiable quote ID. + is_regular_quote: + type: boolean + description: Is regular quote. + status: + type: string + description: Negotiable quote status. + negotiated_price_type: + type: integer + description: Negotiated price type. + negotiated_price_value: + type: number + description: Negotiated price value. + shipping_price: + type: number + description: Proposed shipping price. + quote_name: + type: string + description: Negotiable quote name. + expiration_period: + type: string + description: Expiration period. + email_notification_status: + type: integer + description: Email notification status. + has_unconfirmed_changes: + type: boolean + description: Has unconfirmed changes. + is_shipping_tax_changed: + type: boolean + description: Shipping tax changes. + is_customer_price_changed: + type: boolean + description: Customer price changes. + notifications: + type: integer + description: Quote notifications. + applied_rule_ids: + type: string + description: Quote rules. + is_address_draft: + type: boolean + description: Is address draft. + deleted_sku: + type: string + description: Deleted products sku. + creator_id: + type: integer + description: Quote creator id. + creator_type: + type: integer + description: Quote creator type. + original_total_price: + type: number + description: Quote original total price. + base_original_total_price: + type: number + description: Quote original total price in base currency. + negotiated_total_price: + type: number + description: Quote negotiated total price. + base_negotiated_total_price: + type: number + description: Quote negotiated total price in base currency. + extension_attributes: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-extension-interface" + required: + - quote_id + - is_regular_quote + - status + - negotiated_price_type + - negotiated_price_value + - shipping_price + - quote_name + - expiration_period + - email_notification_status + - has_unconfirmed_changes + - is_shipping_tax_changed + - is_customer_price_changed + - notifications + - applied_rule_ids + - is_address_draft + - deleted_sku + - creator_id + - creator_type + negotiable-quote-data-negotiable-quote-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteInterface + quote-data-cart-search-results-interface: + type: object + description: Interface CartSearchResultsInterface + properties: + items: + type: array + description: Carts list. + items: + "$ref": "#/definitions/quote-data-cart-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + quote-data-payment-interface: + type: object + description: Interface PaymentInterface + properties: + po_number: + type: string + description: Purchase order number + method: + type: string + description: Payment method code + additional_data: + type: array + description: Payment additional details + items: + type: string + extension_attributes: + "$ref": "#/definitions/quote-data-payment-extension-interface" + required: + - method + quote-data-payment-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\PaymentInterface + properties: + agreement_ids: + type: array + items: + type: string + quote-data-shipping-method-interface: + type: object + description: Interface ShippingMethodInterface + properties: + carrier_code: + type: string + description: Shipping carrier code. + method_code: + type: string + description: Shipping method code. + carrier_title: + type: string + description: Shipping carrier title. Otherwise, null. + method_title: + type: string + description: Shipping method title. Otherwise, null. + amount: + type: number + description: Shipping amount in store currency. + base_amount: + type: number + description: Shipping amount in base currency. + available: + type: boolean + description: The value of the availability flag for the current shipping method. + extension_attributes: + "$ref": "#/definitions/quote-data-shipping-method-extension-interface" + error_message: + type: string + description: Shipping Error message. + price_excl_tax: + type: number + description: Shipping price excl tax. + price_incl_tax: + type: number + description: Shipping price incl tax. + required: + - carrier_code + - method_code + - amount + - base_amount + - available + - error_message + - price_excl_tax + - price_incl_tax + quote-data-shipping-method-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingMethodInterface + quote-data-payment-method-interface: + type: object + description: Interface PaymentMethodInterface + properties: + code: + type: string + description: Payment method code + title: + type: string + description: Payment method title + required: + - code + - title + quote-data-totals-interface: + type: object + description: Interface TotalsInterface + properties: + grand_total: + type: number + description: Grand total in quote currency + base_grand_total: + type: number + description: Grand total in base currency + subtotal: + type: number + description: Subtotal in quote currency + base_subtotal: + type: number + description: Subtotal in base currency + discount_amount: + type: number + description: Discount amount in quote currency + base_discount_amount: + type: number + description: Discount amount in base currency + subtotal_with_discount: + type: number + description: Subtotal in quote currency with applied discount + base_subtotal_with_discount: + type: number + description: Subtotal in base currency with applied discount + shipping_amount: + type: number + description: Shipping amount in quote currency + base_shipping_amount: + type: number + description: Shipping amount in base currency + shipping_discount_amount: + type: number + description: Shipping discount amount in quote currency + base_shipping_discount_amount: + type: number + description: Shipping discount amount in base currency + tax_amount: + type: number + description: Tax amount in quote currency + base_tax_amount: + type: number + description: Tax amount in base currency + weee_tax_applied_amount: + type: number + description: Item weee tax applied amount in quote currency. + shipping_tax_amount: + type: number + description: Shipping tax amount in quote currency + base_shipping_tax_amount: + type: number + description: Shipping tax amount in base currency + subtotal_incl_tax: + type: number + description: Subtotal including tax in quote currency + base_subtotal_incl_tax: + type: number + description: Subtotal including tax in base currency + shipping_incl_tax: + type: number + description: Shipping including tax in quote currency + base_shipping_incl_tax: + type: number + description: Shipping including tax in base currency + base_currency_code: + type: string + description: Base currency code + quote_currency_code: + type: string + description: Quote currency code + coupon_code: + type: string + description: Applied coupon code + items_qty: + type: integer + description: Items qty + items: + type: array + description: Totals by items + items: + "$ref": "#/definitions/quote-data-totals-item-interface" + total_segments: + type: array + description: Dynamically calculated totals + items: + "$ref": "#/definitions/quote-data-total-segment-interface" + extension_attributes: + "$ref": "#/definitions/quote-data-totals-extension-interface" + required: + - weee_tax_applied_amount + - total_segments + quote-data-totals-item-interface: + type: object + description: Interface TotalsItemInterface + properties: + item_id: + type: integer + description: Item id + price: + type: number + description: Item price in quote currency. + base_price: + type: number + description: Item price in base currency. + qty: + type: number + description: Item quantity. + row_total: + type: number + description: Row total in quote currency. + base_row_total: + type: number + description: Row total in base currency. + row_total_with_discount: + type: number + description: Row total with discount in quote currency. Otherwise, null. + tax_amount: + type: number + description: Tax amount in quote currency. Otherwise, null. + base_tax_amount: + type: number + description: Tax amount in base currency. Otherwise, null. + tax_percent: + type: number + description: Tax percent. Otherwise, null. + discount_amount: + type: number + description: Discount amount in quote currency. Otherwise, null. + base_discount_amount: + type: number + description: Discount amount in base currency. Otherwise, null. + discount_percent: + type: number + description: Discount percent. Otherwise, null. + price_incl_tax: + type: number + description: Price including tax in quote currency. Otherwise, null. + base_price_incl_tax: + type: number + description: Price including tax in base currency. Otherwise, null. + row_total_incl_tax: + type: number + description: Row total including tax in quote currency. Otherwise, null. + base_row_total_incl_tax: + type: number + description: Row total including tax in base currency. Otherwise, null. + options: + type: string + description: Item price in quote currency. + weee_tax_applied_amount: + type: number + description: Item weee tax applied amount in quote currency. + weee_tax_applied: + type: string + description: Item weee tax applied in quote currency. + extension_attributes: + "$ref": "#/definitions/quote-data-totals-item-extension-interface" + name: + type: string + description: Product name. Otherwise, null. + required: + - item_id + - price + - base_price + - qty + - row_total + - base_row_total + - options + - weee_tax_applied_amount + - weee_tax_applied + quote-data-totals-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsItemInterface + properties: + negotiable_quote_item_totals: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-interface" + negotiable-quote-data-negotiable-quote-item-totals-interface: + type: object + description: Extension attribute for quote item totals model. + properties: + cost: + type: number + description: Cost for quote item. + catalog_price: + type: number + description: Catalog price for quote item. + base_catalog_price: + type: number + description: Catalog price for quote item in base currency. + catalog_price_incl_tax: + type: number + description: Catalog price with included tax for quote item. + base_catalog_price_incl_tax: + type: number + description: Catalog price with included tax for quote item in base currency. + cart_price: + type: number + description: Cart price for quote item. + base_cart_price: + type: number + description: Cart price for quote item in base currency. + cart_tax: + type: number + description: Tax from catalog price for quote item. + base_cart_tax: + type: number + description: Tax from catalog price for quote item in base currency. + cart_price_incl_tax: + type: number + description: Cart price with included tax for quote item. + base_cart_price_incl_tax: + type: number + description: Cart price with included tax for quote item in base currency. + extension_attributes: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-extension-interface" + required: + - cost + - catalog_price + - base_catalog_price + - catalog_price_incl_tax + - base_catalog_price_incl_tax + - cart_price + - base_cart_price + - cart_tax + - base_cart_tax + - cart_price_incl_tax + - base_cart_price_incl_tax + negotiable-quote-data-negotiable-quote-item-totals-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemTotalsInterface + quote-data-total-segment-interface: + type: object + description: Interface TotalsInterface + properties: + code: + type: string + description: Code + title: + type: string + description: Total title + value: + type: number + description: Total value + area: + type: string + description: Display area code. + extension_attributes: + "$ref": "#/definitions/quote-data-total-segment-extension-interface" + required: + - code + - value + quote-data-total-segment-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalSegmentInterface + properties: + tax_grandtotal_details: + type: array + items: + "$ref": "#/definitions/tax-data-grand-total-details-interface" + gift_cards: + type: string + gw_order_id: + type: string + gw_item_ids: + type: array + items: + type: string + gw_allow_gift_receipt: + type: string + gw_add_card: + type: string + gw_price: + type: string + gw_base_price: + type: string + gw_items_price: + type: string + gw_items_base_price: + type: string + gw_card_price: + type: string + gw_card_base_price: + type: string + gw_base_tax_amount: + type: string + gw_tax_amount: + type: string + gw_items_base_tax_amount: + type: string + gw_items_tax_amount: + type: string + gw_card_base_tax_amount: + type: string + gw_card_tax_amount: + type: string + gw_price_incl_tax: + type: string + gw_base_price_incl_tax: + type: string + gw_card_price_incl_tax: + type: string + gw_card_base_price_incl_tax: + type: string + gw_items_price_incl_tax: + type: string + gw_items_base_price_incl_tax: + type: string + tax-data-grand-total-details-interface: + type: object + description: Interface GrandTotalDetailsInterface + properties: + amount: + type: number + description: Tax amount value + rates: + type: array + description: Tax rates info + items: + "$ref": "#/definitions/tax-data-grand-total-rates-interface" + group_id: + type: integer + description: Group identifier + required: + - amount + - rates + - group_id + tax-data-grand-total-rates-interface: + type: object + description: Interface GrandTotalRatesInterface + properties: + percent: + type: string + description: Tax percentage value + title: + type: string + description: Rate title + required: + - percent + - title + quote-data-totals-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsInterface + properties: + coupon_label: + type: string + negotiable_quote_totals: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-totals-interface" + base_customer_balance_amount: + type: number + customer_balance_amount: + type: number + coupon_codes: + type: array + items: + type: string + coupons_labels: + type: array + items: + type: string + reward_points_balance: + type: number + reward_currency_amount: + type: number + base_reward_currency_amount: + type: number + negotiable-quote-data-negotiable-quote-totals-interface: + type: object + description: Extension attribute for quote totals model. + properties: + items_count: + type: integer + description: The number of different items or products in the cart. + quote_status: + type: string + description: Negotiable quote status. + created_at: + type: string + description: The cart creation date and time. + updated_at: + type: string + description: The cart last update date and time. + customer_group: + type: integer + description: Customer group id. + base_to_quote_rate: + type: number + description: Base currency to quote currency rate. + cost_total: + type: number + description: Total cost for quote. + base_cost_total: + type: number + description: Total cost for quote in base currency. + original_total: + type: number + description: Original quote total. + base_original_total: + type: number + description: Original quote total in base currency. + original_tax: + type: number + description: Original tax amount for quote. + base_original_tax: + type: number + description: Original tax amount for quote in base currency. + original_price_incl_tax: + type: number + description: Original price with included tax for quote. + base_original_price_incl_tax: + type: number + description: Original price with included tax for quote in base currency. + negotiated_price_type: + type: integer + description: Negotiable quote type. + negotiated_price_value: + type: number + description: Negotiable price value for quote. + required: + - items_count + - quote_status + - created_at + - updated_at + - customer_group + - base_to_quote_rate + - cost_total + - base_cost_total + - original_total + - base_original_total + - original_tax + - base_original_tax + - original_price_incl_tax + - base_original_price_incl_tax + - negotiated_price_type + - negotiated_price_value + quote-data-totals-additional-data-interface: + type: object + description: Additional data for totals collection. + properties: + extension_attributes: + "$ref": "#/definitions/quote-data-totals-additional-data-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + quote-data-totals-additional-data-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsAdditionalDataInterface + properties: + gift_messages: + type: array + items: + "$ref": "#/definitions/gift-message-data-message-interface" + gift-message-data-message-interface: + type: object + description: Interface MessageInterface + properties: + gift_message_id: + type: integer + description: Gift message ID. Otherwise, null. + customer_id: + type: integer + description: Customer ID. Otherwise, null. + sender: + type: string + description: Sender name. + recipient: + type: string + description: Recipient name. + message: + type: string + description: Message text. + extension_attributes: + "$ref": "#/definitions/gift-message-data-message-extension-interface" + required: + - sender + - recipient + - message + gift-message-data-message-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\GiftMessage\Api\Data\MessageInterface + properties: + entity_id: + type: string + entity_type: + type: string + wrapping_id: + type: integer + wrapping_allow_gift_receipt: + type: boolean + wrapping_add_printed_card: + type: boolean + catalog-inventory-data-stock-item-collection-interface: + type: object + description: Interface StockItemCollectionInterface + properties: + items: + type: array + description: Items + items: + "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" + search_criteria: + "$ref": "#/definitions/catalog-inventory-stock-item-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + catalog-inventory-stock-item-criteria-interface: + type: object + description: Interface StockItemCriteriaInterface + properties: + mapper_interface_name: + type: string + description: Associated Mapper Interface name + criteria_list: + type: array + description: Criteria objects added to current Composite Criteria + items: + "$ref": "#/definitions/framework-criteria-interface" + filters: + type: array + description: List of filters + items: + type: string + orders: + type: array + description: Ordering criteria + items: + type: string + limit: + type: array + description: Limit + items: + type: string + required: + - mapper_interface_name + - criteria_list + - filters + - orders + - limit + framework-criteria-interface: + type: object + description: Interface CriteriaInterface + properties: + mapper_interface_name: + type: string + description: Associated Mapper Interface name + criteria_list: + type: array + description: Criteria objects added to current Composite Criteria + items: + "$ref": "#/definitions/framework-criteria-interface" + filters: + type: array + description: List of filters + items: + type: string + orders: + type: array + description: Ordering criteria + items: + type: string + limit: + type: array + description: Limit + items: + type: string + required: + - mapper_interface_name + - criteria_list + - filters + - orders + - limit + catalog-inventory-data-stock-status-interface: + type: object + description: Interface StockStatusInterface + properties: + product_id: + type: integer + stock_id: + type: integer + qty: + type: integer + stock_status: + type: integer + stock_item: + "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" + extension_attributes: + "$ref": "#/definitions/catalog-inventory-data-stock-status-extension-interface" + required: + - product_id + - stock_id + - qty + - stock_status + - stock_item + catalog-inventory-data-stock-status-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\CatalogInventory\Api\Data\StockStatusInterface + sales-data-order-interface: + type: object + description: Order interface. An order is a document that a web store issues to + a customer. Magento generates a sales order that lists the product items, billing + and shipping addresses, and shipping and payment methods. A corresponding external + document, known as a purchase order, is emailed to the customer. + properties: + adjustment_negative: + type: number + description: Negative adjustment value. + adjustment_positive: + type: number + description: Positive adjustment value. + applied_rule_ids: + type: string + description: Applied rule IDs. + base_adjustment_negative: + type: number + description: Base negative adjustment value. + base_adjustment_positive: + type: number + description: Base positive adjustment value. + base_currency_code: + type: string + description: Base currency code. + base_discount_amount: + type: number + description: Base discount amount. + base_discount_canceled: + type: number + description: Base discount canceled. + base_discount_invoiced: + type: number + description: Base discount invoiced. + base_discount_refunded: + type: number + description: Base discount refunded. + base_grand_total: + type: number + description: Base grand total. + base_discount_tax_compensation_amount: + type: number + description: Base discount tax compensation amount. + base_discount_tax_compensation_invoiced: + type: number + description: Base discount tax compensation invoiced. + base_discount_tax_compensation_refunded: + type: number + description: Base discount tax compensation refunded. + base_shipping_amount: + type: number + description: Base shipping amount. + base_shipping_canceled: + type: number + description: Base shipping canceled. + base_shipping_discount_amount: + type: number + description: Base shipping discount amount. + base_shipping_discount_tax_compensation_amnt: + type: number + description: Base shipping discount tax compensation amount. + base_shipping_incl_tax: + type: number + description: Base shipping including tax. + base_shipping_invoiced: + type: number + description: Base shipping invoiced. + base_shipping_refunded: + type: number + description: Base shipping refunded. + base_shipping_tax_amount: + type: number + description: Base shipping tax amount. + base_shipping_tax_refunded: + type: number + description: Base shipping tax refunded. + base_subtotal: + type: number + description: Base subtotal. + base_subtotal_canceled: + type: number + description: Base subtotal canceled. + base_subtotal_incl_tax: + type: number + description: Base subtotal including tax. + base_subtotal_invoiced: + type: number + description: Base subtotal invoiced. + base_subtotal_refunded: + type: number + description: Base subtotal refunded. + base_tax_amount: + type: number + description: Base tax amount. + base_tax_canceled: + type: number + description: Base tax canceled. + base_tax_invoiced: + type: number + description: Base tax invoiced. + base_tax_refunded: + type: number + description: Base tax refunded. + base_total_canceled: + type: number + description: Base total canceled. + base_total_due: + type: number + description: Base total due. + base_total_invoiced: + type: number + description: Base total invoiced. + base_total_invoiced_cost: + type: number + description: Base total invoiced cost. + base_total_offline_refunded: + type: number + description: Base total offline refunded. + base_total_online_refunded: + type: number + description: Base total online refunded. + base_total_paid: + type: number + description: Base total paid. + base_total_qty_ordered: + type: number + description: Base total quantity ordered. + base_total_refunded: + type: number + description: Base total refunded. + base_to_global_rate: + type: number + description: Base-to-global rate. + base_to_order_rate: + type: number + description: Base-to-order rate. + billing_address_id: + type: integer + description: Billing address ID. + can_ship_partially: + type: integer + description: Can-ship-partially flag value. + can_ship_partially_item: + type: integer + description: Can-ship-partially-item flag value. + coupon_code: + type: string + description: Coupon code. + created_at: + type: string + description: Created-at timestamp. + customer_dob: + type: string + description: In keeping with current security and privacy best practices, + be sure you are aware of any potential legal and security risks associated + with the storage of customers’ full date of birth (month, day, year) along + with other personal identifiers (e.g., full name) before collecting or processing + such data. + customer_email: + type: string + description: Customer email address. + customer_firstname: + type: string + description: Customer first name. + customer_gender: + type: integer + description: Customer gender. + customer_group_id: + type: integer + description: Customer group ID. + customer_id: + type: integer + description: Customer ID. + customer_is_guest: + type: integer + description: Customer-is-guest flag value. + customer_lastname: + type: string + description: Customer last name. + customer_middlename: + type: string + description: Customer middle name. + customer_note: + type: string + description: Customer note. + customer_note_notify: + type: integer + description: Customer-note-notify flag value. + customer_prefix: + type: string + description: Customer prefix. + customer_suffix: + type: string + description: Customer suffix. + customer_taxvat: + type: string + description: Customer value-added tax (VAT). + discount_amount: + type: number + description: Discount amount. + discount_canceled: + type: number + description: Discount canceled. + discount_description: + type: string + description: Discount description. + discount_invoiced: + type: number + description: Discount invoiced. + discount_refunded: + type: number + description: Discount refunded amount. + edit_increment: + type: integer + description: Edit increment value. + email_sent: + type: integer + description: Email-sent flag value. + entity_id: + type: integer + description: Order ID. + ext_customer_id: + type: string + description: External customer ID. + ext_order_id: + type: string + description: External order ID. + forced_shipment_with_invoice: + type: integer + description: Forced-shipment-with-invoice flag value. + global_currency_code: + type: string + description: Global currency code. + grand_total: + type: number + description: Grand total. + discount_tax_compensation_amount: + type: number + description: Discount tax compensation amount. + discount_tax_compensation_invoiced: + type: number + description: Discount tax compensation invoiced amount. + discount_tax_compensation_refunded: + type: number + description: Discount tax compensation refunded amount. + hold_before_state: + type: string + description: Hold before state. + hold_before_status: + type: string + description: Hold before status. + increment_id: + type: string + description: Increment ID. + is_virtual: + type: integer + description: Is-virtual flag value. + order_currency_code: + type: string + description: Order currency code. + original_increment_id: + type: string + description: Original increment ID. + payment_authorization_amount: + type: number + description: Payment authorization amount. + payment_auth_expiration: + type: integer + description: Payment authorization expiration date. + protect_code: + type: string + description: Protect code. + quote_address_id: + type: integer + description: Quote address ID. + quote_id: + type: integer + description: Quote ID. + relation_child_id: + type: string + description: Relation child ID. + relation_child_real_id: + type: string + description: Relation child real ID. + relation_parent_id: + type: string + description: Relation parent ID. + relation_parent_real_id: + type: string + description: Relation parent real ID. + remote_ip: + type: string + description: Remote IP address. + shipping_amount: + type: number + description: Shipping amount. + shipping_canceled: + type: number + description: Shipping canceled amount. + shipping_description: + type: string + description: Shipping description. + shipping_discount_amount: + type: number + description: Shipping discount amount. + shipping_discount_tax_compensation_amount: + type: number + description: Shipping discount tax compensation amount. + shipping_incl_tax: + type: number + description: Shipping including tax amount. + shipping_invoiced: + type: number + description: Shipping invoiced amount. + shipping_refunded: + type: number + description: Shipping refunded amount. + shipping_tax_amount: + type: number + description: Shipping tax amount. + shipping_tax_refunded: + type: number + description: Shipping tax refunded amount. + state: + type: string + description: State. + status: + type: string + description: Status. + store_currency_code: + type: string + description: Store currency code. + store_id: + type: integer + description: Store ID. + store_name: + type: string + description: Store name. + store_to_base_rate: + type: number + description: Store-to-base rate. + store_to_order_rate: + type: number + description: Store-to-order rate. + subtotal: + type: number + description: Subtotal. + subtotal_canceled: + type: number + description: Subtotal canceled amount. + subtotal_incl_tax: + type: number + description: Subtotal including tax amount. + subtotal_invoiced: + type: number + description: Subtotal invoiced amount. + subtotal_refunded: + type: number + description: Subtotal refunded amount. + tax_amount: + type: number + description: Tax amount. + tax_canceled: + type: number + description: Tax canceled amount. + tax_invoiced: + type: number + description: Tax invoiced amount. + tax_refunded: + type: number + description: Tax refunded amount. + total_canceled: + type: number + description: Total canceled. + total_due: + type: number + description: Total due. + total_invoiced: + type: number + description: Total invoiced amount. + total_item_count: + type: integer + description: Total item count. + total_offline_refunded: + type: number + description: Total offline refunded amount. + total_online_refunded: + type: number + description: Total online refunded amount. + total_paid: + type: number + description: Total paid. + total_qty_ordered: + type: number + description: Total quantity ordered. + total_refunded: + type: number + description: Total amount refunded. + updated_at: + type: string + description: Updated-at timestamp. + weight: + type: number + description: Weight. + x_forwarded_for: + type: string + description: X-Forwarded-For field value. + items: + type: array + description: Array of items. + items: + "$ref": "#/definitions/sales-data-order-item-interface" + billing_address: + "$ref": "#/definitions/sales-data-order-address-interface" + payment: + "$ref": "#/definitions/sales-data-order-payment-interface" + status_histories: + type: array + description: Array of status histories. + items: + "$ref": "#/definitions/sales-data-order-status-history-interface" + extension_attributes: + "$ref": "#/definitions/sales-data-order-extension-interface" + required: + - base_grand_total + - customer_email + - grand_total + - items + sales-data-order-item-interface: + type: object + description: Order item interface. An order is a document that a web store issues + to a customer. Magento generates a sales order that lists the product items, + billing and shipping addresses, and shipping and payment methods. A corresponding + external document, known as a purchase order, is emailed to the customer. + properties: + additional_data: + type: string + description: Additional data. + amount_refunded: + type: number + description: Amount refunded. + applied_rule_ids: + type: string + description: Applied rule IDs. + base_amount_refunded: + type: number + description: Base amount refunded. + base_cost: + type: number + description: Base cost. + base_discount_amount: + type: number + description: Base discount amount. + base_discount_invoiced: + type: number + description: Base discount invoiced. + base_discount_refunded: + type: number + description: Base discount refunded. + base_discount_tax_compensation_amount: + type: number + description: Base discount tax compensation amount. + base_discount_tax_compensation_invoiced: + type: number + description: Base discount tax compensation invoiced. + base_discount_tax_compensation_refunded: + type: number + description: Base discount tax compensation refunded. + base_original_price: + type: number + description: Base original price. + base_price: + type: number + description: Base price. + base_price_incl_tax: + type: number + description: Base price including tax. + base_row_invoiced: + type: number + description: Base row invoiced. + base_row_total: + type: number + description: Base row total. + base_row_total_incl_tax: + type: number + description: Base row total including tax. + base_tax_amount: + type: number + description: Base tax amount. + base_tax_before_discount: + type: number + description: Base tax before discount. + base_tax_invoiced: + type: number + description: Base tax invoiced. + base_tax_refunded: + type: number + description: Base tax refunded. + base_weee_tax_applied_amount: + type: number + description: Base WEEE tax applied amount. + base_weee_tax_applied_row_amnt: + type: number + description: Base WEEE tax applied row amount. + base_weee_tax_disposition: + type: number + description: Base WEEE tax disposition. + base_weee_tax_row_disposition: + type: number + description: Base WEEE tax row disposition. + created_at: + type: string + description: Created-at timestamp. + description: + type: string + description: Description. + discount_amount: + type: number + description: Discount amount. + discount_invoiced: + type: number + description: Discount invoiced. + discount_percent: + type: number + description: Discount percent. + discount_refunded: + type: number + description: Discount refunded. + event_id: + type: integer + description: Event ID. + ext_order_item_id: + type: string + description: External order item ID. + free_shipping: + type: integer + description: Free-shipping flag value. + gw_base_price: + type: number + description: GW base price. + gw_base_price_invoiced: + type: number + description: GW base price invoiced. + gw_base_price_refunded: + type: number + description: GW base price refunded. + gw_base_tax_amount: + type: number + description: GW base tax amount. + gw_base_tax_amount_invoiced: + type: number + description: GW base tax amount invoiced. + gw_base_tax_amount_refunded: + type: number + description: GW base tax amount refunded. + gw_id: + type: integer + description: GW ID. + gw_price: + type: number + description: GW price. + gw_price_invoiced: + type: number + description: GW price invoiced. + gw_price_refunded: + type: number + description: GW price refunded. + gw_tax_amount: + type: number + description: GW tax amount. + gw_tax_amount_invoiced: + type: number + description: GW tax amount invoiced. + gw_tax_amount_refunded: + type: number + description: GW tax amount refunded. + discount_tax_compensation_amount: + type: number + description: Discount tax compensation amount. + discount_tax_compensation_canceled: + type: number + description: Discount tax compensation canceled. + discount_tax_compensation_invoiced: + type: number + description: Discount tax compensation invoiced. + discount_tax_compensation_refunded: + type: number + description: Discount tax compensation refunded. + is_qty_decimal: + type: integer + description: Is-quantity-decimal flag value. + is_virtual: + type: integer + description: Is-virtual flag value. + item_id: + type: integer + description: Item ID. + locked_do_invoice: + type: integer + description: Locked DO invoice flag value. + locked_do_ship: + type: integer + description: Locked DO ship flag value. + name: + type: string + description: Name. + no_discount: + type: integer + description: No-discount flag value. + order_id: + type: integer + description: Order ID. + original_price: + type: number + description: Original price. + parent_item_id: + type: integer + description: Parent item ID. + price: + type: number + description: Price. + price_incl_tax: + type: number + description: Price including tax. + product_id: + type: integer + description: Product ID. + product_type: + type: string + description: Product type. + qty_backordered: + type: number + description: Quantity backordered. + qty_canceled: + type: number + description: Quantity canceled. + qty_invoiced: + type: number + description: Quantity invoiced. + qty_ordered: + type: number + description: Quantity ordered. + qty_refunded: + type: number + description: Quantity refunded. + qty_returned: + type: number + description: Quantity returned. + qty_shipped: + type: number + description: Quantity shipped. + quote_item_id: + type: integer + description: Quote item ID. + row_invoiced: + type: number + description: Row invoiced. + row_total: + type: number + description: Row total. + row_total_incl_tax: + type: number + description: Row total including tax. + row_weight: + type: number + description: Row weight. + sku: + type: string + description: SKU. + store_id: + type: integer + description: Store ID. + tax_amount: + type: number + description: Tax amount. + tax_before_discount: + type: number + description: Tax before discount. + tax_canceled: + type: number + description: Tax canceled. + tax_invoiced: + type: number + description: Tax invoiced. + tax_percent: + type: number + description: Tax percent. + tax_refunded: + type: number + description: Tax refunded. + updated_at: + type: string + description: Updated-at timestamp. + weee_tax_applied: + type: string + description: WEEE tax applied. + weee_tax_applied_amount: + type: number + description: WEEE tax applied amount. + weee_tax_applied_row_amount: + type: number + description: WEEE tax applied row amount. + weee_tax_disposition: + type: number + description: WEEE tax disposition. + weee_tax_row_disposition: + type: number + description: WEEE tax row disposition. + weight: + type: number + description: Weight. + parent_item: + "$ref": "#/definitions/sales-data-order-item-interface" + product_option: + "$ref": "#/definitions/catalog-data-product-option-interface" + extension_attributes: + "$ref": "#/definitions/sales-data-order-item-extension-interface" + required: + - sku + catalog-data-product-option-interface: + type: object + description: Product option interface + properties: + extension_attributes: + "$ref": "#/definitions/catalog-data-product-option-extension-interface" + catalog-data-product-option-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductOptionInterface + properties: + custom_options: + type: array + items: + "$ref": "#/definitions/catalog-data-custom-option-interface" + bundle_options: + type: array + items: + "$ref": "#/definitions/bundle-data-bundle-option-interface" + downloadable_option: + "$ref": "#/definitions/downloadable-data-downloadable-option-interface" + giftcard_item_option: + "$ref": "#/definitions/gift-card-data-gift-card-option-interface" + configurable_item_options: + type: array + items: + "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-interface" + sales-data-order-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderItemInterface + properties: + itemized_taxes: + type: array + items: + "$ref": "#/definitions/tax-data-order-tax-item-interface" + gift_message: + "$ref": "#/definitions/gift-message-data-message-interface" + gw_id: + type: string + gw_base_price: + type: string + gw_price: + type: string + gw_base_tax_amount: + type: string + gw_tax_amount: + type: string + gw_base_price_invoiced: + type: string + gw_price_invoiced: + type: string + gw_base_tax_amount_invoiced: + type: string + gw_tax_amount_invoiced: + type: string + gw_base_price_refunded: + type: string + gw_price_refunded: + type: string + gw_base_tax_amount_refunded: + type: string + gw_tax_amount_refunded: + type: string + tax-data-order-tax-item-interface: + type: object + description: '' + properties: + tax_item_id: + type: integer + description: Tax item ID + tax_id: + type: integer + description: Tax ID + item_id: + type: integer + description: Order item ID + tax_code: + type: string + description: Tax code + tax_percent: + type: number + description: Tax percent + amount: + type: number + description: Tax amount + base_amount: + type: number + description: Tax amount in base currency + real_amount: + type: number + description: Real tax amount + real_base_amount: + type: number + description: Real tax amount in base currency + associated_item_id: + type: integer + description: Associated order item ID + taxable_item_type: + type: string + description: shipping, product, weee, quote_gw, etc... + extension_attributes: + "$ref": "#/definitions/tax-data-order-tax-item-extension-interface" + required: + - tax_percent + - amount + - base_amount + - real_amount + - real_base_amount + tax-data-order-tax-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Tax\Api\Data\OrderTaxItemInterface + sales-data-order-address-interface: + type: object + description: Order address interface. An order is a document that a web store + issues to a customer. Magento generates a sales order that lists the product + items, billing and shipping addresses, and shipping and payment methods. A corresponding + external document, known as a purchase order, is emailed to the customer. + properties: + address_type: + type: string + description: Address type. + city: + type: string + description: City. + company: + type: string + description: Company. + country_id: + type: string + description: Country ID. + customer_address_id: + type: integer + description: Country address ID. + customer_id: + type: integer + description: Customer ID. + email: + type: string + description: Email address. + entity_id: + type: integer + description: Order address ID. + fax: + type: string + description: Fax number. + firstname: + type: string + description: First name. + lastname: + type: string + description: Last name. + middlename: + type: string + description: Middle name. + parent_id: + type: integer + description: Parent ID. + postcode: + type: string + description: Postal code. + prefix: + type: string + description: Prefix. + region: + type: string + description: Region. + region_code: + type: string + description: Region code. + region_id: + type: integer + description: Region ID. + street: + type: array + description: Array of any street values. Otherwise, null. + items: + type: string + suffix: + type: string + description: Suffix. + telephone: + type: string + description: Telephone number. + vat_id: + type: string + description: VAT ID. + vat_is_valid: + type: integer + description: VAT-is-valid flag value. + vat_request_date: + type: string + description: VAT request date. + vat_request_id: + type: string + description: VAT request ID. + vat_request_success: + type: integer + description: VAT-request-success flag value. + extension_attributes: + "$ref": "#/definitions/sales-data-order-address-extension-interface" + required: + - address_type + - city + - country_id + - firstname + - lastname + - postcode + - telephone + sales-data-order-address-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderAddressInterface + sales-data-order-payment-interface: + type: object + description: Order payment interface. An order is a document that a web store + issues to a customer. Magento generates a sales order that lists the product + items, billing and shipping addresses, and shipping and payment methods. A corresponding + external document, known as a purchase order, is emailed to the customer. + properties: + account_status: + type: string + description: Account status. + additional_data: + type: string + description: Additional data. + additional_information: + type: array + description: Array of additional information. + items: + type: string + address_status: + type: string + description: Address status. + amount_authorized: + type: number + description: Amount authorized. + amount_canceled: + type: number + description: Amount canceled. + amount_ordered: + type: number + description: Amount ordered. + amount_paid: + type: number + description: Amount paid. + amount_refunded: + type: number + description: Amount refunded. + anet_trans_method: + type: string + description: Anet transaction method. + base_amount_authorized: + type: number + description: Base amount authorized. + base_amount_canceled: + type: number + description: Base amount canceled. + base_amount_ordered: + type: number + description: Base amount ordered. + base_amount_paid: + type: number + description: Base amount paid. + base_amount_paid_online: + type: number + description: Base amount paid online. + base_amount_refunded: + type: number + description: Base amount refunded. + base_amount_refunded_online: + type: number + description: Base amount refunded online. + base_shipping_amount: + type: number + description: Base shipping amount. + base_shipping_captured: + type: number + description: Base shipping captured amount. + base_shipping_refunded: + type: number + description: Base shipping refunded amount. + cc_approval: + type: string + description: Credit card approval. + cc_avs_status: + type: string + description: Credit card avs status. + cc_cid_status: + type: string + description: Credit card CID status. + cc_debug_request_body: + type: string + description: Credit card debug request body. + cc_debug_response_body: + type: string + description: Credit card debug response body. + cc_debug_response_serialized: + type: string + description: Credit card debug response serialized. + cc_exp_month: + type: string + description: Credit card expiration month. + cc_exp_year: + type: string + description: Credit card expiration year. + cc_last4: + type: string + description: Last four digits of the credit card. + cc_number_enc: + type: string + description: Encrypted credit card number. + cc_owner: + type: string + description: Credit card number. + cc_secure_verify: + type: string + description: Credit card secure verify. + cc_ss_issue: + type: string + description: Credit card SS issue. + cc_ss_start_month: + type: string + description: Credit card SS start month. + cc_ss_start_year: + type: string + description: Credit card SS start year. + cc_status: + type: string + description: Credit card status. + cc_status_description: + type: string + description: Credit card status description. + cc_trans_id: + type: string + description: Credit card transaction ID. + cc_type: + type: string + description: Credit card type. + echeck_account_name: + type: string + description: eCheck account name. + echeck_account_type: + type: string + description: eCheck account type. + echeck_bank_name: + type: string + description: eCheck bank name. + echeck_routing_number: + type: string + description: eCheck routing number. + echeck_type: + type: string + description: eCheck type. + entity_id: + type: integer + description: Entity ID. + last_trans_id: + type: string + description: Last transaction ID. + method: + type: string + description: Method. + parent_id: + type: integer + description: Parent ID. + po_number: + type: string + description: PO number. + protection_eligibility: + type: string + description: Protection eligibility. + quote_payment_id: + type: integer + description: Quote payment ID. + shipping_amount: + type: number + description: Shipping amount. + shipping_captured: + type: number + description: Shipping captured. + shipping_refunded: + type: number + description: Shipping refunded. + extension_attributes: + "$ref": "#/definitions/sales-data-order-payment-extension-interface" + required: + - account_status + - additional_information + - cc_last4 + - method + sales-data-order-payment-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderPaymentInterface + properties: + notification_message: + type: string + vault_payment_token: + "$ref": "#/definitions/vault-data-payment-token-interface" + vault-data-payment-token-interface: + type: object + description: Gateway vault payment token interface. + properties: + entity_id: + type: integer + description: Entity ID. + customer_id: + type: integer + description: Customer ID. + public_hash: + type: string + description: Public hash + payment_method_code: + type: string + description: Payment method code + type: + type: string + description: Type + created_at: + type: string + description: Token creation timestamp + expires_at: + type: string + description: Token expiration timestamp + gateway_token: + type: string + description: Gateway token ID + token_details: + type: string + description: Token details + is_active: + type: boolean + description: Is active. + is_visible: + type: boolean + description: Is visible. + website_id: + type: integer + description: website id. + required: + - public_hash + - payment_method_code + - type + - gateway_token + - token_details + - is_active + - is_visible + - website_id + sales-data-order-status-history-interface: + type: object + description: Order status history interface. An order is a document that a web + store issues to a customer. Magento generates a sales order that lists the product + items, billing and shipping addresses, and shipping and payment methods. A corresponding + external document, known as a purchase order, is emailed to the customer. + properties: + comment: + type: string + description: Comment. + created_at: + type: string + description: Created-at timestamp. + entity_id: + type: integer + description: Order status history ID. + entity_name: + type: string + description: Entity name. + is_customer_notified: + type: integer + description: Is-customer-notified flag value. + is_visible_on_front: + type: integer + description: Is-visible-on-storefront flag value. + parent_id: + type: integer + description: Parent ID. + status: + type: string + description: Status. + extension_attributes: + "$ref": "#/definitions/sales-data-order-status-history-extension-interface" + required: + - comment + - is_customer_notified + - is_visible_on_front + - parent_id + sales-data-order-status-history-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderStatusHistoryInterface + sales-data-order-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\OrderInterface + properties: + shipping_assignments: + type: array + items: + "$ref": "#/definitions/sales-data-shipping-assignment-interface" + payment_additional_info: + type: array + items: + "$ref": "#/definitions/payment-data-payment-additional-info-interface" + company_order_attributes: + "$ref": "#/definitions/company-data-company-order-interface" + custom_fees: + type: array + items: + "$ref": "#/definitions/admin-ui-sdk-custom-fees-data-custom-fees-interface" + applied_taxes: + type: array + items: + "$ref": "#/definitions/tax-data-order-tax-details-applied-tax-interface" + item_applied_taxes: + type: array + items: + "$ref": "#/definitions/tax-data-order-tax-details-item-interface" + converting_from_quote: + type: boolean + taxes: + type: array + items: + "$ref": "#/definitions/tax-data-order-tax-interface" + additional_itemized_taxes: + type: array + items: + "$ref": "#/definitions/tax-data-order-tax-item-interface" + base_customer_balance_amount: + type: number + customer_balance_amount: + type: number + base_customer_balance_invoiced: + type: number + customer_balance_invoiced: + type: number + base_customer_balance_refunded: + type: number + customer_balance_refunded: + type: number + base_customer_balance_total_refunded: + type: number + customer_balance_total_refunded: + type: number + gift_cards: + type: array + items: + "$ref": "#/definitions/gift-card-account-data-gift-card-interface" + base_gift_cards_amount: + type: number + gift_cards_amount: + type: number + base_gift_cards_invoiced: + type: number + gift_cards_invoiced: + type: number + base_gift_cards_refunded: + type: number + gift_cards_refunded: + type: number + gift_message: + "$ref": "#/definitions/gift-message-data-message-interface" + gw_id: + type: string + gw_allow_gift_receipt: + type: string + gw_add_card: + type: string + gw_base_price: + type: string + gw_price: + type: string + gw_items_base_price: + type: string + gw_items_price: + type: string + gw_card_base_price: + type: string + gw_card_price: + type: string + gw_base_tax_amount: + type: string + gw_tax_amount: + type: string + gw_items_base_tax_amount: + type: string + gw_items_tax_amount: + type: string + gw_card_base_tax_amount: + type: string + gw_card_tax_amount: + type: string + gw_base_price_incl_tax: + type: string + gw_price_incl_tax: + type: string + gw_items_base_price_incl_tax: + type: string + gw_items_price_incl_tax: + type: string + gw_card_base_price_incl_tax: + type: string + gw_card_price_incl_tax: + type: string + gw_base_price_invoiced: + type: string + gw_price_invoiced: + type: string + gw_items_base_price_invoiced: + type: string + gw_items_price_invoiced: + type: string + gw_card_base_price_invoiced: + type: string + gw_card_price_invoiced: + type: string + gw_base_tax_amount_invoiced: + type: string + gw_tax_amount_invoiced: + type: string + gw_items_base_tax_invoiced: + type: string + gw_items_tax_invoiced: + type: string + gw_card_base_tax_invoiced: + type: string + gw_card_tax_invoiced: + type: string + gw_base_price_refunded: + type: string + gw_price_refunded: + type: string + gw_items_base_price_refunded: + type: string + gw_items_price_refunded: + type: string + gw_card_base_price_refunded: + type: string + gw_card_price_refunded: + type: string + gw_base_tax_amount_refunded: + type: string + gw_tax_amount_refunded: + type: string + gw_items_base_tax_refunded: + type: string + gw_items_tax_refunded: + type: string + gw_card_base_tax_refunded: + type: string + gw_card_tax_refunded: + type: string + pickup_location_code: + type: string + notification_sent: + type: integer + send_notification: + type: integer + coupon_codes: + type: array + items: + type: string + coupon_discounts: + type: array + items: + type: string + reward_points_balance: + type: integer + reward_currency_amount: + type: number + base_reward_currency_amount: + type: number + sales-data-shipping-assignment-interface: + type: object + description: Interface ShippingAssignmentInterface + properties: + shipping: + "$ref": "#/definitions/sales-data-shipping-interface" + items: + type: array + description: Order items of shipping assignment + items: + "$ref": "#/definitions/sales-data-order-item-interface" + stock_id: + type: integer + description: Stock id + extension_attributes: + "$ref": "#/definitions/sales-data-shipping-assignment-extension-interface" + required: + - shipping + - items + sales-data-shipping-interface: + type: object + description: Interface ShippingInterface + properties: + address: + "$ref": "#/definitions/sales-data-order-address-interface" + method: + type: string + description: Shipping method + total: + "$ref": "#/definitions/sales-data-total-interface" + extension_attributes: + "$ref": "#/definitions/sales-data-shipping-extension-interface" + sales-data-total-interface: + type: object + description: Interface TotalInterface + properties: + base_shipping_amount: + type: number + description: Base shipping amount. + base_shipping_canceled: + type: number + description: Base shipping canceled. + base_shipping_discount_amount: + type: number + description: Base shipping discount amount. + base_shipping_discount_tax_compensation_amnt: + type: number + description: Base shipping discount tax compensation amount. + base_shipping_incl_tax: + type: number + description: Base shipping including tax. + base_shipping_invoiced: + type: number + description: Base shipping invoiced. + base_shipping_refunded: + type: number + description: Base shipping refunded. + base_shipping_tax_amount: + type: number + description: Base shipping tax amount. + base_shipping_tax_refunded: + type: number + description: Base shipping tax refunded. + shipping_amount: + type: number + description: Shipping amount. + shipping_canceled: + type: number + description: Shipping canceled amount. + shipping_discount_amount: + type: number + description: Shipping discount amount. + shipping_discount_tax_compensation_amount: + type: number + description: Shipping discount tax compensation amount. + shipping_incl_tax: + type: number + description: Shipping including tax amount. + shipping_invoiced: + type: number + description: Shipping invoiced amount. + shipping_refunded: + type: number + description: Shipping refunded amount. + shipping_tax_amount: + type: number + description: Shipping tax amount. + shipping_tax_refunded: + type: number + description: Shipping tax refunded amount. + extension_attributes: + "$ref": "#/definitions/sales-data-total-extension-interface" + sales-data-total-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\TotalInterface + sales-data-shipping-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShippingInterface + sales-data-shipping-assignment-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShippingAssignmentInterface + payment-data-payment-additional-info-interface: + type: object + description: Payment additional info interface. + properties: + key: + type: string + description: Object key + value: + type: string + description: Object value + required: + - key + - value + company-data-company-order-interface: + type: object + description: Order company extension attributes interface. Adds new company attributes + to orders. + properties: + order_id: + type: integer + description: Order ID. + company_id: + type: integer + description: Company ID. + company_name: + type: string + description: Company name. + extension_attributes: + "$ref": "#/definitions/company-data-company-order-extension-interface" + company-data-company-order-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyOrderInterface + admin-ui-sdk-custom-fees-data-custom-fees-interface: + type: object + description: Interface CustomFeesInterface + properties: + id: + type: string + description: Id. + order_id: + type: string + description: The order id + custom_fee_code: + type: string + description: Custom fee code. + custom_fee_label: + type: string + description: Custom fee label. + custom_fee_amount: + type: number + description: Custom fee amount. + base_custom_fee_amount: + type: number + description: Base custom fee amount. + custom_fee_amount_invoiced: + type: number + description: Custom fee amount invoiced. + base_custom_fee_amount_invoiced: + type: number + description: Base custom fee amount invoiced. + custom_fee_amount_refunded: + type: number + description: Custom fee amount refunded. + base_custom_fee_amount_refunded: + type: number + description: Base custom fee amount refunded. + apply_fee_on_last_invoice: + type: boolean + description: If apply fee is set on last invoice. + apply_fee_on_last_creditmemo: + type: boolean + description: If apply fee is set on last credit memo. + invoice_id: + type: string + description: Invoice id. + creditmemo_id: + type: string + description: Credit memo id. + required: + - order_id + - custom_fee_code + - custom_fee_label + - custom_fee_amount + - base_custom_fee_amount + - custom_fee_amount_invoiced + - base_custom_fee_amount_invoiced + - custom_fee_amount_refunded + - base_custom_fee_amount_refunded + - apply_fee_on_last_invoice + - apply_fee_on_last_creditmemo + tax-data-order-tax-details-applied-tax-interface: + type: object + description: Interface OrderTaxDetailsAppliedTaxInterface + properties: + code: + type: string + description: Code + title: + type: string + description: Title + percent: + type: number + description: Tax Percent + amount: + type: number + description: Tax amount + base_amount: + type: number + description: Tax amount in base currency + extension_attributes: + "$ref": "#/definitions/tax-data-order-tax-details-applied-tax-extension-interface" + required: + - amount + - base_amount + tax-data-order-tax-details-applied-tax-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Tax\Api\Data\OrderTaxDetailsAppliedTaxInterface + properties: + rates: + type: array + items: + "$ref": "#/definitions/tax-data-applied-tax-rate-interface" + tax-data-applied-tax-rate-interface: + type: object + description: Applied tax rate interface. + properties: + code: + type: string + description: Code + title: + type: string + description: Title + percent: + type: number + description: Tax Percent + extension_attributes: + "$ref": "#/definitions/tax-data-applied-tax-rate-extension-interface" + tax-data-applied-tax-rate-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Tax\Api\Data\AppliedTaxRateInterface + tax-data-order-tax-details-item-interface: + type: object + description: Interface OrderTaxDetailsItemInterface + properties: + type: + type: string + description: Type (shipping, product, weee, gift wrapping, etc) + item_id: + type: integer + description: Item id if this item is a product + associated_item_id: + type: integer + description: Associated item id if this item is associated with another item, + null otherwise + applied_taxes: + type: array + description: Applied taxes + items: + "$ref": "#/definitions/tax-data-order-tax-details-applied-tax-interface" + extension_attributes: + "$ref": "#/definitions/tax-data-order-tax-details-item-extension-interface" + tax-data-order-tax-details-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Tax\Api\Data\OrderTaxDetailsItemInterface + tax-data-order-tax-interface: + type: object + description: '' + properties: + tax_id: + type: integer + description: Tax ID + order_id: + type: integer + description: Order ID + code: + type: string + description: Code + title: + type: string + description: Title + percent: + type: number + description: Percent + amount: + type: number + description: Amount + base_amount: + type: number + description: Tax amount in base currency + base_real_amount: + type: number + description: Real tax amount in base currency + priority: + type: integer + description: Priority + position: + type: integer + description: Position + process: + type: integer + description: Process + extension_attributes: + "$ref": "#/definitions/tax-data-order-tax-extension-interface" + required: + - percent + - amount + - base_amount + - base_real_amount + - priority + - position + - process + tax-data-order-tax-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Tax\Api\Data\OrderTaxInterface + gift-card-account-data-gift-card-interface: + type: object + description: Gift Card data + properties: + id: + type: integer + description: Id + code: + type: string + description: Code + amount: + type: number + description: Amount + base_amount: + type: number + description: Base Amount + required: + - id + - code + - amount + - base_amount + sales-data-order-search-result-interface: + type: object + description: Order search result interface. An order is a document that a web + store issues to a customer. Magento generates a sales order that lists the product + items, billing and shipping addresses, and shipping and payment methods. A corresponding + external document, known as a purchase order, is emailed to the customer. + properties: + items: + type: array + description: Array of collection items. + items: + "$ref": "#/definitions/sales-data-order-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + sales-data-order-status-history-search-result-interface: + type: object + description: Order status history search result interface. An order is a document + that a web store issues to a customer. Magento generates a sales order that + lists the product items, billing and shipping addresses, and shipping and payment + methods. A corresponding external document, known as a purchase order, is emailed + to the customer. + properties: + items: + type: array + description: Array of collection items. + items: + "$ref": "#/definitions/sales-data-order-status-history-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + sales-data-order-item-search-result-interface: + type: object + description: Order item search result interface. An order is a document that a + web store issues to a customer. Magento generates a sales order that lists the + product items, billing and shipping addresses, and shipping and payment methods. + A corresponding external document, known as a purchase order, is emailed to + the customer. + properties: + items: + type: array + description: Array of collection items. + items: + "$ref": "#/definitions/sales-data-order-item-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + sales-data-invoice-interface: + type: object + description: Invoice interface. An invoice is a record of the receipt of payment + for an order. + properties: + base_currency_code: + type: string + description: Base currency code. + base_discount_amount: + type: number + description: Base discount amount. + base_grand_total: + type: number + description: Base grand total. + base_discount_tax_compensation_amount: + type: number + description: Base discount tax compensation amount. + base_shipping_amount: + type: number + description: Base shipping amount. + base_shipping_discount_tax_compensation_amnt: + type: number + description: Base shipping discount tax compensation amount. + base_shipping_incl_tax: + type: number + description: Base shipping including tax. + base_shipping_tax_amount: + type: number + description: Base shipping tax amount. + base_subtotal: + type: number + description: Base subtotal. + base_subtotal_incl_tax: + type: number + description: Base subtotal including tax. + base_tax_amount: + type: number + description: Base tax amount. + base_total_refunded: + type: number + description: Base total refunded. + base_to_global_rate: + type: number + description: Base-to-global rate. + base_to_order_rate: + type: number + description: Base-to-order rate. + billing_address_id: + type: integer + description: Billing address ID. + can_void_flag: + type: integer + description: Can void flag value. + created_at: + type: string + description: Created-at timestamp. + discount_amount: + type: number + description: Discount amount. + discount_description: + type: string + description: Discount description. + email_sent: + type: integer + description: Email-sent flag value. + entity_id: + type: integer + description: Invoice ID. + global_currency_code: + type: string + description: Global currency code. + grand_total: + type: number + description: Grand total. + discount_tax_compensation_amount: + type: number + description: Discount tax compensation amount. + increment_id: + type: string + description: Increment ID. + is_used_for_refund: + type: integer + description: Is-used-for-refund flag value. + order_currency_code: + type: string + description: Order currency code. + order_id: + type: integer + description: Order ID. + shipping_address_id: + type: integer + description: Shipping address ID. + shipping_amount: + type: number + description: Shipping amount. + shipping_discount_tax_compensation_amount: + type: number + description: Shipping discount tax compensation amount. + shipping_incl_tax: + type: number + description: Shipping including tax. + shipping_tax_amount: + type: number + description: Shipping tax amount. + state: + type: integer + description: State. + store_currency_code: + type: string + description: Store currency code. + store_id: + type: integer + description: Store ID. + store_to_base_rate: + type: number + description: Store-to-base rate. + store_to_order_rate: + type: number + description: Store-to-order rate. + subtotal: + type: number + description: Subtotal. + subtotal_incl_tax: + type: number + description: Subtotal including tax. + tax_amount: + type: number + description: Tax amount. + total_qty: + type: number + description: Total quantity. + transaction_id: + type: string + description: Transaction ID. + updated_at: + type: string + description: Updated-at timestamp. + items: + type: array + description: Array of invoice items. + items: + "$ref": "#/definitions/sales-data-invoice-item-interface" + comments: + type: array + description: Array of any invoice comments. Otherwise, null. + items: + "$ref": "#/definitions/sales-data-invoice-comment-interface" + extension_attributes: + "$ref": "#/definitions/sales-data-invoice-extension-interface" + required: + - order_id + - total_qty + - items + sales-data-invoice-item-interface: + type: object + description: Invoice item interface. An invoice is a record of the receipt of + payment for an order. An invoice item is a purchased item in an invoice. + properties: + additional_data: + type: string + description: Additional data. + base_cost: + type: number + description: Base cost. + base_discount_amount: + type: number + description: Base discount amount. + base_discount_tax_compensation_amount: + type: number + description: Base discount tax compensation amount. + base_price: + type: number + description: Base price. + base_price_incl_tax: + type: number + description: Base price including tax. + base_row_total: + type: number + description: Base row total. + base_row_total_incl_tax: + type: number + description: Base row total including tax. + base_tax_amount: + type: number + description: Base tax amount. + description: + type: string + description: Description. + discount_amount: + type: number + description: Discount amount. + entity_id: + type: integer + description: Invoice item ID. + discount_tax_compensation_amount: + type: number + description: Discount tax compensation amount. + name: + type: string + description: Name. + parent_id: + type: integer + description: Parent ID. + price: + type: number + description: Price. + price_incl_tax: + type: number + description: Price including tax. + product_id: + type: integer + description: Product ID. + row_total: + type: number + description: Row total. + row_total_incl_tax: + type: number + description: Row total including tax. + sku: + type: string + description: SKU. + tax_amount: + type: number + description: Tax amount. + extension_attributes: + "$ref": "#/definitions/sales-data-invoice-item-extension-interface" + order_item_id: + type: integer + description: Order item ID. + qty: + type: number + description: Quantity. + required: + - sku + - order_item_id + - qty + sales-data-invoice-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceItemInterface + sales-data-invoice-comment-interface: + type: object + description: Invoice comment interface. An invoice is a record of the receipt + of payment for an order. An invoice can include comments that detail the invoice + history. + properties: + is_customer_notified: + type: integer + description: Is-customer-notified flag value. + parent_id: + type: integer + description: Parent ID. + extension_attributes: + "$ref": "#/definitions/sales-data-invoice-comment-extension-interface" + comment: + type: string + description: Comment. + is_visible_on_front: + type: integer + description: Is-visible-on-storefront flag value. + created_at: + type: string + description: Created-at timestamp. + entity_id: + type: integer + description: Invoice ID. + required: + - is_customer_notified + - parent_id + - comment + - is_visible_on_front + sales-data-invoice-comment-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceCommentInterface + sales-data-invoice-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceInterface + properties: + base_customer_balance_amount: + type: number + customer_balance_amount: + type: number + base_gift_cards_amount: + type: number + gift_cards_amount: + type: number + gw_base_price: + type: string + gw_price: + type: string + gw_items_base_price: + type: string + gw_items_price: + type: string + gw_card_base_price: + type: string + gw_card_price: + type: string + gw_base_tax_amount: + type: string + gw_tax_amount: + type: string + gw_items_base_tax_amount: + type: string + gw_items_tax_amount: + type: string + gw_card_base_tax_amount: + type: string + gw_card_tax_amount: + type: string + sales-data-invoice-search-result-interface: + type: object + description: Invoice search result interface. An invoice is a record of the receipt + of payment for an order. + properties: + items: + type: array + description: Array of collection items. + items: + "$ref": "#/definitions/sales-data-invoice-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + sales-data-invoice-comment-search-result-interface: + type: object + description: Invoice comment search result interface. An invoice is a record of + the receipt of payment for an order. An invoice can include comments that detail + the invoice history. + properties: + items: + type: array + description: Array of collection items. + items: + "$ref": "#/definitions/sales-data-invoice-comment-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + sales-data-creditmemo-item-creation-interface: + type: object + description: Interface CreditmemoItemCreationInterface + properties: + extension_attributes: + "$ref": "#/definitions/sales-data-creditmemo-item-creation-extension-interface" + order_item_id: + type: integer + description: Order item ID. + qty: + type: number + description: Quantity. + required: + - order_item_id + - qty + sales-data-creditmemo-item-creation-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoItemCreationInterface + sales-data-creditmemo-comment-creation-interface: + type: object + description: Interface CreditmemoCommentCreationInterface + properties: + extension_attributes: + "$ref": "#/definitions/sales-data-creditmemo-comment-creation-extension-interface" + comment: + type: string + description: Comment. + is_visible_on_front: + type: integer + description: Is-visible-on-storefront flag value. + required: + - comment + - is_visible_on_front + sales-data-creditmemo-comment-creation-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoCommentCreationInterface + sales-data-creditmemo-creation-arguments-interface: + type: object + description: Interface CreditmemoCreationArgumentsInterface + properties: + shipping_amount: + type: number + description: Credit memo shipping amount. + adjustment_positive: + type: number + description: Credit memo positive adjustment. + adjustment_negative: + type: number + description: Credit memo negative adjustment. + extension_attributes: + "$ref": "#/definitions/sales-data-creditmemo-creation-arguments-extension-interface" + sales-data-creditmemo-creation-arguments-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoCreationArgumentsInterface + properties: + return_to_stock_items: + type: array + items: + type: integer + sales-data-creditmemo-comment-search-result-interface: + type: object + description: Credit memo comment search result interface. After a customer places + and pays for an order and an invoice has been issued, the merchant can create + a credit memo to refund all or part of the amount paid for any returned or undelivered + items. The memo restores funds to the customer account so that the customer + can make future purchases. A credit memo usually includes comments that detail + why the credit memo amount was credited to the customer. + properties: + items: + type: array + description: Array of collection items. + items: + "$ref": "#/definitions/sales-data-creditmemo-comment-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + sales-data-creditmemo-comment-interface: + type: object + description: Credit memo comment interface. After a customer places and pays for + an order and an invoice has been issued, the merchant can create a credit memo + to refund all or part of the amount paid for any returned or undelivered items. + The memo restores funds to the customer account so that the customer can make + future purchases. A credit memo usually includes comments that detail why the + credit memo amount was credited to the customer. + properties: + comment: + type: string + description: Comment. + created_at: + type: string + description: Created-at timestamp. + entity_id: + type: integer + description: Credit memo ID. + is_customer_notified: + type: integer + description: Is-customer-notified flag value. + is_visible_on_front: + type: integer + description: Is-visible-on-storefront flag value. + parent_id: + type: integer + description: Parent ID. + extension_attributes: + "$ref": "#/definitions/sales-data-creditmemo-comment-extension-interface" + required: + - comment + - is_customer_notified + - is_visible_on_front + - parent_id + sales-data-creditmemo-comment-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoCommentInterface + sales-data-creditmemo-interface: + type: object + description: Credit memo interface. After a customer places and pays for an order + and an invoice has been issued, the merchant can create a credit memo to refund + all or part of the amount paid for any returned or undelivered items. The memo + restores funds to the customer account so that the customer can make future + purchases. + properties: + adjustment: + type: number + description: Credit memo adjustment. + adjustment_negative: + type: number + description: Credit memo negative adjustment. + adjustment_positive: + type: number + description: Credit memo positive adjustment. + base_adjustment: + type: number + description: Credit memo base adjustment. + base_adjustment_negative: + type: number + description: Credit memo negative base adjustment. + base_adjustment_positive: + type: number + description: Credit memo positive base adjustment. + base_currency_code: + type: string + description: Credit memo base currency code. + base_discount_amount: + type: number + description: Credit memo base discount amount. + base_grand_total: + type: number + description: Credit memo base grand total. + base_discount_tax_compensation_amount: + type: number + description: Credit memo base discount tax compensation amount. + base_shipping_amount: + type: number + description: Credit memo base shipping amount. + base_shipping_discount_tax_compensation_amnt: + type: number + description: Credit memo base shipping discount tax compensation amount. + base_shipping_incl_tax: + type: number + description: Credit memo base shipping including tax. + base_shipping_tax_amount: + type: number + description: Credit memo base shipping tax amount. + base_subtotal: + type: number + description: Credit memo base subtotal. + base_subtotal_incl_tax: + type: number + description: Credit memo base subtotal including tax. + base_tax_amount: + type: number + description: Credit memo base tax amount. + base_to_global_rate: + type: number + description: Credit memo base-to-global rate. + base_to_order_rate: + type: number + description: Credit memo base-to-order rate. + billing_address_id: + type: integer + description: Credit memo billing address ID. + created_at: + type: string + description: Credit memo created-at timestamp. + creditmemo_status: + type: integer + description: Credit memo status. + discount_amount: + type: number + description: Credit memo discount amount. + discount_description: + type: string + description: Credit memo discount description. + email_sent: + type: integer + description: Credit memo email sent flag value. + entity_id: + type: integer + description: Credit memo ID. + global_currency_code: + type: string + description: Credit memo global currency code. + grand_total: + type: number + description: Credit memo grand total. + discount_tax_compensation_amount: + type: number + description: Credit memo discount tax compensation amount. + increment_id: + type: string + description: Credit memo increment ID. + invoice_id: + type: integer + description: Credit memo invoice ID. + order_currency_code: + type: string + description: Credit memo order currency code. + order_id: + type: integer + description: Credit memo order ID. + shipping_address_id: + type: integer + description: Credit memo shipping address ID. + shipping_amount: + type: number + description: Credit memo shipping amount. + shipping_discount_tax_compensation_amount: + type: number + description: Credit memo shipping discount tax compensation amount. + shipping_incl_tax: + type: number + description: Credit memo shipping including tax. + shipping_tax_amount: + type: number + description: Credit memo shipping tax amount. + state: + type: integer + description: Credit memo state. + store_currency_code: + type: string + description: Credit memo store currency code. + store_id: + type: integer + description: Credit memo store ID. + store_to_base_rate: + type: number + description: Credit memo store-to-base rate. + store_to_order_rate: + type: number + description: Credit memo store-to-order rate. + subtotal: + type: number + description: Credit memo subtotal. + subtotal_incl_tax: + type: number + description: Credit memo subtotal including tax. + tax_amount: + type: number + description: Credit memo tax amount. + transaction_id: + type: string + description: Credit memo transaction ID. + updated_at: + type: string + description: Credit memo updated-at timestamp. + items: + type: array + description: Array of credit memo items. + items: + "$ref": "#/definitions/sales-data-creditmemo-item-interface" + comments: + type: array + description: Array of any credit memo comments. Otherwise, null. + items: + "$ref": "#/definitions/sales-data-creditmemo-comment-interface" + extension_attributes: + "$ref": "#/definitions/sales-data-creditmemo-extension-interface" + required: + - order_id + - items + sales-data-creditmemo-item-interface: + type: object + description: Credit memo item interface. After a customer places and pays for + an order and an invoice has been issued, the merchant can create a credit memo + to refund all or part of the amount paid for any returned or undelivered items. + The memo restores funds to the customer account so that the customer can make + future purchases. A credit memo item is an invoiced item for which a merchant + creates a credit memo. + properties: + additional_data: + type: string + description: Additional data. + base_cost: + type: number + description: The base cost for a credit memo item. + base_discount_amount: + type: number + description: The base discount amount for a credit memo item. + base_discount_tax_compensation_amount: + type: number + description: The base discount tax compensation amount for a credit memo item. + base_price: + type: number + description: The base price for a credit memo item. + base_price_incl_tax: + type: number + description: Base price including tax. + base_row_total: + type: number + description: Base row total. + base_row_total_incl_tax: + type: number + description: Base row total including tax. + base_tax_amount: + type: number + description: Base tax amount. + base_weee_tax_applied_amount: + type: number + description: Base WEEE tax applied amount. + base_weee_tax_applied_row_amnt: + type: number + description: Base WEEE tax applied row amount. + base_weee_tax_disposition: + type: number + description: Base WEEE tax disposition. + base_weee_tax_row_disposition: + type: number + description: Base WEEE tax row disposition. + description: + type: string + description: Description. + discount_amount: + type: number + description: Discount amount. + entity_id: + type: integer + description: Credit memo item ID. + discount_tax_compensation_amount: + type: number + description: Discount tax compensation amount. + name: + type: string + description: Name. + order_item_id: + type: integer + description: Order item ID. + parent_id: + type: integer + description: Parent ID. + price: + type: number + description: Price. + price_incl_tax: + type: number + description: Price including tax. + product_id: + type: integer + description: Product ID. + qty: + type: number + description: Quantity. + row_total: + type: number + description: Row total. + row_total_incl_tax: + type: number + description: Row total including tax. + sku: + type: string + description: SKU. + tax_amount: + type: number + description: Tax amount. + weee_tax_applied: + type: string + description: WEEE tax applied. + weee_tax_applied_amount: + type: number + description: WEEE tax applied amount. + weee_tax_applied_row_amount: + type: number + description: WEEE tax applied row amount. + weee_tax_disposition: + type: number + description: WEEE tax disposition. + weee_tax_row_disposition: + type: number + description: WEEE tax row disposition. + extension_attributes: + "$ref": "#/definitions/sales-data-creditmemo-item-extension-interface" + required: + - base_cost + - base_price + - entity_id + - order_item_id + - qty + sales-data-creditmemo-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoItemInterface + sales-data-creditmemo-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoInterface + properties: + base_customer_balance_amount: + type: number + customer_balance_amount: + type: number + base_gift_cards_amount: + type: number + gift_cards_amount: + type: number + gw_base_price: + type: string + gw_price: + type: string + gw_items_base_price: + type: string + gw_items_price: + type: string + gw_card_base_price: + type: string + gw_card_price: + type: string + gw_base_tax_amount: + type: string + gw_tax_amount: + type: string + gw_items_base_tax_amount: + type: string + gw_items_tax_amount: + type: string + gw_card_base_tax_amount: + type: string + gw_card_tax_amount: + type: string + sales-data-creditmemo-search-result-interface: + type: object + description: Credit memo search result interface. After a customer places and + pays for an order and an invoice has been issued, the merchant can create a + credit memo to refund all or part of the amount paid for any returned or undelivered + items. The memo restores funds to the customer account so that the customer + can make future purchases. + properties: + items: + type: array + description: Array of collection items. + items: + "$ref": "#/definitions/sales-data-creditmemo-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + sales-data-shipment-interface: + type: object + description: Shipment interface. A shipment is a delivery package that contains + products. A shipment document accompanies the shipment. This document lists + the products and their quantities in the delivery package. This interface creates + shipment record without items quantity (total_qty) validation. To validate total + shipped quantity for each item in the order you must use newer `POST /V1/order/:orderId/ship` + endpoint. + properties: + billing_address_id: + type: integer + description: Billing address ID. + created_at: + type: string + description: Created-at timestamp. + customer_id: + type: integer + description: Customer ID. + email_sent: + type: integer + description: Email-sent flag value. + entity_id: + type: integer + description: Shipment ID. + increment_id: + type: string + description: Increment ID. + order_id: + type: integer + description: Order ID. + packages: + type: array + description: Array of packages, if any. Otherwise, null. + items: + "$ref": "#/definitions/sales-data-shipment-package-interface" + shipment_status: + type: integer + description: Shipment status. + shipping_address_id: + type: integer + description: Shipping address ID. + shipping_label: + type: string + description: Shipping label. + store_id: + type: integer + description: Store ID. + total_qty: + type: number + description: Total quantity. + total_weight: + type: number + description: Total weight. + updated_at: + type: string + description: Updated-at timestamp. + items: + type: array + description: Array of items. + items: + "$ref": "#/definitions/sales-data-shipment-item-interface" + tracks: + type: array + description: Array of tracks. + items: + "$ref": "#/definitions/sales-data-shipment-track-interface" + comments: + type: array + description: Array of comments. + items: + "$ref": "#/definitions/sales-data-shipment-comment-interface" + extension_attributes: + "$ref": "#/definitions/sales-data-shipment-extension-interface" + required: + - order_id + - items + - tracks + - comments + sales-data-shipment-package-interface: + type: object + description: Shipment package interface. A shipment is a delivery package that + contains products. A shipment document accompanies the shipment. This document + lists the products and their quantities in the delivery package. + properties: + extension_attributes: + "$ref": "#/definitions/sales-data-shipment-package-extension-interface" + sales-data-shipment-package-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentPackageInterface + sales-data-shipment-item-interface: + type: object + description: Shipment item interface. A shipment is a delivery package that contains + products. A shipment document accompanies the shipment. This document lists + the products and their quantities in the delivery package. A product is an item + in a shipment. + properties: + additional_data: + type: string + description: Additional data. + description: + type: string + description: Description. + entity_id: + type: integer + description: Shipment item ID. + name: + type: string + description: Name. + parent_id: + type: integer + description: Parent ID. + price: + type: number + description: Price. + product_id: + type: integer + description: Product ID. + row_total: + type: number + description: Row total. + sku: + type: string + description: SKU. + weight: + type: number + description: Weight. + extension_attributes: + "$ref": "#/definitions/sales-data-shipment-item-extension-interface" + order_item_id: + type: integer + description: Order item ID. + qty: + type: number + description: Quantity. + required: + - order_item_id + - qty + sales-data-shipment-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentItemInterface + sales-data-shipment-track-interface: + type: object + description: Shipment track interface. A shipment is a delivery package that contains + products. A shipment document accompanies the shipment. This document lists + the products and their quantities in the delivery package. Merchants and customers + can track shipments. + properties: + order_id: + type: integer + description: The order_id for the shipment package. + created_at: + type: string + description: Created-at timestamp. + entity_id: + type: integer + description: Shipment package ID. + parent_id: + type: integer + description: Parent ID. + updated_at: + type: string + description: Updated-at timestamp. + weight: + type: number + description: Weight. + qty: + type: number + description: Quantity. + description: + type: string + description: Description. + extension_attributes: + "$ref": "#/definitions/sales-data-shipment-track-extension-interface" + track_number: + type: string + description: Track number. + title: + type: string + description: Title. + carrier_code: + type: string + description: Carrier code. + required: + - order_id + - parent_id + - weight + - qty + - description + - track_number + - title + - carrier_code + sales-data-shipment-track-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentTrackInterface + sales-data-shipment-comment-interface: + type: object + description: Shipment comment interface. A shipment is a delivery package that + contains products. A shipment document accompanies the shipment. This document + lists the products and their quantities in the delivery package. A shipment + document can contain comments. + properties: + is_customer_notified: + type: integer + description: Is-customer-notified flag value. + parent_id: + type: integer + description: Parent ID. + extension_attributes: + "$ref": "#/definitions/sales-data-shipment-comment-extension-interface" + comment: + type: string + description: Comment. + is_visible_on_front: + type: integer + description: Is-visible-on-storefront flag value. + created_at: + type: string + description: Created-at timestamp. + entity_id: + type: integer + description: Invoice ID. + required: + - is_customer_notified + - parent_id + - comment + - is_visible_on_front + sales-data-shipment-comment-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentCommentInterface + sales-data-shipment-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentInterface + properties: + source_code: + type: string + sales-data-shipment-search-result-interface: + type: object + description: Shipment search result interface. A shipment is a delivery package + that contains products. A shipment document accompanies the shipment. This document + lists the products and their quantities in the delivery package. + properties: + items: + type: array + description: Array of collection items. + items: + "$ref": "#/definitions/sales-data-shipment-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + sales-data-shipment-comment-search-result-interface: + type: object + description: Shipment comment search result interface. A shipment is a delivery + package that contains products. A shipment document accompanies the shipment. + This document lists the products and their quantities in the delivery package. + A shipment document can contain comments. + properties: + items: + type: array + description: Array of collection items. + items: + "$ref": "#/definitions/sales-data-shipment-comment-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + sales-data-shipment-item-creation-interface: + type: object + description: Input argument for shipment item creation Interface ShipmentItemCreationInterface + properties: + extension_attributes: + "$ref": "#/definitions/sales-data-shipment-item-creation-extension-interface" + order_item_id: + type: integer + description: Order item ID. + qty: + type: number + description: Quantity. + required: + - order_item_id + - qty + sales-data-shipment-item-creation-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentItemCreationInterface + sales-data-shipment-comment-creation-interface: + type: object + description: Interface ShipmentCommentCreationInterface + properties: + extension_attributes: + "$ref": "#/definitions/sales-data-shipment-comment-creation-extension-interface" + comment: + type: string + description: Comment. + is_visible_on_front: + type: integer + description: Is-visible-on-storefront flag value. + required: + - comment + - is_visible_on_front + sales-data-shipment-comment-creation-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentCommentCreationInterface + sales-data-shipment-track-creation-interface: + type: object + description: Shipment Track Creation interface. + properties: + extension_attributes: + "$ref": "#/definitions/sales-data-shipment-track-creation-extension-interface" + track_number: + type: string + description: Track number. + title: + type: string + description: Title. + carrier_code: + type: string + description: Carrier code. + required: + - track_number + - title + - carrier_code + sales-data-shipment-track-creation-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentTrackCreationInterface + sales-data-shipment-package-creation-interface: + type: object + description: Shipment package interface. A shipment is a delivery package that + contains products. A shipment document accompanies the shipment. This document + lists the products and their quantities in the delivery package. + properties: + extension_attributes: + "$ref": "#/definitions/sales-data-shipment-package-creation-extension-interface" + sales-data-shipment-package-creation-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentPackageCreationInterface + sales-data-shipment-creation-arguments-interface: + type: object + description: Interface for creation arguments for Shipment. + properties: + extension_attributes: + "$ref": "#/definitions/sales-data-shipment-creation-arguments-extension-interface" + sales-data-shipment-creation-arguments-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\ShipmentCreationArgumentsInterface + properties: + source_code: + type: string + sales-data-transaction-interface: + type: object + description: Transaction interface. A transaction is an interaction between a + merchant and a customer such as a purchase, a credit, a refund, and so on. + properties: + transaction_id: + type: integer + description: Transaction ID. + parent_id: + type: integer + description: The parent ID for the transaction. Otherwise, null. + order_id: + type: integer + description: Order ID. + payment_id: + type: integer + description: Payment ID. + txn_id: + type: string + description: Transaction business ID. + parent_txn_id: + type: string + description: Parent transaction business ID. + txn_type: + type: string + description: Transaction type. + is_closed: + type: integer + description: Is-closed flag value. + additional_information: + type: array + description: Array of additional information. Otherwise, null. + items: + type: string + created_at: + type: string + description: Created-at timestamp. + child_transactions: + type: array + description: Array of child transactions. + items: + "$ref": "#/definitions/sales-data-transaction-interface" + extension_attributes: + "$ref": "#/definitions/sales-data-transaction-extension-interface" + required: + - transaction_id + - order_id + - payment_id + - txn_id + - parent_txn_id + - txn_type + - is_closed + - created_at + - child_transactions + sales-data-transaction-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\TransactionInterface + sales-data-transaction-search-result-interface: + type: object + description: Transaction search result interface. A transaction is an interaction + between a merchant and a customer such as a purchase, a credit, a refund, and + so on. + properties: + items: + type: array + description: Array of collection items. + items: + "$ref": "#/definitions/sales-data-transaction-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + sales-data-invoice-item-creation-interface: + type: object + description: Input argument for invoice creation Interface InvoiceItemCreationInterface + properties: + extension_attributes: + "$ref": "#/definitions/sales-data-invoice-item-creation-extension-interface" + order_item_id: + type: integer + description: Order item ID. + qty: + type: number + description: Quantity. + required: + - order_item_id + - qty + sales-data-invoice-item-creation-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceItemCreationInterface + sales-data-invoice-comment-creation-interface: + type: object + description: Interface InvoiceCommentCreationInterface + properties: + extension_attributes: + "$ref": "#/definitions/sales-data-invoice-comment-creation-extension-interface" + comment: + type: string + description: Comment. + is_visible_on_front: + type: integer + description: Is-visible-on-storefront flag value. + required: + - comment + - is_visible_on_front + sales-data-invoice-comment-creation-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceCommentCreationInterface + sales-data-invoice-creation-arguments-interface: + type: object + description: Interface for creation arguments for Invoice. + properties: + extension_attributes: + "$ref": "#/definitions/sales-data-invoice-creation-arguments-extension-interface" + sales-data-invoice-creation-arguments-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceCreationArgumentsInterface + sales-rule-data-rule-interface: + type: object + description: Interface RuleInterface + properties: + rule_id: + type: integer + description: Rule id + name: + type: string + description: Rule name + store_labels: + type: array + description: Display label + items: + "$ref": "#/definitions/sales-rule-data-rule-label-interface" + description: + type: string + description: Description + website_ids: + type: array + description: A list of websites the rule applies to + items: + type: integer + customer_group_ids: + type: array + description: Ids of customer groups that the rule applies to + items: + type: integer + from_date: + type: string + description: The start date when the coupon is active + to_date: + type: string + description: The end date when the coupon is active + uses_per_customer: + type: integer + description: Number of uses per customer + is_active: + type: boolean + description: The coupon is active + condition: + "$ref": "#/definitions/sales-rule-data-condition-interface" + action_condition: + "$ref": "#/definitions/sales-rule-data-condition-interface" + stop_rules_processing: + type: boolean + description: To stop rule processing + is_advanced: + type: boolean + description: Is this field needed + product_ids: + type: array + description: Product ids + items: + type: integer + sort_order: + type: integer + description: Sort order + simple_action: + type: string + description: Simple action of the rule + discount_amount: + type: number + description: Discount amount + discount_qty: + type: number + description: Maximum qty discount is applied + discount_step: + type: integer + description: Discount step + apply_to_shipping: + type: boolean + description: The rule applies to shipping + times_used: + type: integer + description: How many times the rule has been used + is_rss: + type: boolean + description: Whether the rule is in RSS + coupon_type: + type: string + description: Coupon type + use_auto_generation: + type: boolean + description: To auto generate coupon + uses_per_coupon: + type: integer + description: Limit of uses per coupon + simple_free_shipping: + type: string + description: To grant free shipping + extension_attributes: + "$ref": "#/definitions/sales-rule-data-rule-extension-interface" + required: + - website_ids + - customer_group_ids + - uses_per_customer + - is_active + - stop_rules_processing + - is_advanced + - sort_order + - discount_amount + - discount_step + - apply_to_shipping + - times_used + - is_rss + - coupon_type + - use_auto_generation + - uses_per_coupon + sales-rule-data-rule-label-interface: + type: object + description: Interface RuleLabelInterface + properties: + store_id: + type: integer + description: StoreId + store_label: + type: string + description: The label for the store + extension_attributes: + "$ref": "#/definitions/sales-rule-data-rule-label-extension-interface" + required: + - store_id + - store_label + sales-rule-data-rule-label-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\SalesRule\Api\Data\RuleLabelInterface + sales-rule-data-condition-interface: + type: object + description: Interface ConditionInterface + properties: + condition_type: + type: string + description: Condition type + conditions: + type: array + description: List of conditions + items: + "$ref": "#/definitions/sales-rule-data-condition-interface" + aggregator_type: + type: string + description: The aggregator type + operator: + type: string + description: The operator of the condition + attribute_name: + type: string + description: The attribute name of the condition + value: + type: string + description: The value of the condition + extension_attributes: + "$ref": "#/definitions/sales-rule-data-condition-extension-interface" + required: + - condition_type + - operator + - value + sales-rule-data-condition-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\SalesRule\Api\Data\ConditionInterface + sales-rule-data-rule-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\SalesRule\Api\Data\RuleInterface + properties: + reward_points_delta: + type: integer + sales-rule-data-rule-search-result-interface: + type: object + description: '' + properties: + items: + type: array + description: Rules. + items: + "$ref": "#/definitions/sales-rule-data-rule-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + sales-rule-data-coupon-interface: + type: object + description: Interface CouponInterface + properties: + coupon_id: + type: integer + description: Coupon id + rule_id: + type: integer + description: The id of the rule associated with the coupon + code: + type: string + description: Coupon code + usage_limit: + type: integer + description: Usage limit + usage_per_customer: + type: integer + description: Usage limit per customer + times_used: + type: integer + description: The number of times the coupon has been used + expiration_date: + type: string + description: Expiration date + is_primary: + type: boolean + description: The coupon is primary coupon for the rule that it's associated + with + created_at: + type: string + description: When the coupon is created + type: + type: integer + description: Of coupon + extension_attributes: + "$ref": "#/definitions/sales-rule-data-coupon-extension-interface" + required: + - rule_id + - times_used + - is_primary + sales-rule-data-coupon-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\SalesRule\Api\Data\CouponInterface + sales-rule-data-coupon-search-result-interface: + type: object + description: '' + properties: + items: + type: array + description: Rules. + items: + "$ref": "#/definitions/sales-rule-data-coupon-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + sales-rule-data-coupon-generation-spec-interface: + type: object + description: CouponGenerationSpecInterface + properties: + rule_id: + type: integer + description: The id of the rule associated with the coupon + format: + type: string + description: Format of generated coupon code + quantity: + type: integer + description: Of coupons to generate + length: + type: integer + description: Length of coupon code + prefix: + type: string + description: The prefix + suffix: + type: string + description: The suffix + delimiter_at_every: + type: integer + description: The spacing where the delimiter should exist + delimiter: + type: string + description: The delimiter + extension_attributes: + "$ref": "#/definitions/sales-rule-data-coupon-generation-spec-extension-interface" + required: + - rule_id + - format + - quantity + - length + sales-rule-data-coupon-generation-spec-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\SalesRule\Api\Data\CouponGenerationSpecInterface + sales-rule-data-coupon-mass-delete-result-interface: + type: object + description: Coupon mass delete results interface. + properties: + failed_items: + type: array + description: List of failed items. + items: + type: string + missing_items: + type: array + description: List of missing items. + items: + type: string + required: + - failed_items + - missing_items + bundle-data-option-type-interface: + type: object + description: Interface OptionTypeInterface + properties: + label: + type: string + description: Type label + code: + type: string + description: Type code + extension_attributes: + "$ref": "#/definitions/bundle-data-option-type-extension-interface" + required: + - label + - code + bundle-data-option-type-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\OptionTypeInterface + requisition-list-data-requisition-list-interface: + type: object + description: Interface RequisitionListInterface + properties: + id: + type: integer + description: Requisition List ID + customer_id: + type: integer + description: Customer ID + name: + type: string + description: Requisition List Name + updated_at: + type: string + description: Requisition List Update Time + description: + type: string + description: Requisition List Description + items: + type: array + description: Requisition List Items + items: + "$ref": "#/definitions/requisition-list-data-requisition-list-item-interface" + extension_attributes: + "$ref": "#/definitions/requisition-list-data-requisition-list-extension-interface" + required: + - id + - customer_id + - name + - updated_at + - description + - items + requisition-list-data-requisition-list-item-interface: + type: object + description: Interface RequisitionListItemInterface + properties: + id: + type: integer + description: Requisition List ID. + sku: + type: string + description: Product SKU. + requisition_list_id: + type: integer + description: Requisition List ID. + qty: + type: number + description: Product Qty. + options: + type: array + description: Requisition list item options. + items: + type: string + store_id: + type: integer + description: Store ID. + added_at: + type: string + description: Added_at value. + extension_attributes: + "$ref": "#/definitions/requisition-list-data-requisition-list-item-extension-interface" + required: + - id + - sku + - requisition_list_id + - qty + - options + - store_id + - added_at + requisition-list-data-requisition-list-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListItemInterface + requisition-list-data-requisition-list-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListInterface + checkout-data-shipping-information-interface: + type: object + description: Interface ShippingInformationInterface + properties: + shipping_address: + "$ref": "#/definitions/quote-data-address-interface" + billing_address: + "$ref": "#/definitions/quote-data-address-interface" + shipping_method_code: + type: string + description: Shipping method code + shipping_carrier_code: + type: string + description: Carrier code + extension_attributes: + "$ref": "#/definitions/checkout-data-shipping-information-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + required: + - shipping_address + - shipping_method_code + - shipping_carrier_code + checkout-data-shipping-information-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\ShippingInformationInterface + checkout-data-payment-details-interface: + type: object + description: Interface PaymentDetailsInterface + properties: + payment_methods: + type: array + items: + "$ref": "#/definitions/quote-data-payment-method-interface" + totals: + "$ref": "#/definitions/quote-data-totals-interface" + extension_attributes: + "$ref": "#/definitions/checkout-data-payment-details-extension-interface" + required: + - payment_methods + - totals + checkout-data-payment-details-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\PaymentDetailsInterface + checkout-data-totals-information-interface: + type: object + description: Interface TotalsInformationInterface + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + shipping_method_code: + type: string + description: Shipping method code + shipping_carrier_code: + type: string + description: Carrier code + extension_attributes: + "$ref": "#/definitions/checkout-data-totals-information-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + required: + - address + checkout-data-totals-information-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\TotalsInformationInterface + commerce-backend-uix-data-mass-action-failed-request-interface: + type: object + description: Defines the mass actions failed requests database model + properties: + id: + type: string + description: Internal id + request_id: + type: string + description: Request id + action_id: + type: string + description: Action id + grid_type: + type: string + description: Ui grid type + error_status: + type: string + description: Error status + error_message: + type: string + description: Error message + request_timestamp: + type: string + description: Request timestamp + selected_ids: + type: string + description: Selected ids + required: + - request_id + - action_id + - grid_type + - error_status + - error_message + - request_timestamp + - selected_ids + commerce-backend-uix-data-order-view-button-failed-request-interface: + type: object + description: Defines the order view button failed requests database model + properties: + id: + type: string + description: Internal id + request_id: + type: string + description: Request id + button_id: + type: string + description: Button id + order_id: + type: string + description: Order id + error_status: + type: string + description: Error status + error_message: + type: string + description: Error message + request_timestamp: + type: string + description: Request timestamp + required: + - request_id + - button_id + - order_id + - error_status + - error_message + - request_timestamp + commerce-backend-uix-data-app-management-validation-result-interface: + type: object + description: App Management User Validation Result Interface + properties: + authorized: + type: boolean + description: Authorization status + required: + - authorized + company-data-company-search-results-interface: + type: object + description: Interface for company search results + properties: + items: + type: array + description: Companies list + items: + "$ref": "#/definitions/company-data-company-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + company-data-company-interface: + type: object + description: Interface for Company entity. + properties: + id: + type: integer + description: Id. + status: + type: integer + description: Status. + company_name: + type: string + description: Company name. + legal_name: + type: string + description: Legal name. + company_email: + type: string + description: Company email. + vat_tax_id: + type: string + description: Vat tax id. + reseller_id: + type: string + description: Reseller Id. + comment: + type: string + description: Comment. + street: + type: array + description: Street. + items: + type: string + city: + type: string + description: City. + country_id: + type: string + description: Country. + region: + type: string + description: Region. + region_id: + type: string + description: Region Id. + postcode: + type: string + description: Postcode. + telephone: + type: string + description: Telephone. + customer_group_id: + type: integer + description: Customer Group Id. + sales_representative_id: + type: integer + description: Sales Representative Id. + reject_reason: + type: string + description: Reject Reason. + rejected_at: + type: string + description: Rejected at time. + super_user_id: + type: integer + description: Company admin customer id. + extension_attributes: + "$ref": "#/definitions/company-data-company-extension-interface" + required: + - street + - customer_group_id + - sales_representative_id + - reject_reason + - rejected_at + - super_user_id + company-data-company-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyInterface + properties: + applicable_payment_method: + type: integer + available_payment_methods: + type: string + use_config_settings: + type: integer + quote_config: + "$ref": "#/definitions/negotiable-quote-data-company-quote-config-interface" + is_purchase_order_enabled: + type: boolean + applicable_shipping_method: + type: integer + available_shipping_methods: + type: string + use_config_settings_shipping: + type: integer + negotiable-quote-data-company-quote-config-interface: + type: object + description: Interface CompanyQuoteConfigInterface + properties: + company_id: + type: string + description: Company id + is_quote_enabled: + type: boolean + description: Quote enabled for company + extension_attributes: + "$ref": "#/definitions/negotiable-quote-data-company-quote-config-extension-interface" + required: + - is_quote_enabled + negotiable-quote-data-company-quote-config-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\CompanyQuoteConfigInterface + company-data-team-search-results-interface: + type: object + description: Interface for company team search results + properties: + items: + type: array + description: Teams list + items: + "$ref": "#/definitions/company-data-team-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + company-data-team-interface: + type: object + description: Team custom attributes management + properties: + id: + type: integer + description: ID + name: + type: string + description: Name + description: + type: string + description: Description + extension_attributes: + "$ref": "#/definitions/company-data-team-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + company-data-team-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Company\Api\Data\TeamInterface + company-data-hierarchy-interface: + type: object + description: Company hierarchy DTO interface for WebAPI. + properties: + structure_id: + type: integer + description: Structure ID. + entity_id: + type: integer + description: Entity ID. + entity_type: + type: string + description: Entity type. + structure_parent_id: + type: integer + description: Structure parent ID. + extension_attributes: + "$ref": "#/definitions/company-data-hierarchy-extension-interface" + company-data-hierarchy-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Company\Api\Data\HierarchyInterface + company-data-role-search-results-interface: + type: object + description: Interface for role search results. + properties: + items: + type: array + description: Roles list. + items: + "$ref": "#/definitions/company-data-role-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + company-data-role-interface: + type: object + description: Role data transfer object interface. + properties: + id: + type: integer + description: Role id. + role_name: + type: string + description: Role name. + permissions: + type: array + description: Permissions. + items: + "$ref": "#/definitions/company-data-permission-interface" + company_id: + type: integer + description: Company id. + extension_attributes: + "$ref": "#/definitions/company-data-role-extension-interface" + required: + - permissions + company-data-permission-interface: + type: object + description: Permission management + properties: + id: + type: integer + description: Id. + role_id: + type: integer + description: Role id. + resource_id: + type: string + description: Resource id. + permission: + type: string + description: Permission. + required: + - resource_id + - permission + company-data-role-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Company\Api\Data\RoleInterface + company-data-company-customer-search-results-interface: + type: object + description: Interface for company customer attributes search results + properties: + items: + type: array + description: Company customer attributes list + items: + "$ref": "#/definitions/company-data-company-customer-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + checkout-agreements-data-agreement-interface: + type: object + description: Interface AgreementInterface + properties: + agreement_id: + type: integer + description: Agreement ID. + name: + type: string + description: Agreement name. + content: + type: string + description: Agreement content. + content_height: + type: string + description: Agreement content height. Otherwise, null. + checkbox_text: + type: string + description: Agreement checkbox text. + is_active: + type: boolean + description: Agreement status. + is_html: + type: boolean + description: "* true - HTML. * false - plain text." + mode: + type: integer + description: The agreement applied mode. + extension_attributes: + "$ref": "#/definitions/checkout-agreements-data-agreement-extension-interface" + required: + - agreement_id + - name + - content + - checkbox_text + - is_active + - is_html + - mode + checkout-agreements-data-agreement-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\CheckoutAgreements\Api\Data\AgreementInterface + tax-data-tax-rate-interface: + type: object + description: Tax rate interface. + properties: + id: + type: integer + description: Id + tax_country_id: + type: string + description: Country id + tax_region_id: + type: integer + description: Region id + region_name: + type: string + description: Region name + tax_postcode: + type: string + description: Postcode + zip_is_range: + type: integer + description: Zip is range + zip_from: + type: integer + description: Zip range from + zip_to: + type: integer + description: Zip range to + rate: + type: number + description: Tax rate in percentage + code: + type: string + description: Tax rate code + titles: + type: array + description: Tax rate titles + items: + "$ref": "#/definitions/tax-data-tax-rate-title-interface" + extension_attributes: + "$ref": "#/definitions/tax-data-tax-rate-extension-interface" + required: + - tax_country_id + - rate + - code + tax-data-tax-rate-title-interface: + type: object + description: Tax rate title interface. + properties: + store_id: + type: string + description: Store id + value: + type: string + description: Title value + extension_attributes: + "$ref": "#/definitions/tax-data-tax-rate-title-extension-interface" + required: + - store_id + - value + tax-data-tax-rate-title-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Tax\Api\Data\TaxRateTitleInterface + tax-data-tax-rate-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Tax\Api\Data\TaxRateInterface + tax-data-tax-rate-search-results-interface: + type: object + description: Interface for tax rate search results. + properties: + items: + type: array + description: Items + items: + "$ref": "#/definitions/tax-data-tax-rate-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + tax-data-tax-rule-interface: + type: object + description: Tax rule interface. + properties: + id: + type: integer + description: Id + code: + type: string + description: Tax rule code + priority: + type: integer + description: Priority + position: + type: integer + description: Sort order. + customer_tax_class_ids: + type: array + description: Customer tax class id + items: + type: integer + product_tax_class_ids: + type: array + description: Product tax class id + items: + type: integer + tax_rate_ids: + type: array + description: Tax rate ids + items: + type: integer + calculate_subtotal: + type: boolean + description: Calculate subtotal. + extension_attributes: + "$ref": "#/definitions/tax-data-tax-rule-extension-interface" + required: + - code + - priority + - position + - customer_tax_class_ids + - product_tax_class_ids + - tax_rate_ids + tax-data-tax-rule-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Tax\Api\Data\TaxRuleInterface + tax-data-tax-rule-search-results-interface: + type: object + description: Interface for tax rule search results. + properties: + items: + type: array + description: Items + items: + "$ref": "#/definitions/tax-data-tax-rule-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + tax-data-tax-class-interface: + type: object + description: Tax class interface. + properties: + class_id: + type: integer + description: Tax class ID. + class_name: + type: string + description: Tax class name. + class_type: + type: string + description: Tax class type. + extension_attributes: + "$ref": "#/definitions/tax-data-tax-class-extension-interface" + required: + - class_name + - class_type + tax-data-tax-class-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Tax\Api\Data\TaxClassInterface + tax-data-tax-class-search-results-interface: + type: object + description: Interface for tax class search results. + properties: + items: + type: array + description: Items + items: + "$ref": "#/definitions/tax-data-tax-class-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + company-credit-data-credit-limit-search-results-interface: + type: object + description: Interface for Credit Limit search results. + properties: + items: + type: array + description: Credit Limit list. + items: + "$ref": "#/definitions/company-credit-data-credit-data-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + company-credit-data-credit-data-interface: + type: object + description: Credit Data interface. + properties: + id: + type: integer + description: ID. + company_id: + type: integer + description: Company id. + credit_limit: + type: number + description: Credit Limit. + balance: + type: number + description: Balance. + currency_code: + type: string + description: Currency Code. + exceed_limit: + type: boolean + description: Exceed Limit. + available_limit: + type: number + description: Available Limit. + required: + - exceed_limit + company-credit-data-credit-limit-interface: + type: object + description: Credit Limit data transfer object interface. + properties: + id: + type: integer + description: ID. + company_id: + type: integer + description: Company id. + credit_limit: + type: number + description: Credit Limit. + balance: + type: number + description: Balance. + currency_code: + type: string + description: Currency Code. + exceed_limit: + type: boolean + description: Exceed Limit. + available_limit: + type: number + description: Available Limit. + credit_comment: + type: string + description: Credit comment for company credit history. + extension_attributes: + "$ref": "#/definitions/company-credit-data-credit-limit-extension-interface" + required: + - exceed_limit + company-credit-data-credit-limit-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\CompanyCredit\Api\Data\CreditLimitInterface + company-credit-data-credit-balance-options-interface: + type: object + description: Credit balance data transfer object interface. + properties: + purchase_order: + type: string + description: Purchase order number. + custom_reference_number: + type: string + description: Custom Reference number. + order_increment: + type: string + description: Order increment. + currency_display: + type: string + description: Currency display. + currency_base: + type: string + description: Currency base. + required: + - purchase_order + - order_increment + - currency_display + - currency_base + company-credit-data-history-search-results-interface: + type: object + description: Interface for History search results. + properties: + items: + type: array + description: History list. + items: + "$ref": "#/definitions/company-credit-data-history-data-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + company-credit-data-history-data-interface: + type: object + description: History data transfer object interface. + properties: + id: + type: integer + description: ID. + company_credit_id: + type: integer + description: Company credit id. + user_id: + type: integer + description: User Id. + user_type: + type: integer + description: 'User type: integration, admin, customer.' + currency_credit: + type: string + description: Currency code of credit. + currency_operation: + type: string + description: Currency code of operation. + rate: + type: number + description: Currency rate between credit and operation currencies. + rate_credit: + type: number + description: Rate between credit and base currencies. + amount: + type: number + description: Amount. + balance: + type: number + description: Outstanding balance. + credit_limit: + type: number + description: Credit limit. + available_limit: + type: number + description: Available limit. + type: + type: integer + description: Type of operation. + datetime: + type: string + description: Operation datetime. + purchase_order: + type: string + description: Purchase Order number. + custom_reference_number: + type: string + description: Custom Reference number. + comment: + type: string + description: Comment. + required: + - rate + - amount + - balance + - credit_limit + negotiable-quote-data-attachment-content-interface: + type: object + description: Attachment files content interface. + properties: + base64_encoded_data: + type: string + description: Media data (base64 encoded content). + type: + type: string + description: MIME type. + name: + type: string + description: File name. + extension_attributes: + "$ref": "#/definitions/negotiable-quote-data-attachment-content-extension-interface" + required: + - base64_encoded_data + - type + - name + negotiable-quote-data-attachment-content-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\AttachmentContentInterface + negotiable-quote-data-comment-interface: + type: object + description: Interface CommentInterface + properties: + entity_id: + type: integer + description: Comment ID. + parent_id: + type: integer + description: Negotiable quote ID, that this comment belongs to. + creator_type: + type: integer + description: The comment creator type. + is_decline: + type: integer + description: Is quote was declined by seller. + is_draft: + type: integer + description: Is quote draft flag. + creator_id: + type: integer + description: Comment creator ID. + comment: + type: string + description: Comment. + created_at: + type: string + description: Comment created at. + extension_attributes: + "$ref": "#/definitions/negotiable-quote-data-comment-extension-interface" + attachments: + type: array + description: Existing attachments. + items: + "$ref": "#/definitions/negotiable-quote-data-comment-attachment-interface" + required: + - entity_id + - parent_id + - creator_type + - is_decline + - is_draft + - creator_id + - comment + - created_at + - attachments + negotiable-quote-data-comment-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\CommentInterface + negotiable-quote-data-comment-attachment-interface: + type: object + description: Interface for quote comment attachment. + properties: + attachment_id: + type: integer + description: Attachment ID. + comment_id: + type: integer + description: Comment ID. + file_name: + type: string + description: File name. + file_path: + type: string + description: File path. + file_type: + type: string + description: File type. + extension_attributes: + "$ref": "#/definitions/negotiable-quote-data-comment-attachment-extension-interface" + required: + - attachment_id + - comment_id + - file_name + - file_path + - file_type + negotiable-quote-data-comment-attachment-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\CommentAttachmentInterface + gift-card-account-data-gift-card-account-interface: + type: object + description: Gift Card Account data + properties: + gift_cards: + type: array + description: Cards codes. + items: + type: string + gift_cards_amount: + type: number + description: Cards amount in quote currency. + base_gift_cards_amount: + type: number + description: Cards amount in base currency. + gift_cards_amount_used: + type: number + description: Cards amount used in quote currency. + base_gift_cards_amount_used: + type: number + description: Cards amount used in base currency. + extension_attributes: + "$ref": "#/definitions/gift-card-account-data-gift-card-account-extension-interface" + required: + - gift_cards_amount + - base_gift_cards_amount + - gift_cards_amount_used + - base_gift_cards_amount_used + gift-card-account-data-gift-card-account-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface + negotiable-quote-data-item-note-search-results-interface: + type: object + description: Interface for Negotiable Quote Item Notes search results. + properties: + items: + type: array + description: Negotiable Quote Item Notes list. + items: + "$ref": "#/definitions/negotiable-quote-data-item-note-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + negotiable-quote-template-data-template-interface: + type: object + description: Interface TemplateInterface + properties: + template_id: + type: integer + description: Negotiable quote ID. + parent_quote_id: + type: integer + description: Negotiable quote ID. + template_name: + type: string + description: Negotiable quote template name. + status: + type: string + description: Negotiable quote template status + expiration_date: + type: string + description: Expiration period. + creator_id: + type: integer + description: Quote template creator id. + creator_type: + type: integer + description: Quote creator type. + min_orders: + type: integer + description: Min orders for purchase + max_orders: + type: integer + description: Min orders for purchase + is_min_max_qty_used: + type: boolean + description: Is min/max qty used. + activated_at: + type: string + description: Activated at time + last_shared_at: + type: string + description: Last shared at + inactivated_at: + type: string + description: Inactivated at time + created_at: + type: string + description: Created at time + updated_at: + type: string + description: Updated at time + extension_attributes: + "$ref": "#/definitions/negotiable-quote-template-data-template-extension-interface" + required: + - template_id + - parent_quote_id + - template_name + - status + - expiration_date + - creator_id + - creator_type + - min_orders + - max_orders + - is_min_max_qty_used + - activated_at + - last_shared_at + - inactivated_at + - created_at + - updated_at + - extension_attributes + negotiable-quote-template-data-template-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\NegotiableQuoteTemplate\Api\Data\TemplateInterface + framework-search-results-interface: + type: object + description: Search results interface. + properties: + items: + type: array + description: Items list. + items: + "$ref": "#/definitions/framework-extensible-data-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + framework-extensible-data-interface: + type: object + description: Interface for entities which can be extended with extension attributes. + negotiable-quote-template-data-reference-document-link-interface: + type: object + description: Interface ReferenceDocumentLinkInterface + properties: + link_id: + type: integer + description: Link ID. + template_id: + type: integer + description: Negotiable quote ID. + document_name: + type: string + description: Document name + document_identifier: + type: string + description: Document identifier + reference_document_url: + type: string + description: Reference document url + created_at: + type: string + description: Created at time + extension_attributes: + "$ref": "#/definitions/negotiable-quote-template-data-reference-document-link-extension-interface" + required: + - link_id + - template_id + - document_name + - document_identifier + - reference_document_url + - created_at + - extension_attributes + negotiable-quote-template-data-reference-document-link-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\NegotiableQuoteTemplate\Api\Data\ReferenceDocumentLinkInterface + company-relation-data-relation-search-result-interface: + type: object + description: Interface for company relation search results + properties: + items: + type: array + description: Company relations + items: + "$ref": "#/definitions/company-relation-data-relation-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + company-relation-data-relation-interface: + type: object + description: Company relation data interface. + properties: + company_id: + type: integer + description: Company id. + parent_id: + type: integer + description: Parent company id. + required: + - company_id + - parent_id + two-factor-auth-provider-interface: + type: object + description: 2FA provider interface + properties: + enabled: + type: boolean + description: True if this provider has been enabled by admin + engine: + "$ref": "#/definitions/two-factor-auth-engine-interface" + code: + type: string + description: Provider code + name: + type: string + description: Provider name + icon: + type: string + description: Icon + reset_allowed: + type: boolean + description: True if this provider configuration can be reset + configure_action: + type: string + description: Configure action + auth_action: + type: string + description: Auth action + extra_actions: + type: array + description: Allowed extra actions + items: + type: string + required: + - enabled + - engine + - code + - name + - icon + - reset_allowed + - configure_action + - auth_action + - extra_actions + two-factor-auth-engine-interface: + type: object + description: 2FA engine interface + properties: + enabled: + type: boolean + description: True if this provider has been enabled by admin + required: + - enabled + two-factor-auth-data-google-configure-interface: + type: object + description: Google configuration data interface + properties: + qr_code_base64: + type: string + description: Value for QR code base 64 + secret_code: + type: string + description: Value for secret code + extension_attributes: + "$ref": "#/definitions/two-factor-auth-data-google-configure-extension-interface" + required: + - qr_code_base64 + - secret_code + two-factor-auth-data-google-configure-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\GoogleConfigureInterface + two-factor-auth-data-authy-device-interface: + type: object + description: Authy device data interface + properties: + country: + type: string + description: The country + phone_number: + type: string + description: The phone number + method: + type: string + description: The method to authenticate with + extension_attributes: + "$ref": "#/definitions/two-factor-auth-data-authy-device-extension-interface" + required: + - country + - phone_number + - method + two-factor-auth-data-authy-device-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyDeviceInterface + two-factor-auth-data-authy-registration-prompt-response-interface: + type: object + description: Response for device registration prompt + properties: + message: + type: string + description: The message + expiration_seconds: + type: string + description: The seconds to expire + extension_attributes: + "$ref": "#/definitions/two-factor-auth-data-authy-registration-prompt-response-extension-interface" + required: + - message + - expiration_seconds + two-factor-auth-data-authy-registration-prompt-response-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseInterface + two-factor-auth-data-u2f-web-authn-request-interface: + type: object + description: Represents a WebAuthn dataset + properties: + credential_request_options_json: + type: string + description: The needed data to initiate a WebAuthn registration ceremony + extension_attributes: + "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-extension-interface" + required: + - credential_request_options_json + two-factor-auth-data-u2f-web-authn-request-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\U2fWebAuthnRequestInterface + shared-catalog-data-shared-catalog-interface: + type: object + description: SharedCatalogInterface interface. + properties: + id: + type: integer + description: ID. + name: + type: string + description: Shared Catalog name. + description: + type: string + description: Shared Catalog description. + customer_group_id: + type: integer + description: Customer Group Id. + type: + type: integer + description: Shared Catalog type. + created_at: + type: string + description: Created time for Shared Catalog. + created_by: + type: integer + description: Admin id for Shared Catalog. + store_id: + type: integer + description: Store group id for Shared Catalog. + tax_class_id: + type: integer + description: Tax class id. + required: + - name + - description + - customer_group_id + - type + - created_at + - created_by + - store_id + - tax_class_id + shared-catalog-data-search-results-interface: + type: object + description: Interface for Shared Catalog search results. + properties: + items: + type: array + description: Shared Catalog list. + items: + "$ref": "#/definitions/shared-catalog-data-shared-catalog-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + adobe-commerce-webhooks-data-webhook-data-interface: + type: object + description: Interface for webhook data from webapi requests + properties: + webhook_method: + type: string + description: Webhook method name + webhook_type: + type: string + description: Webhook type + batch_name: + type: string + description: Webhook batch name + batch_order: + type: integer + description: Webhook batch order + hook_name: + type: string + description: Hook name + url: + type: string + description: Hook url + priority: + type: integer + description: Hook priority + required: + type: boolean + description: If hook is required + soft_timeout: + type: integer + description: Hook soft timeout + timeout: + type: integer + description: Hook timeout + method: + type: string + description: Hook method + fallback_error_message: + type: string + description: Hook fallback error message + ttl: + type: integer + description: Hook ttl + fields: + type: array + description: Webhook fields + items: + "$ref": "#/definitions/adobe-commerce-webhooks-data-hook-field-interface" + rules: + type: array + description: Webhook rules + items: + "$ref": "#/definitions/adobe-commerce-webhooks-data-hook-rule-interface" + headers: + type: array + description: Webhook headers + items: + "$ref": "#/definitions/adobe-commerce-webhooks-data-hook-header-interface" + developer_console_oauth: + "$ref": "#/definitions/adobe-commerce-webhooks-data-developer-console-oauth-interface" + required: + - webhook_method + - webhook_type + - batch_name + - batch_order + - hook_name + - url + - priority + - required + - soft_timeout + - timeout + - method + - fallback_error_message + - ttl + - fields + - rules + - headers + adobe-commerce-webhooks-data-hook-field-interface: + type: object + description: Interface for hook field data from webapi requests + properties: + name: + type: string + description: Field name. + source: + type: string + description: Field source. + required: + - name + - source + adobe-commerce-webhooks-data-hook-rule-interface: + type: object + description: Interface for hook rule data from webapi requests + properties: + field: + type: string + description: Field name. + operator: + type: string + description: Operator. + value: + type: string + description: Value. + required: + - field + - operator + - value + adobe-commerce-webhooks-data-hook-header-interface: + type: object + description: Interface for hook header data from webapi requests + properties: + name: + type: string + description: Header name. + value: + type: string + description: Header value. + required: + - name + - value + adobe-commerce-webhooks-data-developer-console-oauth-interface: + type: object + description: Interface for Developer Console OAuth data from webapi requests. + properties: + client_id: + type: string + description: The Developer Console OAuth client ID. + client_secret: + type: string + description: The Developer Console OAuth client secret. + org_id: + type: string + description: The Developer Console OAuth org ID. + environment: + type: string + description: The Developer Console OAuth environment. + required: + - client_id + - client_secret + - org_id + - environment + analytics-data-link-interface: + type: object + description: Represents link with collected data and initialized vector for decryption. + properties: + url: + type: string + description: Url + initialization_vector: + type: string + description: Initialization vector + required: + - url + - initialization_vector + gift-wrapping-data-wrapping-interface: + type: object + description: Interface WrappingInterface + properties: + wrapping_id: + type: integer + description: Wrapping ID + design: + type: string + description: Design + status: + type: integer + description: Status + base_price: + type: number + description: Base price + image_name: + type: string + description: Image name + image_base64_content: + type: string + description: Image base64 encode + base_currency_code: + type: string + description: Base currency code + website_ids: + type: array + description: Website ids + items: + type: integer + image_url: + type: string + description: Wrapping image URL. + extension_attributes: + "$ref": "#/definitions/gift-wrapping-data-wrapping-extension-interface" + required: + - wrapping_id + - design + - status + - base_price + gift-wrapping-data-wrapping-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\GiftWrapping\Api\Data\WrappingInterface + gift-wrapping-data-wrapping-search-results-interface: + type: object + description: Interface WrappingSearchResultsInterface + properties: + items: + type: array + description: Items + items: + "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + import-csv-api-data-localized-source-data-interface: + type: object + description: "{@inheritdoc} Adds locale field in source data" + properties: + locale: + type: string + description: Import content locale + entity: + type: string + description: Entity + behavior: + type: string + description: Behavior + validation_strategy: + type: string + description: Validation Strategy + allowed_error_count: + type: string + description: Allowed Error Count + csv_data: + type: string + description: CSV data as string + import_field_separator: + type: string + description: Import's Field Separator for CSV + import_multiple_value_separator: + type: string + description: Import's Multiple Value Field Separator for CSV + import_empty_attribute_value_constant: + type: string + description: Import's Empty Attribute Value Constant + import_images_file_dir: + type: string + description: Import's Images File Directory + required: + - entity + - behavior + - validation_strategy + - allowed_error_count + - csv_data + import-json-api-data-source-data-interface: + type: object + description: Import JSON source data interface. + properties: + entity: + type: string + description: Entity + behavior: + type: string + description: Behavior + validation_strategy: + type: string + description: Validation Strategy + allowed_error_count: + type: string + description: Allowed Error Count + items: + "$ref": "#/definitions/unstructured-array" + import_images_file_dir: + type: string + description: Import's Images File Directory + locale: + type: string + description: Import content locale + required: + - entity + - behavior + - validation_strategy + - allowed_error_count + - items + unstructured-array: + type: object + description: '' + inventory-api-data-source-search-results-interface: + type: object + description: Search results of Repository::getList method Used fully qualified + namespaces in annotations for proper work of WebApi request parser + properties: + items: + type: array + description: Sources list + items: + "$ref": "#/definitions/inventory-api-data-source-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + inventory-api-data-source-interface: + type: object + description: Represents physical storage, i.e. brick and mortar store or warehouse + Used fully qualified namespaces in annotations for proper work of WebApi request + parser + properties: + source_code: + type: string + description: Source code + name: + type: string + description: Source name + email: + type: string + description: Source email + contact_name: + type: string + description: Source contact name + enabled: + type: boolean + description: If source is enabled. For new entity can be null + description: + type: string + description: Source description + latitude: + type: number + description: Source latitude + longitude: + type: number + description: Source longitude + country_id: + type: string + description: Source country id + region_id: + type: integer + description: Region id if source has registered region. + region: + type: string + description: Region title if source has custom region + city: + type: string + description: Source city + street: + type: string + description: Source street name + postcode: + type: string + description: Source post code + phone: + type: string + description: Source phone number + fax: + type: string + description: Source fax + use_default_carrier_config: + type: boolean + description: Is need to use default config + carrier_links: + type: array + description: Carrier links for the source as an array of SourceCarrierLinkInterface + objects or null. + items: + "$ref": "#/definitions/inventory-api-data-source-carrier-link-interface" + extension_attributes: + "$ref": "#/definitions/inventory-api-data-source-extension-interface" + inventory-api-data-source-carrier-link-interface: + type: object + description: Represents relation between some physical storage and shipping method + Used fully qualified namespaces in annotations for proper work of WebApi request + parser + properties: + carrier_code: + type: string + description: Carrier code + position: + type: integer + description: Position + extension_attributes: + "$ref": "#/definitions/inventory-api-data-source-carrier-link-extension-interface" + inventory-api-data-source-carrier-link-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventoryApi\Api\Data\SourceCarrierLinkInterface + inventory-api-data-source-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventoryApi\Api\Data\SourceInterface + properties: + is_pickup_location_active: + type: boolean + frontend_name: + type: string + frontend_description: + type: string + inventory-api-data-stock-search-results-interface: + type: object + description: Search results of Repository::getList method Used fully qualified + namespaces in annotations for proper work of WebApi request parser + properties: + items: + type: array + description: Stocks list + items: + "$ref": "#/definitions/inventory-api-data-stock-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + inventory-api-data-stock-interface: + type: object + description: Represents product aggregation among some different physical storages + (in technical words, it is an index) Used fully qualified namespaces in annotations + for proper work of WebApi request parser + properties: + stock_id: + type: integer + description: Stock id + name: + type: string + description: Stock name + extension_attributes: + "$ref": "#/definitions/inventory-api-data-stock-extension-interface" + inventory-api-data-stock-extension-interface: + type: object + description: 'TODO: temporal fix of extension classes generation during installation + ExtensionInterface class for @see \Magento\InventoryApi\Api\Data\StockInterface' + properties: + sales_channels: + type: array + description: Stock extension attributes like sales channels for a stock entity + as an array of SalesChannelInterface. + items: + "$ref": "#/definitions/inventory-sales-api-data-sales-channel-interface" + inventory-sales-api-data-sales-channel-interface: + type: object + description: Represents sales channels (which are a linkage between stocks and + websites, customer groups, etc.) Used fully qualified namespaces in annotations + for proper work of WebApi request parser + properties: + type: + type: string + description: Sales channel type + code: + type: string + description: Sales channel code + extension_attributes: + "$ref": "#/definitions/inventory-sales-api-data-sales-channel-extension-interface" + inventory-sales-api-data-sales-channel-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventorySalesApi\Api\Data\SalesChannelInterface + inventory-api-data-stock-source-link-search-results-interface: + type: object + description: Search results of Repository::getList method Used fully qualified + namespaces in annotations for proper work of WebApi request parser + properties: + items: + type: array + description: StockSourceLink list + items: + "$ref": "#/definitions/inventory-api-data-stock-source-link-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + inventory-api-data-stock-source-link-interface: + type: object + description: Represents relation between Stock and Source entities. Used fully + qualified namespaces in annotations for proper work of WebApi request parser + properties: + stock_id: + type: integer + description: Stock id + source_code: + type: string + description: Source code of the link + priority: + type: integer + description: Priority of the link + extension_attributes: + "$ref": "#/definitions/inventory-api-data-stock-source-link-extension-interface" + inventory-api-data-stock-source-link-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventoryApi\Api\Data\StockSourceLinkInterface + properties: + source_name: + type: string + inventory-api-data-source-item-search-results-interface: + type: object + description: Search results of Repository::getList method Used fully qualified + namespaces in annotations for proper work of WebApi request parser + properties: + items: + type: array + description: Source items list + items: + "$ref": "#/definitions/inventory-api-data-source-item-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + inventory-api-data-source-item-interface: + type: object + description: Represents amount of product on physical storage Entity id getter + is missed because entity identifies by compound identifier (sku and source_code) + Used fully qualified namespaces in annotations for proper work of WebApi request + parser + properties: + sku: + type: string + description: Source item sku + source_code: + type: string + description: Source code + quantity: + type: number + description: Source item quantity + status: + type: integer + description: Source item status (One of self::STATUS_*) + extension_attributes: + "$ref": "#/definitions/inventory-api-data-source-item-extension-interface" + inventory-api-data-source-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventoryApi\Api\Data\SourceItemInterface + inventory-catalog-api-data-partial-inventory-transfer-item-interface: + type: object + description: Specifies item and quantity for partial inventory transfer. + properties: + sku: + type: string + description: The SKU of the partial inventory transfer item. + qty: + type: number + description: The quantity of the partial inventory transfer item. + required: + - sku + - qty + inventory-distance-based-source-selection-api-data-lat-lng-interface: + type: object + description: DTO for latitude and longitude request + properties: + lat: + type: number + description: Latitude + lng: + type: number + description: Longitude + required: + - lat + - lng + inventory-export-stock-api-data-export-stock-salable-qty-search-result-interface: + type: object + description: Interface for ExportStockSalableQtySearchResult + properties: + items: + type: array + items: + "$ref": "#/definitions/framework-extensible-data-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + inventory-export-stock-api-data-product-stock-index-data-interface: + type: object + description: Class ExportStockIndexDataResultInterface for result Inventory stock + index dump export + properties: + sku: + type: string + description: Product SKU + qty: + type: number + description: Product QTY + is_salable: + type: boolean + description: Product is salable flag + required: + - sku + - qty + - is_salable + inventory-sales-api-data-is-product-salable-result-interface: + type: object + description: Represents "is product salable" result interface. + properties: + sku: + type: string + description: Product sku from result. + stock_id: + type: integer + description: Stock id from result. + salable: + type: boolean + description: Is salable result. + extension_attributes: + "$ref": "#/definitions/inventory-sales-api-data-is-product-salable-result-extension-interface" + required: + - sku + - stock_id + - salable + inventory-sales-api-data-is-product-salable-result-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventorySalesApi\Api\Data\IsProductSalableResultInterface + inventory-sales-api-data-product-salable-result-interface: + type: object + description: Represents result of service Magento\InventorySalesApi\Api\IsProductSalableForRequestedQtyInterface::execute + properties: + salable: + type: boolean + description: If the product is salable based on its availability and conditions. + errors: + type: array + description: A list of errors related to product salability. + items: + "$ref": "#/definitions/inventory-sales-api-data-product-salability-error-interface" + extension_attributes: + "$ref": "#/definitions/inventory-sales-api-data-product-salable-result-extension-interface" + required: + - salable + - errors + inventory-sales-api-data-product-salability-error-interface: + type: object + description: '' + properties: + code: + type: string + description: The error code related to product salability, returning it as + a string value. + message: + type: string + description: The error message related to product salability, returning it + as a string value. + extension_attributes: + "$ref": "#/definitions/inventory-sales-api-data-product-salability-error-extension-interface" + required: + - code + - message + inventory-sales-api-data-product-salability-error-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventorySalesApi\Api\Data\ProductSalabilityErrorInterface + inventory-sales-api-data-product-salable-result-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventorySalesApi\Api\Data\ProductSalableResultInterface + inventory-sales-api-data-is-product-salable-for-requested-qty-result-interface: + type: object + description: Represents "is product salable for requested quantity" result interface. + properties: + sku: + type: string + description: Product sku from result. + stock_id: + type: integer + description: Stock id from result. + salable: + type: boolean + description: Is salable result. + errors: + type: array + description: Errors from result. + items: + "$ref": "#/definitions/inventory-sales-api-data-product-salability-error-interface" + extension_attributes: + "$ref": "#/definitions/inventory-sales-api-data-is-product-salable-for-requested-qty-result-extension-interface" + required: + - sku + - stock_id + - salable + - errors + inventory-sales-api-data-is-product-salable-for-requested-qty-result-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventorySalesApi\Api\Data\IsProductSalableForRequestedQtyResultInterface + inventory-in-store-pickup-api-data-search-result-interface: + type: object + description: Search results for providing pickup locations. + properties: + items: + type: array + description: Items list. + items: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-pickup-location-interface" + search_request: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_request + - total_count + inventory-in-store-pickup-api-data-pickup-location-interface: + type: object + description: Represents sources projection on In-Store Pickup context. Realisation + must follow immutable DTO concept. Partial immutability done according to restriction + of current Extension Attributes implementation. + properties: + pickup_location_code: + type: string + description: Source code of Pickup Location. + name: + type: string + description: Pickup Location name. + email: + type: string + description: Pickup Location contact email. + fax: + type: string + description: Fax contact info. + contact_name: + type: string + description: Pickup Location contact name. + description: + type: string + description: Pickup Location description. + latitude: + type: number + description: Pickup Location latitude. + longitude: + type: number + description: Pickup Location longitude. + country_id: + type: string + description: Pickup Location country ID. + region_id: + type: integer + description: Pickup Location region ID. + region: + type: string + description: Pickup Location region. + city: + type: string + description: Pickup Location city. + street: + type: string + description: Pickup Location street. + postcode: + type: string + description: Pickup Location postcode. + phone: + type: string + description: Pickup Location phone. + extension_attributes: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-pickup-location-extension-interface" + required: + - pickup_location_code + inventory-in-store-pickup-api-data-pickup-location-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface + inventory-in-store-pickup-api-data-search-request-interface: + type: object + description: 'Endpoint used to search Pickup Locations by different parameters: + - by attribute filters fields @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\FiltersInterface + - by distance to the address @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\AreaInterface + Also, endpoint supports paging and sort orders.' + properties: + area: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-area-interface" + filters: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filters-interface" + page_size: + type: integer + description: Page size. + current_page: + type: integer + description: Current page. + scope_type: + type: string + description: Sales Channel Type. + scope_code: + type: string + description: Sales Channel code. + sort: + type: array + description: Sort Order. + items: + "$ref": "#/definitions/framework-sort-order" + extension_attributes: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-extension-interface" + required: + - current_page + - scope_type + - scope_code + inventory-in-store-pickup-api-data-search-request-area-interface: + type: object + description: 'Filter by Distance to the Address. Pickup Locations will be filtered + by distance according to the geo-position of the entered address. Required fields + for the address are country and one of the field: region or city or postcode.' + properties: + radius: + type: integer + description: Search radius in KM. + search_term: + type: string + description: Search term string. + required: + - radius + - search_term + inventory-in-store-pickup-api-data-search-request-filters-interface: + type: object + description: Filter to filter by Fields. Each field may be filtered with different + condition type. Supported condition types restricted by @see \Magento\Framework\Api\SearchCriteriaInterface + properties: + country: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + postcode: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + region: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + region_id: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + city: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + street: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + name: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + pickup_location_code: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + inventory-in-store-pickup-api-data-search-request-filter-interface: + type: object + description: Filter for Pickup Location search. + properties: + value: + type: string + description: Value. + condition_type: + type: string + description: Condition Type. + required: + - value + - condition_type + inventory-in-store-pickup-api-data-search-request-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequestInterface + properties: + products_info: + type: array + items: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-product-info-interface" + inventory-in-store-pickup-api-data-search-request-product-info-interface: + type: object + description: Product Info Data Transfer Object. + properties: + sku: + type: string + description: Product SKU. + extension_attributes: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-product-info-extension-interface" + required: + - sku + inventory-in-store-pickup-api-data-search-request-product-info-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\ProductInfoInterface + inventory-source-selection-api-data-source-selection-algorithm-interface: + type: object + description: Data Interface representing particular Source Selection Algorithm + properties: + code: + type: string + description: The code of the Source Selection Algorithm as a string. + title: + type: string + description: The title of the Source Selection Algorithm as a string. + description: + type: string + description: The description of the Source Selection Algorithm as a string. + extension_attributes: + "$ref": "#/definitions/inventory-source-selection-api-data-source-selection-algorithm-extension-interface" + required: + - code + - title + - description + inventory-source-selection-api-data-source-selection-algorithm-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventorySourceSelectionApi\Api\Data\SourceSelectionAlgorithmInterface + inventory-source-selection-api-data-inventory-request-interface: + type: object + description: Request products in a given Qty and StockId + properties: + stock_id: + type: integer + description: Stock Id + items: + type: array + description: Items + items: + "$ref": "#/definitions/inventory-source-selection-api-data-item-request-interface" + extension_attributes: + "$ref": "#/definitions/inventory-source-selection-api-data-inventory-request-extension-interface" + required: + - stock_id + - items + inventory-source-selection-api-data-item-request-interface: + type: object + description: Represents requested quantity for particular product + properties: + sku: + type: string + description: SKU + qty: + type: number + description: Product Quantity + extension_attributes: + "$ref": "#/definitions/inventory-source-selection-api-data-item-request-extension-interface" + required: + - sku + - qty + inventory-source-selection-api-data-item-request-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventorySourceSelectionApi\Api\Data\ItemRequestInterface + inventory-source-selection-api-data-inventory-request-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventorySourceSelectionApi\Api\Data\InventoryRequestInterface + properties: + destination_address: + "$ref": "#/definitions/inventory-source-selection-api-data-address-interface" + inventory-source-selection-api-data-address-interface: + type: object + description: Data interface for shipping source or shipping destination + properties: + country: + type: string + description: Shipping country + postcode: + type: string + description: Shipping postcode + street: + type: string + description: Shipping street address + region: + type: string + description: Shipping region + city: + type: string + description: Shipping city + required: + - country + - postcode + - street + - region + - city + inventory-source-selection-api-data-source-selection-result-interface: + type: object + description: Result of how we will deduct product qty from different Sources + properties: + source_selection_items: + type: array + description: The list of source selection items representing how product quantities + are deducted from sources. + items: + "$ref": "#/definitions/inventory-source-selection-api-data-source-selection-item-interface" + shippable: + type: boolean + description: If the source selection result is eligible for shipping. + extension_attributes: + "$ref": "#/definitions/inventory-source-selection-api-data-source-selection-result-extension-interface" + required: + - source_selection_items + - shippable + inventory-source-selection-api-data-source-selection-item-interface: + type: object + description: Represents source selection result for the specific source and SKU + properties: + source_code: + type: string + description: Source code + sku: + type: string + description: Item SKU + qty_to_deduct: + type: number + description: Quantity which will be deducted for this source + qty_available: + type: number + description: Available quantity for this source + extension_attributes: + "$ref": "#/definitions/inventory-source-selection-api-data-source-selection-item-extension-interface" + required: + - source_code + - sku + - qty_to_deduct + - qty_available + inventory-source-selection-api-data-source-selection-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventorySourceSelectionApi\Api\Data\SourceSelectionItemInterface + inventory-source-selection-api-data-source-selection-result-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventorySourceSelectionApi\Api\Data\SourceSelectionResultInterface + inventory-in-store-pickup-sales-api-data-result-interface: + type: object + description: Operation result object that contains status of the operation. + properties: + successful: + type: boolean + description: Operation result successful. + errors: + type: array + description: Error information for failed operations. + items: + type: string + extension_attributes: + "$ref": "#/definitions/inventory-in-store-pickup-sales-api-data-result-extension-interface" + required: + - successful + - errors + inventory-in-store-pickup-sales-api-data-result-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventoryInStorePickupSalesApi\Api\Data\ResultInterface + inventory-low-quantity-notification-api-data-source-item-configuration-interface: + type: object + description: Represents a Source Item Configuration object Used fully qualified + namespaces in annotations for proper work of WebApi request parser phpcs:disable + Generic.Files.LineLength.TooLong + properties: + source_code: + type: string + description: Source code + notify_stock_qty: + type: number + description: Notify stock qty + sku: + type: string + description: SKU + extension_attributes: + "$ref": "#/definitions/inventory-low-quantity-notification-api-data-source-item-configuration-extension-interface" + inventory-low-quantity-notification-api-data-source-item-configuration-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventoryLowQuantityNotificationApi\Api\Data\SourceItemConfigurationInterface + adobe-stock-asset-api-data-asset-interface: + type: object + description: Adobe Stock Asset data class interface + properties: + id: + type: integer + description: ID + media_gallery_id: + type: integer + description: Media gallery asset id + category_id: + type: integer + description: Category + category: + "$ref": "#/definitions/adobe-stock-asset-api-data-category-interface" + creator_id: + type: integer + description: The creator + creator: + "$ref": "#/definitions/adobe-stock-asset-api-data-creator-interface" + is_licensed: + type: integer + description: Licensed + creation_date: + type: string + description: Creation date + extension_attributes: + "$ref": "#/definitions/adobe-stock-asset-api-data-asset-extension-interface" + required: + - media_gallery_id + - is_licensed + - creation_date + adobe-stock-asset-api-data-category-interface: + type: object + description: Adobe Stock asset Category data class + properties: + id: + type: integer + description: The id + name: + type: string + description: The category name + extension_attributes: + "$ref": "#/definitions/adobe-stock-asset-api-data-category-extension-interface" + required: + - name + - extension_attributes + adobe-stock-asset-api-data-category-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\AdobeStockAssetApi\Api\Data\CategoryInterface + adobe-stock-asset-api-data-creator-interface: + type: object + description: Adobe Stock creator data class + properties: + id: + type: integer + description: The id + name: + type: string + description: The creator name + extension_attributes: + "$ref": "#/definitions/adobe-stock-asset-api-data-creator-extension-interface" + required: + - extension_attributes + adobe-stock-asset-api-data-creator-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\AdobeStockAssetApi\Api\Data\CreatorInterface + adobe-stock-asset-api-data-asset-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\AdobeStockAssetApi\Api\Data\AssetInterface + adobe-stock-asset-api-data-asset-search-results-interface: + type: object + description: Interface AssetSearchResultsInterface + properties: + items: + type: array + description: Assets list. + items: + "$ref": "#/definitions/adobe-stock-asset-api-data-asset-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + asynchronous-operations-data-detailed-bulk-operations-status-interface: + type: object + description: Interface BulkStatusInterface Bulk summary data with list of operations + items full data. + properties: + operations_list: + type: array + description: Operations list. + items: + "$ref": "#/definitions/asynchronous-operations-data-operation-interface" + extension_attributes: + "$ref": "#/definitions/asynchronous-operations-data-bulk-summary-extension-interface" + user_type: + type: integer + description: User type + bulk_id: + type: string + description: Bulk uuid + description: + type: string + description: Bulk description + start_time: + type: string + description: Bulk scheduled time + user_id: + type: integer + description: User id + operation_count: + type: integer + description: Total number of operations scheduled in scope of this bulk + required: + - operations_list + - user_type + - bulk_id + - description + - start_time + - user_id + - operation_count + asynchronous-operations-data-operation-interface: + type: object + description: Class OperationInterface + properties: + extension_attributes: + "$ref": "#/definitions/asynchronous-operations-data-operation-extension-interface" + id: + type: integer + description: Id + bulk_uuid: + type: string + description: Bulk uuid + topic_name: + type: string + description: Queue Topic + serialized_data: + type: string + description: Data + result_serialized_data: + type: string + description: Serialized Data + status: + type: integer + description: Operation status + result_message: + type: string + description: Result message + error_code: + type: integer + description: Error code + required: + - id + - bulk_uuid + - topic_name + - serialized_data + - result_serialized_data + - status + - result_message + - error_code + asynchronous-operations-data-operation-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\AsynchronousOperations\Api\Data\OperationInterface + properties: + start_time: + type: string + asynchronous-operations-data-bulk-summary-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\AsynchronousOperations\Api\Data\BulkSummaryInterface + asynchronous-operations-data-bulk-operations-status-interface: + type: object + description: Interface BulkStatusInterface Bulk summary data with list of operations + items summary data. + properties: + operations_list: + type: array + description: List of operation with statuses (short data). + items: + "$ref": "#/definitions/asynchronous-operations-data-summary-operation-status-interface" + extension_attributes: + "$ref": "#/definitions/asynchronous-operations-data-bulk-summary-extension-interface" + user_type: + type: integer + description: User type + bulk_id: + type: string + description: Bulk uuid + description: + type: string + description: Bulk description + start_time: + type: string + description: Bulk scheduled time + user_id: + type: integer + description: User id + operation_count: + type: integer + description: Total number of operations scheduled in scope of this bulk + required: + - operations_list + - user_type + - bulk_id + - description + - start_time + - user_id + - operation_count + asynchronous-operations-data-summary-operation-status-interface: + type: object + description: Getter Class OperationsStatusInterface Instead of OperationInterface + this class don't provide all operation data and not responsive to set any data, + just to get operation data without serialized_data and result_serialized_data + properties: + id: + type: integer + description: Id + status: + type: integer + description: Operation status + result_message: + type: string + description: Result message + error_code: + type: integer + description: Error code + required: + - id + - status + - result_message + - error_code + asynchronous-operations-data-operation-search-results-interface: + type: object + description: Bulk operation search result interface. An bulk is a group of queue + messages. An bulk operation item is a queue message. + properties: + items: + type: array + description: List of operations. + items: + "$ref": "#/definitions/asynchronous-operations-data-operation-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + rma-data-track-interface: + type: object + description: Interface TrackInterface + properties: + entity_id: + type: integer + description: Entity id + rma_entity_id: + type: integer + description: Rma entity id + track_number: + type: string + description: Track number + carrier_title: + type: string + description: Carrier title + carrier_code: + type: string + description: Carrier code + extension_attributes: + "$ref": "#/definitions/rma-data-track-extension-interface" + required: + - entity_id + - rma_entity_id + - track_number + - carrier_title + - carrier_code + rma-data-track-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Rma\Api\Data\TrackInterface + rma-data-track-search-result-interface: + type: object + description: Interface TrackSearchResultInterface + properties: + items: + type: array + description: Rma list + items: + "$ref": "#/definitions/rma-data-track-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + rma-data-rma-interface: + type: object + description: Interface RmaInterface + properties: + increment_id: + type: string + description: Entity_id + entity_id: + type: integer + description: Entity_id + order_id: + type: integer + description: Order_id + order_increment_id: + type: string + description: Order_increment_id + store_id: + type: integer + description: Store_id + customer_id: + type: integer + description: Customer_id + date_requested: + type: string + description: Date_requested + customer_custom_email: + type: string + description: Customer_custom_email + items: + type: array + description: Items + items: + "$ref": "#/definitions/rma-data-item-interface" + status: + type: string + description: Status + comments: + type: array + description: Comments list + items: + "$ref": "#/definitions/rma-data-comment-interface" + tracks: + type: array + description: Tracks list + items: + "$ref": "#/definitions/rma-data-track-interface" + extension_attributes: + "$ref": "#/definitions/rma-data-rma-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + required: + - increment_id + - entity_id + - order_id + - order_increment_id + - store_id + - customer_id + - date_requested + - customer_custom_email + - items + - status + - comments + - tracks + rma-data-item-interface: + type: object + description: Interface CategoryInterface + properties: + entity_id: + type: integer + description: Id + rma_entity_id: + type: integer + description: RMA id + order_item_id: + type: integer + description: Order_item_id + qty_requested: + type: integer + description: Qty_requested + qty_authorized: + type: integer + description: Qty_authorized + qty_approved: + type: integer + description: Qty_approved + qty_returned: + type: integer + description: Qty_returned + reason: + type: string + description: Reason + condition: + type: string + description: Condition + resolution: + type: string + description: Resolution + status: + type: string + description: Status + extension_attributes: + "$ref": "#/definitions/rma-data-item-extension-interface" + required: + - entity_id + - rma_entity_id + - order_item_id + - qty_requested + - qty_authorized + - qty_approved + - qty_returned + - reason + - condition + - resolution + - status + rma-data-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Rma\Api\Data\ItemInterface + rma-data-comment-interface: + type: object + description: Interface CommentInterface + properties: + comment: + type: string + description: Comment + rma_entity_id: + type: integer + description: Rma Id + created_at: + type: string + description: Created_at + entity_id: + type: integer + description: Entity_id + customer_notified: + type: boolean + description: Is_customer_notified + visible_on_front: + type: boolean + description: Is_visible_on_front + status: + type: string + description: Status + admin: + type: boolean + description: Is_admin + extension_attributes: + "$ref": "#/definitions/rma-data-comment-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + required: + - comment + - rma_entity_id + - created_at + - entity_id + - customer_notified + - visible_on_front + - status + - admin + rma-data-comment-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Rma\Api\Data\CommentInterface + rma-data-rma-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Rma\Api\Data\RmaInterface + rma-data-comment-search-result-interface: + type: object + description: Interface CommentSearchResultInterface + properties: + items: + type: array + description: Rma Status History list + items: + "$ref": "#/definitions/rma-data-comment-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + rma-data-rma-search-result-interface: + type: object + description: Interface RmaSearchResultInterface + properties: + items: + type: array + description: Rma list + items: + "$ref": "#/definitions/rma-data-rma-interface" + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_criteria + - total_count + framework-metadata-object-interface: + type: object + description: Provides metadata about an attribute. + properties: + attribute_code: + type: string + description: Code of the attribute. + required: + - attribute_code + payment-services-paypal-payment-config-response-interface: + type: object + description: '' + properties: + apple_pay: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-apple-pay-interface" + google_pay: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-interface" + hosted_fields: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-hosted-fields-interface" + smart_buttons: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-interface" + required: + - apple_pay + - google_pay + - hosted_fields + - smart_buttons + payment-services-paypal-data-payment-config-apple-pay-interface: + type: object + description: '' + properties: + button_styles: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-button-styles-interface" + payment_source: + type: string + description: PaymentSource + code: + type: string + description: Code + sdk_params: + type: array + description: SDK params + items: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" + is_visible: + type: boolean + description: Visible + sort_order: + type: string + description: Sort Order + payment_intent: + type: string + description: Payment intent + title: + type: string + description: Title + required: + - button_styles + - payment_source + - code + - sdk_params + - is_visible + - sort_order + - payment_intent + - title + payment-services-paypal-data-payment-config-button-styles-interface: + type: object + description: '' + properties: + layout: + type: string + description: Layout + color: + type: string + description: Color + shape: + type: string + description: Shape + label: + type: string + description: Label + tagline: + type: boolean + description: ShowTagline + height: + type: integer + description: Height + use_default_height: + type: boolean + description: Height + required: + - layout + - color + - shape + - label + - tagline + - height + - use_default_height + payment-services-paypal-data-payment-config-sdk-params-interface: + type: object + description: '' + properties: + name: + type: string + description: Code + value: + type: string + description: Config + required: + - name + - value + payment-services-paypal-data-payment-config-google-pay-interface: + type: object + description: '' + properties: + button_styles: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-button-styles-interface" + payment_source: + type: string + description: PaymentSource + three_d_s: + type: string + description: ThreeDS + code: + type: string + description: Code + sdk_params: + type: array + description: SDK params + items: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" + is_visible: + type: boolean + description: Visible + sort_order: + type: string + description: Sort Order + payment_intent: + type: string + description: Payment intent + title: + type: string + description: Title + required: + - button_styles + - payment_source + - three_d_s + - code + - sdk_params + - is_visible + - sort_order + - payment_intent + - title + payment-services-paypal-data-payment-config-google-pay-button-styles-interface: + type: object + description: '' + properties: + color: + type: string + description: Color + height: + type: integer + description: Height + type: + type: string + description: Type + required: + - color + - height + - type + payment-services-paypal-data-payment-config-hosted-fields-interface: + type: object + description: '' + properties: + payment_source: + type: string + description: Payment Source + three_d_s: + type: string + description: ThreeDS + is_vault_enabled: + type: boolean + description: HasIsVaultEnabled + cc_vault_code: + type: string + description: CcVaultCode + requires_card_details: + type: boolean + description: RequiresCardDetails + code: + type: string + description: Code + sdk_params: + type: array + description: SDK params + items: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" + is_visible: + type: boolean + description: Visible + sort_order: + type: string + description: Sort Order + payment_intent: + type: string + description: Payment intent + title: + type: string + description: Title + required: + - payment_source + - three_d_s + - is_vault_enabled + - cc_vault_code + - requires_card_details + - code + - sdk_params + - is_visible + - sort_order + - payment_intent + - title + payment-services-paypal-data-payment-config-smart-buttons-interface: + type: object + description: '' + properties: + display_message: + type: boolean + description: CanDisplayMessage + display_venmo: + type: boolean + description: Venmo + message_styles: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-message-styles-interface" + button_styles: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-button-styles-interface" + app_switch_when_available: + type: boolean + description: AppSwitchWhenAvailable + code: + type: string + description: Code + sdk_params: + type: array + description: SDK params + items: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" + is_visible: + type: boolean + description: Visible + sort_order: + type: string + description: Sort Order + payment_intent: + type: string + description: Payment intent + title: + type: string + description: Title + required: + - display_message + - display_venmo + - message_styles + - button_styles + - app_switch_when_available + - code + - sdk_params + - is_visible + - sort_order + - payment_intent + - title + payment-services-paypal-data-payment-config-smart-buttons-message-styles-interface: + type: object + description: '' + properties: + layout: + type: string + description: CanDisplayMessage + logo: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-logo-interface" + required: + - layout + - logo + payment-services-paypal-data-payment-config-smart-buttons-logo-interface: + type: object + description: '' + properties: + type: + type: string + description: CanDisplayMessage + required: + - type + payment-services-paypal-data-payment-order-interface: + type: object + description: Interface PaymentOrderInterface + properties: + id: + type: string + description: Payment order id + mp_order_id: + type: string + description: Payment order mpOrderId + status: + type: string + description: Payment order status + amount: + type: number + description: Payment order amount + currency_code: + type: string + description: Payment order currency code + required: + - id + - mp_order_id + - status + - amount + - currency_code + payment-services-paypal-data-payment-order-details-interface: + type: object + description: Interface PaymentOrderDetailsInterface + properties: + payment_source_details: + "$ref": "#/definitions/payment-services-paypal-data-payment-source-details-interface" + id: + type: string + description: Payment order id + mp_order_id: + type: string + description: Payment order mpOrderId + status: + type: string + description: Payment order status + amount: + type: number + description: Payment order amount + currency_code: + type: string + description: Payment order currency code + required: + - payment_source_details + - id + - mp_order_id + - status + - amount + - currency_code + payment-services-paypal-data-payment-source-details-interface: + type: object + description: '' + properties: + card: + "$ref": "#/definitions/payment-services-paypal-data-payment-card-details-interface" + required: + - card + payment-services-paypal-data-payment-card-details-interface: + type: object + description: '' + properties: + name: + type: string + description: Name + last_digits: + type: string + description: Last digits + card_expiry_month: + type: string + description: Card expiry month + card_expiry_year: + type: string + description: Card expiry year + bin_details: + "$ref": "#/definitions/payment-services-paypal-data-payment-card-bin-details-interface" + required: + - name + - last_digits + - card_expiry_month + - card_expiry_year + - bin_details + payment-services-paypal-data-payment-card-bin-details-interface: + type: object + description: '' + properties: + bin: + type: string + description: Bin + required: + - bin + payment-services-paypal-data-payment-sdk-params-interface: + type: object + description: '' + properties: + code: + type: string + description: The payments sdk code + params: + type: array + description: The payments sdk params + items: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" + required: + - code + - params + pay-pal-braintree-data-auth-data-interface: + type: object + description: Interface AuthDataInterface + properties: + client_token: + type: string + description: Client token + display_name: + type: string + description: Display name + action_success: + type: string + description: To success page + logged_in: + type: boolean + description: Logged in + store_code: + type: string + description: Current store code + required: + - display_name + - action_success + - logged_in + - store_code + pay-pal-braintree-data-payment-interface: + type: object + description: '' + properties: + payment_method_code: + type: string + description: The payment method code. + payment_method_nonce: + type: string + description: The payment method nonce. + device_data: + type: string + description: The device data. +x-tagGroups: +- name: addresses + tags: + - addresses/{addressId} +- name: adminuisdk + tags: + - adminuisdk/appmanagement/validate + - adminuisdk/massaction/{request_id} + - adminuisdk/orderviewbutton/{request_id} +- name: adobe_io_events + tags: + - adobe_io_events/check_configuration +- name: adobestock + tags: + - adobestock/asset/list + - adobestock/asset/search + - adobestock/asset/{id} + - adobestock/search +- name: analytics + tags: + - analytics/link +- name: applepay + tags: + - applepay/auth +- name: attributeMetadata + tags: + - attributeMetadata/customer + - attributeMetadata/customer/attribute/{attributeCode} + - attributeMetadata/customer/custom + - attributeMetadata/customer/form/{formCode} + - attributeMetadata/customerAddress + - attributeMetadata/customerAddress/attribute/{attributeCode} + - attributeMetadata/customerAddress/custom + - attributeMetadata/customerAddress/form/{formCode} +- name: braintree + tags: + - braintree/mine/payment/vault +- name: bulk + tags: + - bulk + - bulk/{bulkUuid}/detailed-status + - bulk/{bulkUuid}/operation-status/{status} + - bulk/{bulkUuid}/status +- name: bundle products + tags: + - bundle-products/options/add + - bundle-products/options/types + - bundle-products/options/{optionId} + - bundle-products/{productSku}/children + - bundle-products/{sku}/links/{id} + - bundle-products/{sku}/links/{optionId} + - bundle-products/{sku}/options/all + - bundle-products/{sku}/options/{optionId} + - bundle-products/{sku}/options/{optionId}/children/{childSku} +- name: carts + tags: + - carts/ + - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} + - carts/guest-carts/{cartId}/giftCards + - carts/guest-carts/{cartId}/giftCards/{giftCardCode} + - carts/licence + - carts/licence/list + - carts/mine + - carts/mine/balance/apply + - carts/mine/billing-address + - carts/mine/checkGiftCard/{giftCardCode} + - carts/mine/collect-totals + - carts/mine/coupons + - carts/mine/coupons/deleteByCodes + - carts/mine/coupons/{couponCode} + - carts/mine/estimate-shipping-methods + - carts/mine/estimate-shipping-methods-by-address-id + - carts/mine/gift-message + - carts/mine/gift-message/{itemId} + - carts/mine/giftCards + - carts/mine/giftCards/{giftCardCode} + - carts/mine/items + - carts/mine/items/{itemId} + - carts/mine/order + - carts/mine/payment-information + - carts/mine/payment-methods + - carts/mine/payment-order + - carts/mine/payment-order/{id} + - carts/mine/po-payment-information + - carts/mine/selected-payment-method + - carts/mine/set-payment-information + - carts/mine/shipping-information + - carts/mine/shipping-methods + - carts/mine/totals + - carts/mine/totals-information + - carts/search + - carts/{cartId} + - carts/{cartId}/billing-address + - carts/{cartId}/coupons + - carts/{cartId}/coupons/deleteByCodes + - carts/{cartId}/coupons/{couponCode} + - carts/{cartId}/estimate-shipping-methods + - carts/{cartId}/estimate-shipping-methods-by-address-id + - carts/{cartId}/gift-message + - carts/{cartId}/gift-message/{itemId} + - carts/{cartId}/giftCards + - carts/{cartId}/giftCards/{giftCardCode} + - carts/{cartId}/items + - carts/{cartId}/items/{itemId} + - carts/{cartId}/order + - carts/{cartId}/payment-methods + - carts/{cartId}/selected-payment-method + - carts/{cartId}/shipping-information + - carts/{cartId}/shipping-methods + - carts/{cartId}/totals + - carts/{cartId}/totals-information + - carts/{quoteId}/giftCards + - carts/{quoteId}/items +- name: categories + tags: + - categories + - categories/attributes + - categories/attributes/{attributeCode} + - categories/attributes/{attributeCode}/options + - categories/list + - categories/{categoryId} + - categories/{categoryId}/move + - categories/{categoryId}/products + - categories/{categoryId}/products/{sku} + - categories/{id} +- name: cmsBlock + tags: + - cmsBlock + - cmsBlock/search + - cmsBlock/{blockId} + - cmsBlock/{id} +- name: cmsPage + tags: + - cmsPage + - cmsPage/search + - cmsPage/{id} + - cmsPage/{pageId} +- name: company + tags: + - company/ + - company/assignRoles + - company/relations + - company/role/ + - company/role/{id} + - company/role/{roleId} + - company/role/{roleId}/users + - company/{companyId} + - company/{parentId}/relations + - company/{parentId}/relations/{companyId} +- name: companyCredits + tags: + - companyCredits/ + - companyCredits/company/{companyId} + - companyCredits/history + - companyCredits/history/{historyId} + - companyCredits/{creditId} + - companyCredits/{creditId}/decreaseBalance + - companyCredits/{creditId}/increaseBalance + - companyCredits/{id} +- name: configurable products + tags: + - configurable-products/variation + - configurable-products/{sku}/child + - configurable-products/{sku}/children + - configurable-products/{sku}/children/{childSku} + - configurable-products/{sku}/options + - configurable-products/{sku}/options/all + - configurable-products/{sku}/options/{id} +- name: coupons + tags: + - coupons + - coupons/deleteByCodes + - coupons/deleteByIds + - coupons/generate + - coupons/search + - coupons/{couponId} +- name: creditmemo + tags: + - creditmemo + - creditmemo/refund + - creditmemo/{id} + - creditmemo/{id}/comments + - creditmemo/{id}/emails +- name: creditmemos + tags: + - creditmemos +- name: customerGroups + tags: + - customerGroups + - customerGroups/default + - customerGroups/default/{id} + - customerGroups/default/{storeId} + - customerGroups/search + - customerGroups/{id} + - customerGroups/{id}/permissions +- name: customers + tags: + - customers + - customers/activate + - customers/addresses/{addressId} + - customers/companies + - customers/confirm + - customers/isEmailAvailable + - customers/me + - customers/me/activate + - customers/me/billingAddress + - customers/me/password + - customers/me/shippingAddress + - customers/password + - customers/resetPassword + - customers/search + - customers/validate + - customers/{customerId} + - customers/{customerId}/billingAddress + - customers/{customerId}/carts + - customers/{customerId}/companies + - customers/{customerId}/companies/{companyId} + - customers/{customerId}/confirm + - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} + - customers/{customerId}/permissions/readonly + - customers/{customerId}/shippingAddress + - customers/{customerId}/token + - customers/{email}/activate +- name: directory + tags: + - directory/countries + - directory/countries/{countryId} + - directory/currency +- name: eav + tags: + - eav/attribute-sets + - eav/attribute-sets/list + - eav/attribute-sets/{attributeSetId} +- name: eventing + tags: + - eventing/eventProvider + - eventing/eventProvider/{providerId} + - eventing/eventSubscribe + - eventing/eventSubscribe/{name} + - eventing/eventUnsubscribe/{name} + - eventing/getEventProviders + - eventing/getEventSubscriptions + - eventing/updateConfiguration +- name: gift wrappings + tags: + - gift-wrappings + - gift-wrappings/{id} + - gift-wrappings/{wrappingId} +- name: giftregistry + tags: + - giftregistry/mine/estimate-shipping-methods +- name: guest carts + tags: + - guest-carts + - guest-carts/{cartId} + - guest-carts/{cartId}/billing-address + - guest-carts/{cartId}/collect-totals + - guest-carts/{cartId}/coupons + - guest-carts/{cartId}/coupons/{couponCode} + - guest-carts/{cartId}/estimate-shipping-methods + - guest-carts/{cartId}/gift-message + - guest-carts/{cartId}/gift-message/{itemId} + - guest-carts/{cartId}/items + - guest-carts/{cartId}/items/{itemId} + - guest-carts/{cartId}/order + - guest-carts/{cartId}/payment-information + - guest-carts/{cartId}/payment-methods + - guest-carts/{cartId}/payment-order + - guest-carts/{cartId}/payment-order/{id} + - guest-carts/{cartId}/selected-payment-method + - guest-carts/{cartId}/set-payment-information + - guest-carts/{cartId}/shipping-information + - guest-carts/{cartId}/shipping-methods + - guest-carts/{cartId}/totals + - guest-carts/{cartId}/totals-information +- name: guest giftregistry + tags: + - guest-giftregistry/{cartId}/estimate-shipping-methods +- name: hierarchy + tags: + - hierarchy/move/{id} + - hierarchy/{id} +- name: import + tags: + - import/csv + - import/json +- name: integration + tags: + - integration/admin/token + - integration/customer/revoke-customer-token + - integration/customer/token +- name: inventory + tags: + - inventory/are-product-salable-for-requested-qty/ + - inventory/are-products-salable + - inventory/bulk-partial-source-transfer + - inventory/bulk-product-source-assign + - inventory/bulk-product-source-transfer + - inventory/bulk-product-source-unassign + - inventory/dump-stock-index-data/{salesChannelType}/{salesChannelCode} + - inventory/export-stock-salable-qty/{salesChannelType}/{salesChannelCode} + - inventory/get-distance + - inventory/get-distance-provider-code + - inventory/get-latlng-from-address + - inventory/get-latslngs-from-address + - inventory/get-product-salable-quantity/{sku}/{stockId} + - inventory/get-sources-assigned-to-stock-ordered-by-priority/{stockId} + - inventory/in-store-pickup/pickup-locations/ + - inventory/is-product-salable-for-requested-qty/{sku}/{stockId}/{requestedQty} + - inventory/is-product-salable/{sku}/{stockId} + - inventory/low-quantity-notification + - inventory/low-quantity-notification/{sourceCode}/{sku} + - inventory/low-quantity-notifications-delete + - inventory/source-items + - inventory/source-items-delete + - inventory/source-selection-algorithm-list + - inventory/source-selection-algorithm-result + - inventory/sources + - inventory/sources/{sourceCode} + - inventory/stock-resolver/{type}/{code} + - inventory/stock-source-links + - inventory/stock-source-links-delete + - inventory/stocks + - inventory/stocks/{stockId} +- name: invoice + tags: + - invoice/{invoiceId}/refund +- name: invoices + tags: + - invoices + - invoices/ + - invoices/comments + - invoices/{id} + - invoices/{id}/capture + - invoices/{id}/comments + - invoices/{id}/emails + - invoices/{id}/void +- name: modules + tags: + - modules +- name: negotiable cart item note + tags: + - negotiable-cart-item-note + - negotiable-cart-item-note/search + - negotiable-cart-item-note/{noteId} +- name: negotiable carts + tags: + - negotiable-carts/{cartId}/billing-address + - negotiable-carts/{cartId}/coupons + - negotiable-carts/{cartId}/coupons/{couponCode} + - negotiable-carts/{cartId}/estimate-shipping-methods + - negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id + - negotiable-carts/{cartId}/giftCards + - negotiable-carts/{cartId}/giftCards/{giftCardCode} + - negotiable-carts/{cartId}/payment-information + - negotiable-carts/{cartId}/po-payment-information + - negotiable-carts/{cartId}/set-payment-information + - negotiable-carts/{cartId}/shipping-information + - negotiable-carts/{cartId}/totals +- name: negotiableQuote + tags: + - negotiableQuote/attachmentContent + - negotiableQuote/decline + - negotiableQuote/draft + - negotiableQuote/pricesUpdated + - negotiableQuote/request + - negotiableQuote/submitToCustomer + - negotiableQuote/{negotiableQuoteId}/duplicate + - negotiableQuote/{quoteId} + - negotiableQuote/{quoteId}/comments + - negotiableQuote/{quoteId}/shippingMethod +- name: negotiableQuoteTemplate + tags: + - negotiableQuoteTemplate + - negotiableQuoteTemplate/accept + - negotiableQuoteTemplate/cancel + - negotiableQuoteTemplate/cancel/me + - negotiableQuoteTemplate/decline + - negotiableQuoteTemplate/draft + - negotiableQuoteTemplate/generateQuote + - negotiableQuoteTemplate/me + - negotiableQuoteTemplate/me/{templateId} + - negotiableQuoteTemplate/open + - negotiableQuoteTemplate/open/me + - negotiableQuoteTemplate/referenceDocumentLink + - negotiableQuoteTemplate/referenceDocumentLink/{linkId} + - negotiableQuoteTemplate/request + - negotiableQuoteTemplate/request/me + - negotiableQuoteTemplate/submitToCustomer + - negotiableQuoteTemplate/submitToSeller + - negotiableQuoteTemplate/{templateId} +- name: order + tags: + - order/notify-orders-are-ready-for-pickup + - order/{orderId}/invoice + - order/{orderId}/refund + - order/{orderId}/ship +- name: orders + tags: + - orders + - orders/create + - orders/items + - orders/items/{id} + - orders/{id} + - orders/{id}/cancel + - orders/{id}/comments + - orders/{id}/emails + - orders/{id}/hold + - orders/{id}/statuses + - orders/{id}/unhold + - orders/{parent_id} +- name: payment order + tags: + - payment-order/completeOrder +- name: payments config + tags: + - payments-config/apple-pay/{location} + - payments-config/google-pay/{location} + - payments-config/hosted-fields/{location} + - payments-config/smart-buttons/{location} + - payments-config/{location} +- name: payments sdk + tags: + - payments-sdk/{location} + - payments-sdk/{location}/{methodCode} +- name: paypal + tags: + - paypal/lineItems + - paypal/oneClick + - paypal/validatePhoneNumber +- name: products + tags: + - products + - products/attribute-sets + - products/attribute-sets/attributes + - products/attribute-sets/groups + - products/attribute-sets/groups/list + - products/attribute-sets/groups/{groupId} + - products/attribute-sets/sets/list + - products/attribute-sets/{attributeSetId} + - products/attribute-sets/{attributeSetId}/attributes + - products/attribute-sets/{attributeSetId}/attributes/{attributeCode} + - products/attribute-sets/{attributeSetId}/groups + - products/attributes + - products/attributes/types + - products/attributes/{attributeCode} + - products/attributes/{attributeCode}/is-filterable + - products/attributes/{attributeCode}/is-filterable/{isFilterable} + - products/attributes/{attributeCode}/options + - products/attributes/{attributeCode}/options/{optionId} + - products/base-prices + - products/base-prices-information + - products/cost + - products/cost-delete + - products/cost-information + - products/downloadable-links/samples/{id} + - products/downloadable-links/{id} + - products/links/types + - products/links/{type}/attributes + - products/media/types/{attributeSetName} + - products/options + - products/options/types + - products/options/{optionId} + - products/special-price + - products/special-price-delete + - products/special-price-information + - products/tier-prices + - products/tier-prices-delete + - products/tier-prices-information + - products/types + - products/{productSku}/stockItems/{itemId} + - products/{sku} + - products/{sku}/downloadable-links + - products/{sku}/downloadable-links/samples + - products/{sku}/downloadable-links/samples/{id} + - products/{sku}/downloadable-links/{id} + - products/{sku}/group-prices/{customerGroupId}/tiers + - products/{sku}/group-prices/{customerGroupId}/tiers/{qty} + - products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price} + - products/{sku}/links + - products/{sku}/links/{type} + - products/{sku}/links/{type}/{linkedProductSku} + - products/{sku}/media + - products/{sku}/media/{entryId} + - products/{sku}/options + - products/{sku}/options/{optionId} + - products/{sku}/websites + - products/{sku}/websites/{websiteId} +- name: products render info + tags: + - products-render-info +- name: purchase order carts + tags: + - purchase-order-carts/{cartId}/billing-address + - purchase-order-carts/{cartId}/estimate-shipping-methods + - purchase-order-carts/{cartId}/estimate-shipping-methods-by-address-id + - purchase-order-carts/{cartId}/giftCards + - purchase-order-carts/{cartId}/giftCards/{giftCardCode} + - purchase-order-carts/{cartId}/payment-information + - purchase-order-carts/{cartId}/set-payment-information + - purchase-order-carts/{cartId}/totals +- name: requisition_lists + tags: + - requisition_lists +- name: returns + tags: + - returns + - returns/{id} + - returns/{id}/comments + - returns/{id}/labels + - returns/{id}/tracking-numbers + - returns/{id}/tracking-numbers/{trackId} +- name: returnsAttributeMetadata + tags: + - returnsAttributeMetadata + - returnsAttributeMetadata/custom + - returnsAttributeMetadata/form/{formCode} + - returnsAttributeMetadata/{attributeCode} +- name: reward + tags: + - reward/mine/use-reward +- name: salesRules + tags: + - salesRules + - salesRules/search + - salesRules/{ruleId} +- name: search + tags: + - search +- name: sharedCatalog + tags: + - sharedCatalog + - sharedCatalog/ + - sharedCatalog/{id} + - sharedCatalog/{id}/assignCategories + - sharedCatalog/{id}/assignProducts + - sharedCatalog/{id}/categories + - sharedCatalog/{id}/products + - sharedCatalog/{id}/unassignCategories + - sharedCatalog/{id}/unassignProducts + - sharedCatalog/{sharedCatalogId} + - sharedCatalog/{sharedCatalogId}/assignCompanies + - sharedCatalog/{sharedCatalogId}/assignTierPrices + - sharedCatalog/{sharedCatalogId}/companies + - sharedCatalog/{sharedCatalogId}/resetTierPrices + - sharedCatalog/{sharedCatalogId}/unassignCompanies +- name: shipment + tags: + - shipment/ + - shipment/track + - shipment/track/{id} + - shipment/{id} + - shipment/{id}/comments + - shipment/{id}/emails + - shipment/{id}/label +- name: shipments + tags: + - shipments +- name: stockItems + tags: + - stockItems/lowStock/ + - stockItems/{productSku} +- name: stockStatuses + tags: + - stockStatuses/{productSku} +- name: store + tags: + - store/storeConfigs + - store/storeGroups + - store/storeViews + - store/websites +- name: taxClasses + tags: + - taxClasses + - taxClasses/search + - taxClasses/{classId} + - taxClasses/{taxClassId} +- name: taxRates + tags: + - taxRates + - taxRates/search + - taxRates/{rateId} +- name: taxRules + tags: + - taxRules + - taxRules/search + - taxRules/{ruleId} +- name: team + tags: + - team/ + - team/{companyId} + - team/{teamId} +- name: tfa + tags: + - tfa/default-provider-code/{userId} + - tfa/forced-providers + - tfa/installed-providers + - tfa/provider/authy/activate + - tfa/provider/authy/authenticate + - tfa/provider/authy/authenticate-onetouch + - tfa/provider/authy/configure + - tfa/provider/authy/send-token/{via} + - tfa/provider/duo_security/activate + - tfa/provider/duo_security/authenticate + - tfa/provider/duo_security/configure + - tfa/provider/google/activate + - tfa/provider/google/authenticate + - tfa/provider/google/configure + - tfa/provider/u2fkey/activate + - tfa/provider/u2fkey/authentication-challenge + - tfa/provider/u2fkey/configure + - tfa/provider/u2fkey/verify + - tfa/providers-to-activate/{userId} + - tfa/tfat-providers-to-activate + - tfa/tfat-user-providers + - tfa/user-providers/{userId} +- name: transactions + tags: + - transactions + - transactions/{id} +- name: webhooks + tags: + - webhooks/list + - webhooks/subscribe + - webhooks/unsubscribe diff --git a/src/openapi/customer-schema-2.4.9-beta-1.yaml b/src/openapi/customer-schema-2.4.9-beta-1.yaml new file mode 100644 index 000000000..898804cf2 --- /dev/null +++ b/src/openapi/customer-schema-2.4.9-beta-1.yaml @@ -0,0 +1,7870 @@ +--- +securityDefinitions: + api_key: + type: apiKey + name: api_key + in: header +swagger: '2.0' +info: + version: 2.4.9-beta-1 + title: Commerce Customer REST endpoints - All inclusive + description: + "$ref": "../_includes/redocly-intro.md" +host: example.com +basePath: "/rest/default" +schemes: +- http +tags: +- name: applepay/auth +- name: braintree/mine/payment/vault +- name: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} +- name: carts/guest-carts/{cartId}/giftCards +- name: carts/guest-carts/{cartId}/giftCards/{giftCardCode} +- name: carts/mine +- name: carts/mine/balance/apply +- name: carts/mine/checkGiftCard/{giftCardCode} +- name: carts/mine/collect-totals +- name: carts/mine/payment-information +- name: carts/mine/payment-order +- name: carts/mine/payment-order/{id} +- name: carts/mine/po-payment-information +- name: carts/mine/set-payment-information +- name: customers +- name: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} +- name: customers/isEmailAvailable +- name: customers/me/activate +- name: customers/me/password +- name: customers/password +- name: customers/resetPassword +- name: directory/countries +- name: directory/countries/{countryId} +- name: directory/currency +- name: giftregistry/mine/estimate-shipping-methods +- name: guest-carts +- name: guest-carts/{cartId} +- name: guest-carts/{cartId}/billing-address +- name: guest-carts/{cartId}/collect-totals +- name: guest-carts/{cartId}/coupons +- name: guest-carts/{cartId}/coupons/{couponCode} +- name: guest-carts/{cartId}/estimate-shipping-methods +- name: guest-carts/{cartId}/gift-message +- name: guest-carts/{cartId}/gift-message/{itemId} +- name: guest-carts/{cartId}/items +- name: guest-carts/{cartId}/items/{itemId} +- name: guest-carts/{cartId}/order +- name: guest-carts/{cartId}/payment-information +- name: guest-carts/{cartId}/payment-methods +- name: guest-carts/{cartId}/payment-order +- name: guest-carts/{cartId}/payment-order/{id} +- name: guest-carts/{cartId}/selected-payment-method +- name: guest-carts/{cartId}/set-payment-information +- name: guest-carts/{cartId}/shipping-information +- name: guest-carts/{cartId}/shipping-methods +- name: guest-carts/{cartId}/totals +- name: guest-carts/{cartId}/totals-information +- name: guest-giftregistry/{cartId}/estimate-shipping-methods +- name: integration/admin/token +- name: integration/customer/revoke-customer-token +- name: integration/customer/token +- name: inventory/in-store-pickup/pickup-locations/ +- name: negotiable-carts/{cartId}/billing-address +- name: negotiable-carts/{cartId}/coupons +- name: negotiable-carts/{cartId}/coupons/{couponCode} +- name: negotiable-carts/{cartId}/estimate-shipping-methods +- name: negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id +- name: negotiable-carts/{cartId}/giftCards +- name: negotiable-carts/{cartId}/giftCards/{giftCardCode} +- name: negotiable-carts/{cartId}/payment-information +- name: negotiable-carts/{cartId}/po-payment-information +- name: negotiable-carts/{cartId}/set-payment-information +- name: negotiable-carts/{cartId}/shipping-information +- name: negotiable-carts/{cartId}/totals +- name: negotiableQuoteTemplate/accept +- name: negotiableQuoteTemplate/generateQuote +- name: negotiableQuoteTemplate/submitToSeller +- name: payment-order/completeOrder +- name: payments-config/{location} +- name: payments-config/apple-pay/{location} +- name: payments-config/google-pay/{location} +- name: payments-config/hosted-fields/{location} +- name: payments-config/smart-buttons/{location} +- name: payments-sdk/{location} +- name: payments-sdk/{location}/{methodCode} +- name: paypal/lineItems +- name: paypal/oneClick +- name: paypal/validatePhoneNumber +- name: products-render-info +- name: purchase-order-carts/{cartId}/payment-information +- name: purchase-order-carts/{cartId}/set-payment-information +- name: requisition_lists +- name: reward/mine/use-reward +- name: search +- name: tfa/provider/authy/activate +- name: tfa/provider/authy/authenticate +- name: tfa/provider/authy/authenticate-onetouch +- name: tfa/provider/authy/configure +- name: tfa/provider/authy/send-token/{via} +- name: tfa/provider/duo_security/activate +- name: tfa/provider/duo_security/authenticate +- name: tfa/provider/duo_security/configure +- name: tfa/provider/google/activate +- name: tfa/provider/google/authenticate +- name: tfa/provider/google/configure +- name: tfa/provider/u2fkey/activate +- name: tfa/provider/u2fkey/authentication-challenge +- name: tfa/provider/u2fkey/configure +- name: tfa/provider/u2fkey/verify +- name: tfa/tfat-providers-to-activate +- name: tfa/tfat-user-providers +paths: + "/V1/applepay/auth": + get: + tags: + - applepay/auth + description: Returns details required to be able to submit a payment with Apple + Pay + operationId: GetV1ApplepayAuth + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/pay-pal-braintree-data-auth-data-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: applepay/auth + "/V1/braintree/mine/payment/vault": + post: + tags: + - braintree/mine/payment/vault + description: Vault a Payment nonce for a customer. Billing address is optional + but advised for Card vaulting. + operationId: PostV1BraintreeMinePaymentVault + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1BraintreeMinePaymentVaultBody + in: body + schema: + required: + - payment + properties: + payment: + "$ref": "#/definitions/pay-pal-braintree-data-payment-interface" + billingAddress: + "$ref": "#/definitions/customer-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: braintree/mine/payment/vault + "/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}": + get: + tags: + - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} + description: Check gift card balance if added to the cart. + operationId: GetV1CartsGuestcartsCartIdCheckGiftCardGiftCardCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: giftCardCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: number + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} + "/V1/carts/guest-carts/{cartId}/giftCards": + post: + tags: + - carts/guest-carts/{cartId}/giftCards + description: Add gift card to the cart. + operationId: PostV1CartsGuestcartsCartIdGiftCards + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1CartsGuestcartsCartIdGiftCardsBody + in: body + schema: + required: + - giftCardAccountData + properties: + giftCardAccountData: + "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/guest-carts/{cartId}/giftCards + "/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}": + delete: + tags: + - carts/guest-carts/{cartId}/giftCards/{giftCardCode} + description: Remove GiftCard Account entity. + operationId: DeleteV1CartsGuestcartsCartIdGiftCardsGiftCardCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: giftCardCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/guest-carts/{cartId}/giftCards/{giftCardCode} + "/V1/carts/mine": + put: + tags: + - carts/mine + description: Save quote + operationId: PutV1CartsMine + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1CartsMineBody + in: body + schema: + required: + - quote + properties: + quote: + "$ref": "#/definitions/quote-data-cart-interface" + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine + get: + tags: + - carts/mine + description: Returns information for the cart for a specified customer. + operationId: GetV1CartsMine + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-cart-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine + "/V1/carts/mine/balance/apply": + post: + tags: + - carts/mine/balance/apply + description: Apply store credit + operationId: PostV1CartsMineBalanceApply + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/balance/apply + "/V1/carts/mine/checkGiftCard/{giftCardCode}": + get: + tags: + - carts/mine/checkGiftCard/{giftCardCode} + description: Check gift card balance if applied to given cart. + operationId: GetV1CartsMineCheckGiftCardGiftCardCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: giftCardCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: number + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/checkGiftCard/{giftCardCode} + "/V1/carts/mine/collect-totals": + put: + tags: + - carts/mine/collect-totals + description: Set shipping/billing methods and additional data for cart and collect + totals. + operationId: PutV1CartsMineCollecttotals + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1CartsMineCollecttotalsBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + shippingCarrierCode: + type: string + description: The carrier code. + shippingMethodCode: + type: string + description: The shipping method code. + additionalData: + "$ref": "#/definitions/quote-data-totals-additional-data-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-totals-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/collect-totals + "/V1/carts/mine/payment-information": + post: + tags: + - carts/mine/payment-information + description: Set payment information and place order for a specified cart. + operationId: PostV1CartsMinePaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CartsMinePaymentinformationBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/payment-information + get: + tags: + - carts/mine/payment-information + description: Get payment information + operationId: GetV1CartsMinePaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/checkout-data-payment-details-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/payment-information + "/V1/carts/mine/payment-order": + post: + tags: + - carts/mine/payment-order + description: Create a payment order for logged in customer + operationId: PostV1CartsMinePaymentorder + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CartsMinePaymentorderBody + in: body + schema: + required: + - methodCode + - paymentSource + - location + properties: + methodCode: + type: string + paymentSource: + type: string + location: + type: string + vaultIntent: + type: boolean + threeDSMode: + type: string + description: "| null $threeDSMode" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-order-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/payment-order + "/V1/carts/mine/payment-order/{id}": + get: + tags: + - carts/mine/payment-order/{id} + description: Get payment order for logged in customer + operationId: GetV1CartsMinePaymentorderId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-order-details-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/payment-order/{id} + post: + tags: + - carts/mine/payment-order/{id} + description: Sync payment order for logged in customer + operationId: PostV1CartsMinePaymentorderId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: id + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/payment-order/{id} + "/V1/carts/mine/po-payment-information": + post: + tags: + - carts/mine/po-payment-information + description: Set payment information and place purchase order for a specified + cart. + operationId: PostV1CartsMinePopaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CartsMinePopaymentinformationBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Purchase Order ID. + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/po-payment-information + "/V1/carts/mine/set-payment-information": + post: + tags: + - carts/mine/set-payment-information + description: Set payment information for a specified cart. + operationId: PostV1CartsMineSetpaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CartsMineSetpaymentinformationBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/mine/set-payment-information + "/V1/customers": + post: + tags: + - customers + description: Create customer account. Perform necessary business operations + like sending email. + operationId: PostV1Customers + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CustomersBody + in: body + schema: + required: + - customer + properties: + customer: + "$ref": "#/definitions/customer-data-customer-interface" + password: + type: string + redirectUrl: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-customer-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers + "/V1/customers/isEmailAvailable": + post: + tags: + - customers/isEmailAvailable + description: Check if given email is associated with a customer account in given + website. + operationId: PostV1CustomersIsEmailAvailable + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CustomersIsEmailAvailableBody + in: body + schema: + required: + - customerEmail + properties: + customerEmail: + type: string + websiteId: + type: integer + description: If not set, will use the current websiteId + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/isEmailAvailable + "/V1/customers/me/activate": + put: + tags: + - customers/me/activate + description: Activate a customer account using a key that was sent in a confirmation + email. + operationId: PutV1CustomersMeActivate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1CustomersMeActivateBody + in: body + schema: + required: + - confirmationKey + properties: + confirmationKey: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-customer-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/me/activate + "/V1/customers/me/password": + put: + tags: + - customers/me/password + description: Change customer password. + operationId: PutV1CustomersMePassword + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1CustomersMePasswordBody + in: body + schema: + required: + - currentPassword + - newPassword + properties: + currentPassword: + type: string + newPassword: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/me/password + "/V1/customers/password": + put: + tags: + - customers/password + description: Send an email to the customer with a password reset link. + operationId: PutV1CustomersPassword + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1CustomersPasswordBody + in: body + schema: + required: + - email + - template + properties: + email: + type: string + template: + type: string + websiteId: + type: integer + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/password + "/V1/customers/resetPassword": + post: + tags: + - customers/resetPassword + description: Reset customer password. + operationId: PostV1CustomersResetPassword + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CustomersResetPasswordBody + in: body + schema: + required: + - email + - resetToken + - newPassword + properties: + email: + type: string + description: If empty value given then the customer will be matched + by the RP token. + resetToken: + type: string + newPassword: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/resetPassword + "/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}": + get: + tags: + - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} + description: Check if password reset token is valid. + operationId: GetV1CustomersCustomerIdPasswordResetLinkTokenResetPasswordLinkToken + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: customerId + in: path + type: integer + required: true + description: If null is given then a customer will be matched by the RP token. + - name: resetPasswordLinkToken + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: True if the token is valid + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} + "/V1/directory/countries": + get: + tags: + - directory/countries + description: Get all countries and regions information for the store. + operationId: GetV1DirectoryCountries + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/directory-data-country-information-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: directory/countries + "/V1/directory/countries/{countryId}": + get: + tags: + - directory/countries/{countryId} + description: Get country and region information for the store. + operationId: GetV1DirectoryCountriesCountryId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: countryId + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/directory-data-country-information-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: directory/countries/{countryId} + "/V1/directory/currency": + get: + tags: + - directory/currency + description: Get currency information for the store. + operationId: GetV1DirectoryCurrency + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/directory-data-currency-information-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: directory/currency + "/V1/giftregistry/mine/estimate-shipping-methods": + post: + tags: + - giftregistry/mine/estimate-shipping-methods + description: Estimate shipping + operationId: PostV1GiftregistryMineEstimateshippingmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1GiftregistryMineEstimateshippingmethodsBody + in: body + schema: + required: + - registryId + properties: + registryId: + type: integer + description: The estimate registry id + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods. + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: giftregistry/mine/estimate-shipping-methods + "/V1/guest-carts": + post: + tags: + - guest-carts + description: Enable an customer or guest user to create an empty cart and quote + for an anonymous customer. + operationId: PostV1Guestcarts + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: string + description: Cart ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts + "/V1/guest-carts/{cartId}": + get: + tags: + - guest-carts/{cartId} + description: Enable a guest user to return information for a specified cart. + operationId: GetV1GuestcartsCartId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-cart-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId} + put: + tags: + - guest-carts/{cartId} + description: Assign a specified customer to a specified shopping cart. + operationId: PutV1GuestcartsCartId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: PutV1GuestcartsCartIdBody + in: body + schema: + required: + - storeId + properties: + storeId: + type: integer + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId} + "/V1/guest-carts/{cartId}/billing-address": + get: + tags: + - guest-carts/{cartId}/billing-address + description: Return the billing address for a specified quote. + operationId: GetV1GuestcartsCartIdBillingaddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-address-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/billing-address + post: + tags: + - guest-carts/{cartId}/billing-address + description: Assign a specified billing address to a specified cart. + operationId: PostV1GuestcartsCartIdBillingaddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: PostV1GuestcartsCartIdBillingaddressBody + in: body + schema: + required: + - address + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + useForShipping: + type: boolean + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Address ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/billing-address + "/V1/guest-carts/{cartId}/collect-totals": + put: + tags: + - guest-carts/{cartId}/collect-totals + description: Set shipping/billing methods and additional data for cart and collect + totals for guest. + operationId: PutV1GuestcartsCartIdCollecttotals + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: PutV1GuestcartsCartIdCollecttotalsBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + shippingCarrierCode: + type: string + description: The carrier code. + shippingMethodCode: + type: string + description: The shipping method code. + additionalData: + "$ref": "#/definitions/quote-data-totals-additional-data-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-totals-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/collect-totals + "/V1/guest-carts/{cartId}/coupons": + get: + tags: + - guest-carts/{cartId}/coupons + description: Return information for a coupon in a specified cart. + operationId: GetV1GuestcartsCartIdCoupons + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + type: string + description: The coupon code data. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/coupons + delete: + tags: + - guest-carts/{cartId}/coupons + description: Delete a coupon from a specified cart. + operationId: DeleteV1GuestcartsCartIdCoupons + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/coupons + "/V1/guest-carts/{cartId}/coupons/{couponCode}": + put: + tags: + - guest-carts/{cartId}/coupons/{couponCode} + description: Add a coupon by code to a specified cart. + operationId: PutV1GuestcartsCartIdCouponsCouponCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: couponCode + in: path + type: string + required: true + description: The coupon code data. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/coupons/{couponCode} + "/V1/guest-carts/{cartId}/estimate-shipping-methods": + post: + tags: + - guest-carts/{cartId}/estimate-shipping-methods + description: Estimate shipping by address and return list of available shipping + methods + operationId: PostV1GuestcartsCartIdEstimateshippingmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdEstimateshippingmethodsBody + in: body + schema: + required: + - address + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/estimate-shipping-methods + "/V1/guest-carts/{cartId}/gift-message": + get: + tags: + - guest-carts/{cartId}/gift-message + description: Return the gift message for a specified order. + operationId: GetV1GuestcartsCartIdGiftmessage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The shopping cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/gift-message-data-message-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/gift-message + post: + tags: + - guest-carts/{cartId}/gift-message + description: Set the gift message for an entire order. + operationId: PostV1GuestcartsCartIdGiftmessage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: PostV1GuestcartsCartIdGiftmessageBody + in: body + schema: + required: + - giftMessage + properties: + giftMessage: + "$ref": "#/definitions/gift-message-data-message-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/gift-message + "/V1/guest-carts/{cartId}/gift-message/{itemId}": + get: + tags: + - guest-carts/{cartId}/gift-message/{itemId} + description: Return the gift message for a specified item in a specified shopping + cart. + operationId: GetV1GuestcartsCartIdGiftmessageItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The shopping cart ID. + - name: itemId + in: path + type: integer + required: true + description: The item ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/gift-message-data-message-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/gift-message/{itemId} + post: + tags: + - guest-carts/{cartId}/gift-message/{itemId} + description: Set the gift message for a specified item in a specified shopping + cart. + operationId: PostV1GuestcartsCartIdGiftmessageItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: itemId + in: path + type: integer + required: true + description: The item ID. + - name: PostV1GuestcartsCartIdGiftmessageItemIdBody + in: body + schema: + required: + - giftMessage + properties: + giftMessage: + "$ref": "#/definitions/gift-message-data-message-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/gift-message/{itemId} + "/V1/guest-carts/{cartId}/items": + get: + tags: + - guest-carts/{cartId}/items + description: List items that are assigned to a specified cart. + operationId: GetV1GuestcartsCartIdItems + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + type: array + description: Array of items. + items: + "$ref": "#/definitions/quote-data-cart-item-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/items + post: + tags: + - guest-carts/{cartId}/items + description: Add/update the specified cart item. + operationId: PostV1GuestcartsCartIdItems + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdItemsBody + in: body + schema: + required: + - cartItem + properties: + cartItem: + "$ref": "#/definitions/quote-data-cart-item-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-cart-item-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/items + "/V1/guest-carts/{cartId}/items/{itemId}": + put: + tags: + - guest-carts/{cartId}/items/{itemId} + description: Add/update the specified cart item. + operationId: PutV1GuestcartsCartIdItemsItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: itemId + in: path + type: string + required: true + - name: PutV1GuestcartsCartIdItemsItemIdBody + in: body + schema: + required: + - cartItem + properties: + cartItem: + "$ref": "#/definitions/quote-data-cart-item-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-cart-item-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/items/{itemId} + delete: + tags: + - guest-carts/{cartId}/items/{itemId} + description: Remove the specified item from the specified cart. + operationId: DeleteV1GuestcartsCartIdItemsItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: itemId + in: path + type: integer + required: true + description: The item ID of the item to be removed. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/items/{itemId} + "/V1/guest-carts/{cartId}/order": + put: + tags: + - guest-carts/{cartId}/order + description: Place an order for a specified cart. + operationId: PutV1GuestcartsCartIdOrder + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: PutV1GuestcartsCartIdOrderBody + in: body + schema: + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/order + "/V1/guest-carts/{cartId}/payment-information": + post: + tags: + - guest-carts/{cartId}/payment-information + description: Set payment information and place order for a specified cart. + operationId: PostV1GuestcartsCartIdPaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdPaymentinformationBody + in: body + schema: + required: + - email + - paymentMethod + properties: + email: + type: string + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/payment-information + get: + tags: + - guest-carts/{cartId}/payment-information + description: Get payment information + operationId: GetV1GuestcartsCartIdPaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/checkout-data-payment-details-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/payment-information + "/V1/guest-carts/{cartId}/payment-methods": + get: + tags: + - guest-carts/{cartId}/payment-methods + description: List available payment methods for a specified shopping cart. This + call returns an array of objects, but detailed information about each object’s + attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#GuestPaymentMethodManagementInterface + to determine which call to use to get detailed information about all attributes + for an object. + operationId: GetV1GuestcartsCartIdPaymentmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + type: array + description: Array of payment methods. + items: + "$ref": "#/definitions/quote-data-payment-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/payment-methods + "/V1/guest-carts/{cartId}/payment-order": + post: + tags: + - guest-carts/{cartId}/payment-order + description: Create a payment order for guest customer + operationId: PostV1GuestcartsCartIdPaymentorder + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdPaymentorderBody + in: body + schema: + required: + - methodCode + - paymentSource + - location + properties: + methodCode: + type: string + paymentSource: + type: string + location: + type: string + vaultIntent: + type: boolean + threeDSMode: + type: string + description: "| null $threeDSMode" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-order-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/payment-order + "/V1/guest-carts/{cartId}/payment-order/{id}": + get: + tags: + - guest-carts/{cartId}/payment-order/{id} + description: Get payment order for guest customer + operationId: GetV1GuestcartsCartIdPaymentorderId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: id + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-order-details-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/payment-order/{id} + post: + tags: + - guest-carts/{cartId}/payment-order/{id} + description: Sync payment order for guest customer + operationId: PostV1GuestcartsCartIdPaymentorderId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: id + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/payment-order/{id} + "/V1/guest-carts/{cartId}/selected-payment-method": + get: + tags: + - guest-carts/{cartId}/selected-payment-method + description: Return the payment method for a specified shopping cart. + operationId: GetV1GuestcartsCartIdSelectedpaymentmethod + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-payment-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/selected-payment-method + put: + tags: + - guest-carts/{cartId}/selected-payment-method + description: Add a specified payment method to a specified shopping cart. + operationId: PutV1GuestcartsCartIdSelectedpaymentmethod + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: PutV1GuestcartsCartIdSelectedpaymentmethodBody + in: body + schema: + required: + - method + properties: + method: + "$ref": "#/definitions/quote-data-payment-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Payment method ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/selected-payment-method + "/V1/guest-carts/{cartId}/set-payment-information": + post: + tags: + - guest-carts/{cartId}/set-payment-information + description: Set payment information for a specified cart. + operationId: PostV1GuestcartsCartIdSetpaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdSetpaymentinformationBody + in: body + schema: + required: + - email + - paymentMethod + properties: + email: + type: string + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/set-payment-information + "/V1/guest-carts/{cartId}/shipping-information": + post: + tags: + - guest-carts/{cartId}/shipping-information + description: '' + operationId: PostV1GuestcartsCartIdShippinginformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdShippinginformationBody + in: body + schema: + required: + - addressInformation + properties: + addressInformation: + "$ref": "#/definitions/checkout-data-shipping-information-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/checkout-data-payment-details-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/shipping-information + "/V1/guest-carts/{cartId}/shipping-methods": + get: + tags: + - guest-carts/{cartId}/shipping-methods + description: List applicable shipping methods for a specified quote. + operationId: GetV1GuestcartsCartIdShippingmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The shopping cart ID. + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods. + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/shipping-methods + "/V1/guest-carts/{cartId}/totals": + get: + tags: + - guest-carts/{cartId}/totals + description: Return quote totals data for a specified cart. + operationId: GetV1GuestcartsCartIdTotals + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-totals-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/totals + "/V1/guest-carts/{cartId}/totals-information": + post: + tags: + - guest-carts/{cartId}/totals-information + description: Calculate quote totals based on address and shipping method. + operationId: PostV1GuestcartsCartIdTotalsinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdTotalsinformationBody + in: body + schema: + required: + - addressInformation + properties: + addressInformation: + "$ref": "#/definitions/checkout-data-totals-information-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-totals-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/totals-information + "/V1/guest-giftregistry/{cartId}/estimate-shipping-methods": + post: + tags: + - guest-giftregistry/{cartId}/estimate-shipping-methods + description: Estimate shipping + operationId: PostV1GuestgiftregistryCartIdEstimateshippingmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The shopping cart ID. + - name: PostV1GuestgiftregistryCartIdEstimateshippingmethodsBody + in: body + schema: + required: + - registryId + properties: + registryId: + type: integer + description: The estimate registry id + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods. + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-giftregistry/{cartId}/estimate-shipping-methods + "/V1/integration/admin/token": + post: + tags: + - integration/admin/token + description: Create access token for admin given the admin credentials. + operationId: PostV1IntegrationAdminToken + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1IntegrationAdminTokenBody + in: body + schema: + required: + - username + - password + properties: + username: + type: string + password: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + description: Token created + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: integration/admin/token + "/V1/integration/customer/revoke-customer-token": + post: + tags: + - integration/customer/revoke-customer-token + description: Revoke token by customer id. + operationId: PostV1IntegrationCustomerRevokecustomertoken + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: integration/customer/revoke-customer-token + "/V1/integration/customer/token": + post: + tags: + - integration/customer/token + description: Create access token for admin given the customer credentials. + operationId: PostV1IntegrationCustomerToken + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1IntegrationCustomerTokenBody + in: body + schema: + required: + - username + - password + properties: + username: + type: string + password: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + description: Token created + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: integration/customer/token + "/V1/inventory/in-store-pickup/pickup-locations/": + get: + tags: + - inventory/in-store-pickup/pickup-locations/ + description: Get Pickup Locations according to the results of filtration by + Search Request. + operationId: GetV1InventoryInstorepickupPickuplocations + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchRequest[area][radius] + in: query + type: integer + description: Search radius in KM. + - name: searchRequest[area][searchTerm] + in: query + type: string + description: Search term string. + - name: searchRequest[filters][country][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][country][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][postcode][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][postcode][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][region][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][region][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][regionId][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][regionId][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][city][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][city][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][street][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][street][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][name][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][name][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][pickupLocationCode][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][pickupLocationCode][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[pageSize] + in: query + type: integer + description: Page size. + - name: searchRequest[currentPage] + in: query + type: integer + description: Current page. + - name: searchRequest[scopeType] + in: query + type: string + description: Sales Channel Type. + - name: searchRequest[scopeCode] + in: query + type: string + description: Sales Channel code. + - name: searchRequest[sort][0][field] + in: query + type: string + description: Sorting field. + - name: searchRequest[sort][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchRequest[extensionAttributes][productsInfo][0][sku] + in: query + type: string + description: Product SKU. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-result-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/in-store-pickup/pickup-locations/ + post: + tags: + - inventory/in-store-pickup/pickup-locations/ + description: Get Pickup Locations according to the results of filtration by + Search Request. + operationId: PostV1InventoryInstorepickupPickuplocations + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1InventoryInstorepickupPickuplocationsBody + in: body + schema: + required: + - searchRequest + properties: + searchRequest: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-result-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/in-store-pickup/pickup-locations/ + "/V1/negotiable-carts/{cartId}/billing-address": + get: + tags: + - negotiable-carts/{cartId}/billing-address + description: Returns the billing address for a specified quote. + operationId: GetV1NegotiablecartsCartIdBillingaddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-address-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/billing-address + post: + tags: + - negotiable-carts/{cartId}/billing-address + description: Assigns a specified billing address to a specified cart. + operationId: PostV1NegotiablecartsCartIdBillingaddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + - name: PostV1NegotiablecartsCartIdBillingaddressBody + in: body + schema: + required: + - address + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + useForShipping: + type: boolean + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Address ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/billing-address + "/V1/negotiable-carts/{cartId}/coupons": + delete: + tags: + - negotiable-carts/{cartId}/coupons + description: Deletes a coupon from a specified cart. + operationId: DeleteV1NegotiablecartsCartIdCoupons + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/coupons + "/V1/negotiable-carts/{cartId}/coupons/{couponCode}": + put: + tags: + - negotiable-carts/{cartId}/coupons/{couponCode} + description: Adds a coupon by code to a specified cart. + operationId: PutV1NegotiablecartsCartIdCouponsCouponCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + - name: couponCode + in: path + type: string + required: true + description: The coupon code data. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/coupons/{couponCode} + "/V1/negotiable-carts/{cartId}/estimate-shipping-methods": + post: + tags: + - negotiable-carts/{cartId}/estimate-shipping-methods + description: Estimate shipping by address and return list of available shipping + methods + operationId: PostV1NegotiablecartsCartIdEstimateshippingmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1NegotiablecartsCartIdEstimateshippingmethodsBody + in: body + schema: + required: + - address + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/estimate-shipping-methods + "/V1/negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id": + post: + tags: + - negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id + description: Estimate shipping + operationId: PostV1NegotiablecartsCartIdEstimateshippingmethodsbyaddressid + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The shopping cart ID. + - name: PostV1NegotiablecartsCartIdEstimateshippingmethodsbyaddressidBody + in: body + schema: + required: + - addressId + properties: + addressId: + type: integer + description: The estimate address id + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods. + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id + "/V1/negotiable-carts/{cartId}/giftCards": + post: + tags: + - negotiable-carts/{cartId}/giftCards + description: '' + operationId: PostV1NegotiablecartsCartIdGiftCards + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: PostV1NegotiablecartsCartIdGiftCardsBody + in: body + schema: + required: + - giftCardAccountData + properties: + giftCardAccountData: + "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/giftCards + "/V1/negotiable-carts/{cartId}/giftCards/{giftCardCode}": + delete: + tags: + - negotiable-carts/{cartId}/giftCards/{giftCardCode} + description: Remove GiftCard Account entity + operationId: DeleteV1NegotiablecartsCartIdGiftCardsGiftCardCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: giftCardCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/giftCards/{giftCardCode} + "/V1/negotiable-carts/{cartId}/payment-information": + post: + tags: + - negotiable-carts/{cartId}/payment-information + description: Set payment information and place order for a specified cart. + operationId: PostV1NegotiablecartsCartIdPaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1NegotiablecartsCartIdPaymentinformationBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/payment-information + get: + tags: + - negotiable-carts/{cartId}/payment-information + description: Get payment information + operationId: GetV1NegotiablecartsCartIdPaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/checkout-data-payment-details-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/payment-information + "/V1/negotiable-carts/{cartId}/po-payment-information": + post: + tags: + - negotiable-carts/{cartId}/po-payment-information + description: Set payment information and place purchase order for a specified + negotiable quote. + operationId: PostV1NegotiablecartsCartIdPopaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: PostV1NegotiablecartsCartIdPopaymentinformationBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Purchase Order ID. + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/po-payment-information + "/V1/negotiable-carts/{cartId}/set-payment-information": + post: + tags: + - negotiable-carts/{cartId}/set-payment-information + description: Set payment information for a specified cart. + operationId: PostV1NegotiablecartsCartIdSetpaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: PostV1NegotiablecartsCartIdSetpaymentinformationBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/set-payment-information + "/V1/negotiable-carts/{cartId}/shipping-information": + post: + tags: + - negotiable-carts/{cartId}/shipping-information + description: '' + operationId: PostV1NegotiablecartsCartIdShippinginformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: PostV1NegotiablecartsCartIdShippinginformationBody + in: body + schema: + required: + - addressInformation + properties: + addressInformation: + "$ref": "#/definitions/checkout-data-shipping-information-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/checkout-data-payment-details-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/shipping-information + "/V1/negotiable-carts/{cartId}/totals": + get: + tags: + - negotiable-carts/{cartId}/totals + description: Returns quote totals data for a specified cart. + operationId: GetV1NegotiablecartsCartIdTotals + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-totals-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiable-carts/{cartId}/totals + "/V1/negotiableQuoteTemplate/accept": + post: + tags: + - negotiableQuoteTemplate/accept + description: Create quote template from quote + operationId: PostV1NegotiableQuoteTemplateAccept + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiableQuoteTemplateAcceptBody + in: body + schema: + required: + - templateId + properties: + templateId: + type: integer + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/accept + "/V1/negotiableQuoteTemplate/generateQuote": + post: + tags: + - negotiableQuoteTemplate/generateQuote + description: Generate quote from template + operationId: PostV1NegotiableQuoteTemplateGenerateQuote + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiableQuoteTemplateGenerateQuoteBody + in: body + schema: + required: + - templateId + properties: + templateId: + type: integer + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/generateQuote + "/V1/negotiableQuoteTemplate/submitToSeller": + post: + tags: + - negotiableQuoteTemplate/submitToSeller + description: Send template to seller + operationId: PostV1NegotiableQuoteTemplateSubmitToSeller + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1NegotiableQuoteTemplateSubmitToSellerBody + in: body + schema: + required: + - templateId + properties: + templateId: + type: integer + commentText: + type: string + files: + type: array + items: + "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface" + type: object + xml: + name: request + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: negotiableQuoteTemplate/submitToSeller + "/V1/payment-order/completeOrder": + post: + tags: + - payment-order/completeOrder + description: Rest API endpoint to place an order + operationId: PostV1PaymentorderCompleteOrder + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1PaymentorderCompleteOrderBody + in: body + schema: + required: + - orderId + properties: + orderId: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payment-order/completeOrder + "/V1/payments-config/apple-pay/{location}": + get: + tags: + - payments-config/apple-pay/{location} + description: Get Apple Pay Config. + operationId: GetV1PaymentsconfigApplepayLocation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + description: sdk location. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-apple-pay-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-config/apple-pay/{location} + "/V1/payments-config/google-pay/{location}": + get: + tags: + - payments-config/google-pay/{location} + description: Get Google Pay Config. + operationId: GetV1PaymentsconfigGooglepayLocation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + description: sdk location. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-config/google-pay/{location} + "/V1/payments-config/hosted-fields/{location}": + get: + tags: + - payments-config/hosted-fields/{location} + description: Get Hosted Fields Config. + operationId: GetV1PaymentsconfigHostedfieldsLocation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + description: sdk location. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-hosted-fields-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-config/hosted-fields/{location} + "/V1/payments-config/smart-buttons/{location}": + get: + tags: + - payments-config/smart-buttons/{location} + description: Get Smart Buttons Config. + operationId: GetV1PaymentsconfigSmartbuttonsLocation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + description: sdk location. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-config/smart-buttons/{location} + "/V1/payments-config/{location}": + get: + tags: + - payments-config/{location} + description: Get Config. + operationId: GetV1PaymentsconfigLocation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + description: sdk location. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-payment-config-response-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-config/{location} + "/V1/payments-sdk/{location}": + get: + tags: + - payments-sdk/{location} + description: Get payment sdk url by location + operationId: GetV1PaymentssdkLocation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/payment-services-paypal-data-payment-sdk-params-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-sdk/{location} + "/V1/payments-sdk/{location}/{methodCode}": + get: + tags: + - payments-sdk/{location}/{methodCode} + description: Get payment sdk url by location and methodCode + operationId: GetV1PaymentssdkLocationMethodCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + - name: methodCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-sdk-params-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-sdk/{location}/{methodCode} + "/V1/paypal/lineItems": + post: + tags: + - paypal/lineItems + description: Rest endpoint to calculate totals and line items + operationId: PostV1PaypalLineItems + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1PaypalLineItemsBody + in: body + schema: + required: + - method + - cartId + properties: + method: + type: string + cartId: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: paypal/lineItems + "/V1/paypal/oneClick": + post: + tags: + - paypal/oneClick + description: Rest endpoint to add product to cart (mainly use for PayPal button + from PDP) + operationId: PostV1PaypalOneClick + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1PaypalOneClickBody + in: body + schema: + required: + - method + - productData + properties: + method: + type: string + productData: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: paypal/oneClick + "/V1/paypal/validatePhoneNumber": + post: + tags: + - paypal/validatePhoneNumber + description: Get & validate phone number and get shipping/billing email address + operationId: PostV1PaypalValidatePhoneNumber + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1PaypalValidatePhoneNumberBody + in: body + schema: + required: + - cartId + properties: + cartId: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: paypal/validatePhoneNumber + "/V1/products-render-info": + get: + tags: + - products-render-info + description: Collect and retrieve the list of product render info. This info + contains raw prices and formatted prices, product name, stock status, store_id, + etc. + operationId: GetV1Productsrenderinfo + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + - name: storeId + in: query + type: integer + required: true + - name: currencyCode + in: query + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-product-render-search-results-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products-render-info + "/V1/purchase-order-carts/{cartId}/payment-information": + post: + tags: + - purchase-order-carts/{cartId}/payment-information + description: Set payment information and place order for a specified cart. + operationId: PostV1PurchaseordercartsCartIdPaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: PostV1PurchaseordercartsCartIdPaymentinformationBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: purchase-order-carts/{cartId}/payment-information + get: + tags: + - purchase-order-carts/{cartId}/payment-information + description: Get payment information + operationId: GetV1PurchaseordercartsCartIdPaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/checkout-data-payment-details-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: purchase-order-carts/{cartId}/payment-information + "/V1/purchase-order-carts/{cartId}/set-payment-information": + post: + tags: + - purchase-order-carts/{cartId}/set-payment-information + description: Set payment information for a specified cart. + operationId: PostV1PurchaseordercartsCartIdSetpaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: integer + required: true + - name: PostV1PurchaseordercartsCartIdSetpaymentinformationBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: purchase-order-carts/{cartId}/set-payment-information + "/V1/requisition_lists": + post: + tags: + - requisition_lists + description: Save Requisition List + operationId: PostV1Requisition_lists + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1Requisition_listsBody + in: body + schema: + required: + - requisitionList + properties: + requisitionList: + "$ref": "#/definitions/requisition-list-data-requisition-list-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/requisition-list-data-requisition-list-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: requisition_lists + "/V1/reward/mine/use-reward": + post: + tags: + - reward/mine/use-reward + description: Set reward points to quote + operationId: PostV1RewardMineUsereward + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: reward/mine/use-reward + "/V1/search": + get: + tags: + - search + description: Make Full Text Search and return found Documents + operationId: GetV1Search + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[requestName] + in: query + type: string + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/framework-search-search-result-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: search + "/V1/tfa/provider/authy/activate": + post: + tags: + - tfa/provider/authy/activate + description: Activate the provider and get an admin token + operationId: PostV1TfaProviderAuthyActivate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderAuthyActivateBody + in: body + schema: + required: + - tfaToken + - otp + properties: + tfaToken: + type: string + otp: + type: string + type: object + xml: + name: request + responses: + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/authy/activate + "/V1/tfa/provider/authy/authenticate": + post: + tags: + - tfa/provider/authy/authenticate + description: Get an admin token using authy 2fa + operationId: PostV1TfaProviderAuthyAuthenticate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderAuthyAuthenticateBody + in: body + schema: + required: + - username + - password + - otp + properties: + username: + type: string + password: + type: string + otp: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + description: "$otp" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/authy/authenticate + "/V1/tfa/provider/authy/authenticate-onetouch": + post: + tags: + - tfa/provider/authy/authenticate-onetouch + description: Authenticate using the present one touch response and get an admin + token + operationId: PostV1TfaProviderAuthyAuthenticateonetouch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderAuthyAuthenticateonetouchBody + in: body + schema: + required: + - username + - password + properties: + username: + type: string + password: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/authy/authenticate-onetouch + "/V1/tfa/provider/authy/configure": + post: + tags: + - tfa/provider/authy/configure + description: Get the information required to configure google + operationId: PostV1TfaProviderAuthyConfigure + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderAuthyConfigureBody + in: body + schema: + required: + - tfaToken + - deviceData + properties: + tfaToken: + type: string + deviceData: + "$ref": "#/definitions/two-factor-auth-data-authy-device-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/two-factor-auth-data-authy-registration-prompt-response-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/authy/configure + "/V1/tfa/provider/authy/send-token/{via}": + post: + tags: + - tfa/provider/authy/send-token/{via} + description: Send a one time password to a device using authy + operationId: PostV1TfaProviderAuthySendtokenVia + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: via + in: path + type: string + required: true + - name: PostV1TfaProviderAuthySendtokenViaBody + in: body + schema: + required: + - username + - password + properties: + username: + type: string + password: + type: string + type: object + xml: + name: request + responses: + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/authy/send-token/{via} + "/V1/tfa/provider/duo_security/activate": + post: + tags: + - tfa/provider/duo_security/activate + description: Activate the provider and get an admin token + operationId: PostV1TfaProviderDuo_securityActivate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderDuo_securityActivateBody + in: body + schema: + required: + - tfaToken + properties: + tfaToken: + type: string + type: object + xml: + name: request + responses: + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/duo_security/activate + "/V1/tfa/provider/duo_security/authenticate": + post: + tags: + - tfa/provider/duo_security/authenticate + description: Authenticate and get an admin token with passcode + operationId: PostV1TfaProviderDuo_securityAuthenticate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderDuo_securityAuthenticateBody + in: body + schema: + required: + - username + - password + - passcode + properties: + username: + type: string + password: + type: string + passcode: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/duo_security/authenticate + "/V1/tfa/provider/duo_security/configure": + post: + tags: + - tfa/provider/duo_security/configure + description: Configure duo for first time user + operationId: PostV1TfaProviderDuo_securityConfigure + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderDuo_securityConfigureBody + in: body + schema: + required: + - tfaToken + properties: + tfaToken: + type: string + type: object + xml: + name: request + responses: + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/duo_security/configure + "/V1/tfa/provider/google/activate": + post: + tags: + - tfa/provider/google/activate + description: Activate the provider and get an admin token + operationId: PostV1TfaProviderGoogleActivate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderGoogleActivateBody + in: body + schema: + required: + - tfaToken + - otp + properties: + tfaToken: + type: string + otp: + type: string + type: object + xml: + name: request + responses: + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/google/activate + "/V1/tfa/provider/google/authenticate": + post: + tags: + - tfa/provider/google/authenticate + description: Get an admin token by authenticating using google + operationId: PostV1TfaProviderGoogleAuthenticate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderGoogleAuthenticateBody + in: body + schema: + required: + - username + - password + - otp + properties: + username: + type: string + password: + type: string + otp: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/google/authenticate + "/V1/tfa/provider/google/configure": + post: + tags: + - tfa/provider/google/configure + description: Get the information required to configure google + operationId: PostV1TfaProviderGoogleConfigure + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderGoogleConfigureBody + in: body + schema: + required: + - tfaToken + properties: + tfaToken: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/two-factor-auth-data-google-configure-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/google/configure + "/V1/tfa/provider/u2fkey/activate": + post: + tags: + - tfa/provider/u2fkey/activate + description: Activate the provider and get a token + operationId: PostV1TfaProviderU2fkeyActivate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderU2fkeyActivateBody + in: body + schema: + required: + - tfaToken + - publicKeyCredentialJson + properties: + tfaToken: + type: string + publicKeyCredentialJson: + type: string + type: object + xml: + name: request + responses: + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/u2fkey/activate + "/V1/tfa/provider/u2fkey/authentication-challenge": + post: + tags: + - tfa/provider/u2fkey/authentication-challenge + description: Get the information to initiate a WebAuthn registration ceremony + operationId: PostV1TfaProviderU2fkeyAuthenticationchallenge + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderU2fkeyAuthenticationchallengeBody + in: body + schema: + required: + - username + - password + properties: + username: + type: string + password: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/u2fkey/authentication-challenge + "/V1/tfa/provider/u2fkey/configure": + post: + tags: + - tfa/provider/u2fkey/configure + description: Get the information to initiate a WebAuthn registration ceremony + operationId: PostV1TfaProviderU2fkeyConfigure + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderU2fkeyConfigureBody + in: body + schema: + required: + - tfaToken + properties: + tfaToken: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/u2fkey/configure + "/V1/tfa/provider/u2fkey/verify": + post: + tags: + - tfa/provider/u2fkey/verify + description: Authenticate with the provider and get a token + operationId: PostV1TfaProviderU2fkeyVerify + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderU2fkeyVerifyBody + in: body + schema: + required: + - username + - password + - publicKeyCredentialJson + properties: + username: + type: string + password: + type: string + publicKeyCredentialJson: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/u2fkey/verify + "/V1/tfa/tfat-providers-to-activate": + get: + tags: + - tfa/tfat-providers-to-activate + description: Get the providers that the user still needs to configure + operationId: GetV1TfaTfatproviderstoactivate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: tfaToken + in: query + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/two-factor-auth-provider-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/tfat-providers-to-activate + "/V1/tfa/tfat-user-providers": + get: + tags: + - tfa/tfat-user-providers + description: Get the providers that the user is able to use for 2fa + operationId: GetV1TfaTfatuserproviders + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: tfaToken + in: query + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/two-factor-auth-provider-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/tfat-user-providers +definitions: + error-response: + type: object + properties: + message: + type: string + description: Error message + errors: + "$ref": "#/definitions/error-errors" + code: + type: integer + description: Error code + parameters: + "$ref": "#/definitions/error-parameters" + trace: + type: string + description: Stack trace + required: + - message + error-errors: + type: array + description: Errors list + items: + "$ref": "#/definitions/error-errors-item" + error-errors-item: + type: object + description: Error details + properties: + message: + type: string + description: Error message + parameters: + "$ref": "#/definitions/error-parameters" + error-parameters: + type: array + description: Error parameters list + items: + "$ref": "#/definitions/error-parameters-item" + error-parameters-item: + type: object + description: Error parameters item + properties: + resources: + type: string + description: ACL resource + fieldName: + type: string + description: Missing or invalid field name + fieldValue: + type: string + description: Incorrect field value + directory-data-currency-information-interface: + type: object + description: Currency Information interface. + properties: + base_currency_code: + type: string + description: The base currency code for the store. + base_currency_symbol: + type: string + description: The currency symbol of the base currency for the store. + default_display_currency_code: + type: string + description: The default display currency code for the store. + default_display_currency_symbol: + type: string + description: The currency symbol of the default display currency for the store. + available_currency_codes: + type: array + description: The list of allowed currency codes for the store. + items: + type: string + exchange_rates: + type: array + description: The list of exchange rate information for the store. + items: + "$ref": "#/definitions/directory-data-exchange-rate-interface" + extension_attributes: + "$ref": "#/definitions/directory-data-currency-information-extension-interface" + required: + - base_currency_code + - base_currency_symbol + - default_display_currency_code + - default_display_currency_symbol + - available_currency_codes + - exchange_rates + directory-data-exchange-rate-interface: + type: object + description: Exchange Rate interface. + properties: + currency_to: + type: string + description: The currency code associated with the exchange rate. + rate: + type: number + description: The exchange rate for the associated currency and the store's + base currency. + extension_attributes: + "$ref": "#/definitions/directory-data-exchange-rate-extension-interface" + required: + - currency_to + - rate + directory-data-exchange-rate-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Directory\Api\Data\ExchangeRateInterface + directory-data-currency-information-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Directory\Api\Data\CurrencyInformationInterface + directory-data-country-information-interface: + type: object + description: Country Information interface. + properties: + id: + type: string + description: The country id for the store. + two_letter_abbreviation: + type: string + description: The country 2 letter abbreviation for the store. + three_letter_abbreviation: + type: string + description: The country 3 letter abbreviation for the store. + full_name_locale: + type: string + description: The country full name (in store locale) for the store. + full_name_english: + type: string + description: The country full name (in English) for the store. + available_regions: + type: array + description: The available regions for the store. + items: + "$ref": "#/definitions/directory-data-region-information-interface" + extension_attributes: + "$ref": "#/definitions/directory-data-country-information-extension-interface" + required: + - id + - two_letter_abbreviation + - three_letter_abbreviation + - full_name_locale + - full_name_english + directory-data-region-information-interface: + type: object + description: Region Information interface. + properties: + id: + type: string + description: Region id + code: + type: string + description: Region code + name: + type: string + description: Region name + extension_attributes: + "$ref": "#/definitions/directory-data-region-information-extension-interface" + required: + - id + - code + - name + directory-data-region-information-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Directory\Api\Data\RegionInformationInterface + directory-data-country-information-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Directory\Api\Data\CountryInformationInterface + customer-data-customer-interface: + type: object + description: Customer entity interface for API handling. + properties: + id: + type: integer + description: Customer id + group_id: + type: integer + description: Group id + default_billing: + type: string + description: Default billing address id + default_shipping: + type: string + description: Default shipping address id + confirmation: + type: string + description: Confirmation + created_at: + type: string + description: Created at time + updated_at: + type: string + description: Updated at time + created_in: + type: string + description: Created in area + dob: + type: string + description: In keeping with current security and privacy best practices, + be sure you are aware of any potential legal and security risks associated + with the storage of customers’ full date of birth (month, day, year) along + with other personal identifiers (e.g., full name) before collecting or processing + such data. + email: + type: string + description: Email address + firstname: + type: string + description: First name + lastname: + type: string + description: Last name + middlename: + type: string + description: Middle name + prefix: + type: string + description: Prefix + suffix: + type: string + description: Suffix + gender: + type: integer + description: Gender + store_id: + type: integer + description: Store id + taxvat: + type: string + description: Tax Vat + website_id: + type: integer + description: Website id + addresses: + type: array + description: Customer addresses. + items: + "$ref": "#/definitions/customer-data-address-interface" + disable_auto_group_change: + type: integer + description: Disable auto group change flag. + extension_attributes: + "$ref": "#/definitions/customer-data-customer-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + required: + - email + - firstname + - lastname + customer-data-address-interface: + type: object + description: Customer address interface. + properties: + id: + type: integer + description: ID + customer_id: + type: integer + description: Customer ID + region: + "$ref": "#/definitions/customer-data-region-interface" + region_id: + type: integer + description: Region ID + country_id: + type: string + description: Country code in ISO_3166-2 format + street: + type: array + description: Street + items: + type: string + company: + type: string + description: Company + telephone: + type: string + description: Telephone number + fax: + type: string + description: Fax number + postcode: + type: string + description: Postcode + city: + type: string + description: City name + firstname: + type: string + description: First name + lastname: + type: string + description: Last name + middlename: + type: string + description: Middle name + prefix: + type: string + description: Prefix + suffix: + type: string + description: Suffix + vat_id: + type: string + description: Vat id + default_shipping: + type: boolean + description: If this address is default shipping address. + default_billing: + type: boolean + description: If this address is default billing address + extension_attributes: + "$ref": "#/definitions/customer-data-address-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + customer-data-region-interface: + type: object + description: Customer address region interface. + properties: + region_code: + type: string + description: Region code + region: + type: string + description: Region + region_id: + type: integer + description: Region id + extension_attributes: + "$ref": "#/definitions/customer-data-region-extension-interface" + required: + - region_code + - region + - region_id + customer-data-region-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Customer\Api\Data\RegionInterface + customer-data-address-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Customer\Api\Data\AddressInterface + framework-attribute-interface: + type: object + description: Interface for custom attribute value. + properties: + attribute_code: + type: string + description: Attribute code + value: + type: string + description: Attribute value + required: + - attribute_code + - value + customer-data-customer-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Customer\Api\Data\CustomerInterface + properties: + company_attributes: + "$ref": "#/definitions/company-data-company-customer-interface" + all_company_attributes: + type: array + items: + "$ref": "#/definitions/company-data-company-customer-interface" + is_subscribed: + type: boolean + assistance_allowed: + type: integer + company-data-company-customer-interface: + type: object + description: Extended customer custom attributes interface. + properties: + customer_id: + type: integer + description: Customer ID. + company_id: + type: integer + description: Company ID. + job_title: + type: string + description: Job title. + status: + type: integer + description: Customer status. + telephone: + type: string + description: Telephone. + is_default: + type: boolean + description: Is default + extension_attributes: + "$ref": "#/definitions/company-data-company-customer-extension-interface" + company-data-company-customer-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyCustomerInterface + catalog-data-product-render-search-results-interface: + type: object + description: Dto that holds render information about products + properties: + items: + type: array + description: List of products rendered information + items: + "$ref": "#/definitions/catalog-data-product-render-interface" + required: + - items + catalog-data-product-render-interface: + type: object + description: Represents Data Object which holds enough information to render product + This information is put into part as Add To Cart or Add to Compare Data or Price + Data + properties: + add_to_cart_button: + "$ref": "#/definitions/catalog-data-product-render-button-interface" + add_to_compare_button: + "$ref": "#/definitions/catalog-data-product-render-button-interface" + price_info: + "$ref": "#/definitions/catalog-data-product-render-price-info-interface" + images: + type: array + description: Enough information, that needed to render image on front + items: + "$ref": "#/definitions/catalog-data-product-render-image-interface" + url: + type: string + description: Product url + id: + type: integer + description: Product identifier + name: + type: string + description: Product name + type: + type: string + description: Product type. Such as bundle, grouped, simple, etc... + is_salable: + type: string + description: Information about product saleability (In Stock) + store_id: + type: integer + description: Information about current store id or requested store id + currency_code: + type: string + description: Current or desired currency code to product + extension_attributes: + "$ref": "#/definitions/catalog-data-product-render-extension-interface" + required: + - add_to_cart_button + - add_to_compare_button + - price_info + - images + - url + - id + - name + - type + - is_salable + - store_id + - currency_code + - extension_attributes + catalog-data-product-render-button-interface: + type: object + description: 'Button interface. This interface represents all manner of product + buttons: add to cart, add to compare, etc... The buttons describes by this interface + should have interaction with backend' + properties: + post_data: + type: string + description: Post data + url: + type: string + description: Url, needed to add product to cart + required_options: + type: boolean + description: Flag whether a product has options or not + extension_attributes: + "$ref": "#/definitions/catalog-data-product-render-button-extension-interface" + required: + - post_data + - url + - required_options + catalog-data-product-render-button-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ButtonInterface + catalog-data-product-render-price-info-interface: + type: object + description: Price interface. + properties: + final_price: + type: number + description: Final price + max_price: + type: number + description: Max price of a product + max_regular_price: + type: number + description: Max regular price + minimal_regular_price: + type: number + description: Minimal regular price + special_price: + type: number + description: Special price + minimal_price: + type: number + description: Minimal price + regular_price: + type: number + description: Regular price + formatted_prices: + "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-interface" + extension_attributes: + "$ref": "#/definitions/catalog-data-product-render-price-info-extension-interface" + required: + - final_price + - max_price + - max_regular_price + - minimal_regular_price + - special_price + - minimal_price + - regular_price + - formatted_prices + catalog-data-product-render-formatted-price-info-interface: + type: object + description: 'Formatted Price interface. Aggregate formatted html with price representations. + E.g.: $9.00 Consider currency, rounding and html' + properties: + final_price: + type: string + description: Html with final price + max_price: + type: string + description: Max price of a product + minimal_price: + type: string + description: The minimal price of the product or variation + max_regular_price: + type: string + description: Max regular price + minimal_regular_price: + type: string + description: Minimal regular price + special_price: + type: string + description: Special price + regular_price: + type: string + description: Price - is price of product without discounts and special price + with taxes and fixed product tax + extension_attributes: + "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-extension-interface" + required: + - final_price + - max_price + - minimal_price + - max_regular_price + - minimal_regular_price + - special_price + - regular_price + catalog-data-product-render-formatted-price-info-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\FormattedPriceInfoInterface + catalog-data-product-render-price-info-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\PriceInfoInterface + properties: + msrp: + "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-interface" + tax_adjustments: + "$ref": "#/definitions/catalog-data-product-render-price-info-interface" + weee_attributes: + type: array + items: + "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-interface" + weee_adjustment: + type: string + msrp-data-product-render-msrp-price-info-interface: + type: object + description: Price interface. + properties: + msrp_price: + type: string + is_applicable: + type: string + is_shown_price_on_gesture: + type: string + msrp_message: + type: string + explanation_message: + type: string + extension_attributes: + "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-extension-interface" + required: + - msrp_price + - is_applicable + - is_shown_price_on_gesture + - msrp_message + - explanation_message + msrp-data-product-render-msrp-price-info-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Msrp\Api\Data\ProductRender\MsrpPriceInfoInterface + weee-data-product-render-weee-adjustment-attribute-interface: + type: object + description: List of all weee attributes, their amounts, etc.., that product has + properties: + amount: + type: string + description: Weee attribute amount + tax_amount: + type: string + description: Tax which is calculated to fixed product tax attribute + tax_amount_incl_tax: + type: string + description: Tax amount of weee attribute + amount_excl_tax: + type: string + description: Product amount exclude tax + attribute_code: + type: string + description: Weee attribute code + extension_attributes: + "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-extension-interface" + required: + - amount + - tax_amount + - tax_amount_incl_tax + - amount_excl_tax + - attribute_code + - extension_attributes + weee-data-product-render-weee-adjustment-attribute-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Weee\Api\Data\ProductRender\WeeeAdjustmentAttributeInterface + catalog-data-product-render-image-interface: + type: object + description: Product Render image interface. Represents physical characteristics + of image, that can be used in product listing or product view + properties: + url: + type: string + description: Image url + code: + type: string + description: Image code + height: + type: number + description: Image height + width: + type: number + description: Image width in px + label: + type: string + description: Image label + resized_width: + type: number + description: Resize width + resized_height: + type: number + description: Resize height + extension_attributes: + "$ref": "#/definitions/catalog-data-product-render-image-extension-interface" + required: + - url + - code + - height + - width + - label + - resized_width + - resized_height + catalog-data-product-render-image-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ImageInterface + catalog-data-product-render-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRenderInterface + properties: + wishlist_button: + "$ref": "#/definitions/catalog-data-product-render-button-interface" + review_html: + type: string + quote-data-cart-interface: + type: object + description: Interface CartInterface + properties: + id: + type: integer + description: Cart/quote ID. + created_at: + type: string + description: Cart creation date and time. Otherwise, null. + updated_at: + type: string + description: Cart last update date and time. Otherwise, null. + converted_at: + type: string + description: Cart conversion date and time. Otherwise, null. + is_active: + type: boolean + description: Active status flag value. Otherwise, null. + is_virtual: + type: boolean + description: Virtual flag value. Otherwise, null. + items: + type: array + description: Array of items. Otherwise, null. + items: + "$ref": "#/definitions/quote-data-cart-item-interface" + items_count: + type: integer + description: Number of different items or products in the cart. Otherwise, + null. + items_qty: + type: number + description: Total quantity of all cart items. Otherwise, null. + customer: + "$ref": "#/definitions/customer-data-customer-interface" + billing_address: + "$ref": "#/definitions/quote-data-address-interface" + reserved_order_id: + type: string + description: Reserved order ID. Otherwise, null. + orig_order_id: + type: integer + description: Original order ID. Otherwise, null. + currency: + "$ref": "#/definitions/quote-data-currency-interface" + customer_is_guest: + type: boolean + description: For guest customers, false for logged in customers + customer_note: + type: string + description: Notice text + customer_note_notify: + type: boolean + description: Customer notification flag + customer_tax_class_id: + type: integer + description: Customer tax class ID. + store_id: + type: integer + description: Store identifier + extension_attributes: + "$ref": "#/definitions/quote-data-cart-extension-interface" + required: + - id + - customer + - store_id + quote-data-cart-item-interface: + type: object + description: Interface CartItemInterface + properties: + item_id: + type: integer + description: Item ID. Otherwise, null. + sku: + type: string + description: Product SKU. Otherwise, null. + qty: + type: number + description: Product quantity. + name: + type: string + description: Product name. Otherwise, null. + price: + type: number + description: Product price. Otherwise, null. + product_type: + type: string + description: Product type. Otherwise, null. + quote_id: + type: string + description: Quote id. + product_option: + "$ref": "#/definitions/quote-data-product-option-interface" + extension_attributes: + "$ref": "#/definitions/quote-data-cart-item-extension-interface" + required: + - qty + - quote_id + quote-data-product-option-interface: + type: object + description: Product option interface + properties: + extension_attributes: + "$ref": "#/definitions/quote-data-product-option-extension-interface" + quote-data-product-option-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ProductOptionInterface + properties: + custom_options: + type: array + items: + "$ref": "#/definitions/catalog-data-custom-option-interface" + bundle_options: + type: array + items: + "$ref": "#/definitions/bundle-data-bundle-option-interface" + downloadable_option: + "$ref": "#/definitions/downloadable-data-downloadable-option-interface" + giftcard_item_option: + "$ref": "#/definitions/gift-card-data-gift-card-option-interface" + configurable_item_options: + type: array + items: + "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-interface" + grouped_options: + type: array + items: + "$ref": "#/definitions/grouped-product-data-grouped-options-interface" + catalog-data-custom-option-interface: + type: object + description: Interface CustomOptionInterface + properties: + option_id: + type: string + description: Option id + option_value: + type: string + description: Option value + extension_attributes: + "$ref": "#/definitions/catalog-data-custom-option-extension-interface" + required: + - option_id + - option_value + catalog-data-custom-option-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface + properties: + file_info: + "$ref": "#/definitions/framework-data-image-content-interface" + framework-data-image-content-interface: + type: object + description: Image Content data interface + properties: + base64_encoded_data: + type: string + description: Media data (base64 encoded content) + type: + type: string + description: MIME type + name: + type: string + description: Image name + required: + - base64_encoded_data + - type + - name + bundle-data-bundle-option-interface: + type: object + description: Interface BundleOptionInterface + properties: + option_id: + type: integer + description: Bundle option id. + option_qty: + type: integer + description: Bundle option quantity. + option_selections: + type: array + description: Bundle option selection ids. + items: + type: integer + extension_attributes: + "$ref": "#/definitions/bundle-data-bundle-option-extension-interface" + required: + - option_id + - option_qty + - option_selections + bundle-data-bundle-option-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface + downloadable-data-downloadable-option-interface: + type: object + description: Downloadable Option + properties: + downloadable_links: + type: array + description: The list of downloadable links + items: + type: integer + required: + - downloadable_links + gift-card-data-gift-card-option-interface: + type: object + description: Interface GiftCardOptionInterface + properties: + giftcard_amount: + type: string + description: Gift card amount. + custom_giftcard_amount: + type: number + description: Gift card open amount value. + giftcard_sender_name: + type: string + description: Gift card sender name. + giftcard_recipient_name: + type: string + description: Gift card recipient name. + giftcard_sender_email: + type: string + description: Gift card sender email. + giftcard_recipient_email: + type: string + description: Gift card recipient email. + giftcard_message: + type: string + description: Giftcard message. + extension_attributes: + "$ref": "#/definitions/gift-card-data-gift-card-option-extension-interface" + required: + - giftcard_amount + - giftcard_sender_name + - giftcard_recipient_name + - giftcard_sender_email + - giftcard_recipient_email + gift-card-data-gift-card-option-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftCardOptionInterface + properties: + giftcard_created_codes: + type: array + items: + type: string + configurable-product-data-configurable-item-option-value-interface: + type: object + description: Interface ConfigurableItemOptionValueInterface + properties: + option_id: + type: string + description: Option SKU + option_value: + type: integer + description: Item id + extension_attributes: + "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-extension-interface" + required: + - option_id + configurable-product-data-configurable-item-option-value-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface + grouped-product-data-grouped-options-interface: + type: object + description: Represents `product item id with qty` of a grouped product. + properties: + id: + type: integer + description: Associated product id + qty: + type: integer + description: Associated product qty + extension_attributes: + "$ref": "#/definitions/grouped-product-data-grouped-options-extension-interface" + grouped-product-data-grouped-options-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\GroupedProduct\Api\Data\GroupedOptionsInterface + quote-data-cart-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface + properties: + discounts: + type: array + items: + "$ref": "#/definitions/sales-rule-data-rule-discount-interface" + negotiable_quote_item: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-interface" + sales-rule-data-rule-discount-interface: + type: object + description: Rule discount Interface + properties: + discount_data: + "$ref": "#/definitions/sales-rule-data-discount-data-interface" + rule_label: + type: string + description: Rule Label + rule_i_d: + type: integer + description: Rule ID + required: + - discount_data + - rule_label + - rule_i_d + sales-rule-data-discount-data-interface: + type: object + description: Discount Data Interface + properties: + amount: + type: number + description: Amount + base_amount: + type: number + description: Base Amount + original_amount: + type: number + description: Original Amount + base_original_amount: + type: number + description: Base Original Amount + required: + - amount + - base_amount + - original_amount + - base_original_amount + negotiable-quote-data-negotiable-quote-item-interface: + type: object + description: Interface CompanyQuoteConfigInterface + properties: + item_id: + type: integer + description: Quote item id + original_price: + type: number + description: Quote item original price + original_tax_amount: + type: number + description: Quote item original tax amount + original_discount_amount: + type: number + description: Quote item original discount amount + extension_attributes: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-extension-interface" + required: + - item_id + - original_price + - original_tax_amount + - original_discount_amount + negotiable-quote-data-negotiable-quote-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemInterface + properties: + negotiated_price_type: + type: integer + negotiated_price_value: + type: number + last_item_notes: + type: array + items: + "$ref": "#/definitions/negotiable-quote-data-item-note-interface" + is_discounting_locked: + type: boolean + min_qty: + type: number + max_qty: + type: number + negotiable-quote-data-item-note-interface: + type: object + description: Interface ItemNoteInterface + properties: + note_id: + type: integer + description: Note ID. + negotiable_quote_item_id: + type: integer + description: Negotiable quote item Id + creator_type: + type: integer + description: The note creator type. + creator_id: + type: integer + description: Note creator ID. + note: + type: string + description: Note. + created_at: + type: string + description: Comment created at. + extension_attributes: + "$ref": "#/definitions/negotiable-quote-data-item-note-extension-interface" + required: + - negotiable_quote_item_id + - creator_type + - creator_id + - note + negotiable-quote-data-item-note-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\ItemNoteInterface + quote-data-address-interface: + type: object + description: Interface AddressInterface + properties: + id: + type: integer + description: Id + region: + type: string + description: Region name + region_id: + type: integer + description: Region id + region_code: + type: string + description: Region code + country_id: + type: string + description: Country id + street: + type: array + description: Street + items: + type: string + company: + type: string + description: Company + telephone: + type: string + description: Telephone number + fax: + type: string + description: Fax number + postcode: + type: string + description: Postcode + city: + type: string + description: City name + firstname: + type: string + description: First name + lastname: + type: string + description: Last name + middlename: + type: string + description: Middle name + prefix: + type: string + description: Prefix + suffix: + type: string + description: Suffix + vat_id: + type: string + description: Vat id + customer_id: + type: integer + description: Customer id + email: + type: string + description: Billing/shipping email + same_as_billing: + type: integer + description: Same as billing flag + customer_address_id: + type: integer + description: Customer address id + save_in_address_book: + type: integer + description: Save in address book flag + extension_attributes: + "$ref": "#/definitions/quote-data-address-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + required: + - region + - region_id + - region_code + - country_id + - street + - telephone + - postcode + - city + - firstname + - lastname + - email + quote-data-address-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface + properties: + discounts: + type: array + items: + "$ref": "#/definitions/sales-rule-data-rule-discount-interface" + gift_registry_id: + type: integer + pickup_location_code: + type: string + quote-data-currency-interface: + type: object + description: Interface CurrencyInterface + properties: + global_currency_code: + type: string + description: Global currency code + base_currency_code: + type: string + description: Base currency code + store_currency_code: + type: string + description: Store currency code + quote_currency_code: + type: string + description: Quote currency code + store_to_base_rate: + type: number + description: Store currency to base currency rate + store_to_quote_rate: + type: number + description: Store currency to quote currency rate + base_to_global_rate: + type: number + description: Base currency to global currency rate + base_to_quote_rate: + type: number + description: Base currency to quote currency rate + extension_attributes: + "$ref": "#/definitions/quote-data-currency-extension-interface" + quote-data-currency-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CurrencyInterface + quote-data-cart-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartInterface + properties: + shipping_assignments: + type: array + items: + "$ref": "#/definitions/quote-data-shipping-assignment-interface" + negotiable_quote: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-interface" + company_id: + type: integer + coupon_codes: + type: array + items: + type: string + quote-data-shipping-assignment-interface: + type: object + description: Interface ShippingAssignmentInterface + properties: + shipping: + "$ref": "#/definitions/quote-data-shipping-interface" + items: + type: array + items: + "$ref": "#/definitions/quote-data-cart-item-interface" + extension_attributes: + "$ref": "#/definitions/quote-data-shipping-assignment-extension-interface" + required: + - shipping + - items + quote-data-shipping-interface: + type: object + description: Interface ShippingInterface + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + method: + type: string + description: Shipping method + extension_attributes: + "$ref": "#/definitions/quote-data-shipping-extension-interface" + required: + - address + - method + quote-data-shipping-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingInterface + quote-data-shipping-assignment-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingAssignmentInterface + negotiable-quote-data-negotiable-quote-interface: + type: object + description: Interface NegotiableQuoteInterface + properties: + quote_id: + type: integer + description: Negotiable quote ID. + is_regular_quote: + type: boolean + description: Is regular quote. + status: + type: string + description: Negotiable quote status. + negotiated_price_type: + type: integer + description: Negotiated price type. + negotiated_price_value: + type: number + description: Negotiated price value. + shipping_price: + type: number + description: Proposed shipping price. + quote_name: + type: string + description: Negotiable quote name. + expiration_period: + type: string + description: Expiration period. + email_notification_status: + type: integer + description: Email notification status. + has_unconfirmed_changes: + type: boolean + description: Has unconfirmed changes. + is_shipping_tax_changed: + type: boolean + description: Shipping tax changes. + is_customer_price_changed: + type: boolean + description: Customer price changes. + notifications: + type: integer + description: Quote notifications. + applied_rule_ids: + type: string + description: Quote rules. + is_address_draft: + type: boolean + description: Is address draft. + deleted_sku: + type: string + description: Deleted products sku. + creator_id: + type: integer + description: Quote creator id. + creator_type: + type: integer + description: Quote creator type. + original_total_price: + type: number + description: Quote original total price. + base_original_total_price: + type: number + description: Quote original total price in base currency. + negotiated_total_price: + type: number + description: Quote negotiated total price. + base_negotiated_total_price: + type: number + description: Quote negotiated total price in base currency. + extension_attributes: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-extension-interface" + required: + - quote_id + - is_regular_quote + - status + - negotiated_price_type + - negotiated_price_value + - shipping_price + - quote_name + - expiration_period + - email_notification_status + - has_unconfirmed_changes + - is_shipping_tax_changed + - is_customer_price_changed + - notifications + - applied_rule_ids + - is_address_draft + - deleted_sku + - creator_id + - creator_type + negotiable-quote-data-negotiable-quote-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteInterface + quote-data-payment-interface: + type: object + description: Interface PaymentInterface + properties: + po_number: + type: string + description: Purchase order number + method: + type: string + description: Payment method code + additional_data: + type: array + description: Payment additional details + items: + type: string + extension_attributes: + "$ref": "#/definitions/quote-data-payment-extension-interface" + required: + - method + quote-data-payment-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\PaymentInterface + properties: + agreement_ids: + type: array + items: + type: string + quote-data-shipping-method-interface: + type: object + description: Interface ShippingMethodInterface + properties: + carrier_code: + type: string + description: Shipping carrier code. + method_code: + type: string + description: Shipping method code. + carrier_title: + type: string + description: Shipping carrier title. Otherwise, null. + method_title: + type: string + description: Shipping method title. Otherwise, null. + amount: + type: number + description: Shipping amount in store currency. + base_amount: + type: number + description: Shipping amount in base currency. + available: + type: boolean + description: The value of the availability flag for the current shipping method. + extension_attributes: + "$ref": "#/definitions/quote-data-shipping-method-extension-interface" + error_message: + type: string + description: Shipping Error message. + price_excl_tax: + type: number + description: Shipping price excl tax. + price_incl_tax: + type: number + description: Shipping price incl tax. + required: + - carrier_code + - method_code + - amount + - base_amount + - available + - error_message + - price_excl_tax + - price_incl_tax + quote-data-shipping-method-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingMethodInterface + quote-data-payment-method-interface: + type: object + description: Interface PaymentMethodInterface + properties: + code: + type: string + description: Payment method code + title: + type: string + description: Payment method title + required: + - code + - title + quote-data-totals-additional-data-interface: + type: object + description: Additional data for totals collection. + properties: + extension_attributes: + "$ref": "#/definitions/quote-data-totals-additional-data-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + quote-data-totals-additional-data-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsAdditionalDataInterface + properties: + gift_messages: + type: array + items: + "$ref": "#/definitions/gift-message-data-message-interface" + gift-message-data-message-interface: + type: object + description: Interface MessageInterface + properties: + gift_message_id: + type: integer + description: Gift message ID. Otherwise, null. + customer_id: + type: integer + description: Customer ID. Otherwise, null. + sender: + type: string + description: Sender name. + recipient: + type: string + description: Recipient name. + message: + type: string + description: Message text. + extension_attributes: + "$ref": "#/definitions/gift-message-data-message-extension-interface" + required: + - sender + - recipient + - message + gift-message-data-message-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\GiftMessage\Api\Data\MessageInterface + properties: + entity_id: + type: string + entity_type: + type: string + wrapping_id: + type: integer + wrapping_allow_gift_receipt: + type: boolean + wrapping_add_printed_card: + type: boolean + quote-data-totals-interface: + type: object + description: Interface TotalsInterface + properties: + grand_total: + type: number + description: Grand total in quote currency + base_grand_total: + type: number + description: Grand total in base currency + subtotal: + type: number + description: Subtotal in quote currency + base_subtotal: + type: number + description: Subtotal in base currency + discount_amount: + type: number + description: Discount amount in quote currency + base_discount_amount: + type: number + description: Discount amount in base currency + subtotal_with_discount: + type: number + description: Subtotal in quote currency with applied discount + base_subtotal_with_discount: + type: number + description: Subtotal in base currency with applied discount + shipping_amount: + type: number + description: Shipping amount in quote currency + base_shipping_amount: + type: number + description: Shipping amount in base currency + shipping_discount_amount: + type: number + description: Shipping discount amount in quote currency + base_shipping_discount_amount: + type: number + description: Shipping discount amount in base currency + tax_amount: + type: number + description: Tax amount in quote currency + base_tax_amount: + type: number + description: Tax amount in base currency + weee_tax_applied_amount: + type: number + description: Item weee tax applied amount in quote currency. + shipping_tax_amount: + type: number + description: Shipping tax amount in quote currency + base_shipping_tax_amount: + type: number + description: Shipping tax amount in base currency + subtotal_incl_tax: + type: number + description: Subtotal including tax in quote currency + base_subtotal_incl_tax: + type: number + description: Subtotal including tax in base currency + shipping_incl_tax: + type: number + description: Shipping including tax in quote currency + base_shipping_incl_tax: + type: number + description: Shipping including tax in base currency + base_currency_code: + type: string + description: Base currency code + quote_currency_code: + type: string + description: Quote currency code + coupon_code: + type: string + description: Applied coupon code + items_qty: + type: integer + description: Items qty + items: + type: array + description: Totals by items + items: + "$ref": "#/definitions/quote-data-totals-item-interface" + total_segments: + type: array + description: Dynamically calculated totals + items: + "$ref": "#/definitions/quote-data-total-segment-interface" + extension_attributes: + "$ref": "#/definitions/quote-data-totals-extension-interface" + required: + - weee_tax_applied_amount + - total_segments + quote-data-totals-item-interface: + type: object + description: Interface TotalsItemInterface + properties: + item_id: + type: integer + description: Item id + price: + type: number + description: Item price in quote currency. + base_price: + type: number + description: Item price in base currency. + qty: + type: number + description: Item quantity. + row_total: + type: number + description: Row total in quote currency. + base_row_total: + type: number + description: Row total in base currency. + row_total_with_discount: + type: number + description: Row total with discount in quote currency. Otherwise, null. + tax_amount: + type: number + description: Tax amount in quote currency. Otherwise, null. + base_tax_amount: + type: number + description: Tax amount in base currency. Otherwise, null. + tax_percent: + type: number + description: Tax percent. Otherwise, null. + discount_amount: + type: number + description: Discount amount in quote currency. Otherwise, null. + base_discount_amount: + type: number + description: Discount amount in base currency. Otherwise, null. + discount_percent: + type: number + description: Discount percent. Otherwise, null. + price_incl_tax: + type: number + description: Price including tax in quote currency. Otherwise, null. + base_price_incl_tax: + type: number + description: Price including tax in base currency. Otherwise, null. + row_total_incl_tax: + type: number + description: Row total including tax in quote currency. Otherwise, null. + base_row_total_incl_tax: + type: number + description: Row total including tax in base currency. Otherwise, null. + options: + type: string + description: Item price in quote currency. + weee_tax_applied_amount: + type: number + description: Item weee tax applied amount in quote currency. + weee_tax_applied: + type: string + description: Item weee tax applied in quote currency. + extension_attributes: + "$ref": "#/definitions/quote-data-totals-item-extension-interface" + name: + type: string + description: Product name. Otherwise, null. + required: + - item_id + - price + - base_price + - qty + - row_total + - base_row_total + - options + - weee_tax_applied_amount + - weee_tax_applied + quote-data-totals-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsItemInterface + properties: + negotiable_quote_item_totals: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-interface" + negotiable-quote-data-negotiable-quote-item-totals-interface: + type: object + description: Extension attribute for quote item totals model. + properties: + cost: + type: number + description: Cost for quote item. + catalog_price: + type: number + description: Catalog price for quote item. + base_catalog_price: + type: number + description: Catalog price for quote item in base currency. + catalog_price_incl_tax: + type: number + description: Catalog price with included tax for quote item. + base_catalog_price_incl_tax: + type: number + description: Catalog price with included tax for quote item in base currency. + cart_price: + type: number + description: Cart price for quote item. + base_cart_price: + type: number + description: Cart price for quote item in base currency. + cart_tax: + type: number + description: Tax from catalog price for quote item. + base_cart_tax: + type: number + description: Tax from catalog price for quote item in base currency. + cart_price_incl_tax: + type: number + description: Cart price with included tax for quote item. + base_cart_price_incl_tax: + type: number + description: Cart price with included tax for quote item in base currency. + extension_attributes: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-extension-interface" + required: + - cost + - catalog_price + - base_catalog_price + - catalog_price_incl_tax + - base_catalog_price_incl_tax + - cart_price + - base_cart_price + - cart_tax + - base_cart_tax + - cart_price_incl_tax + - base_cart_price_incl_tax + negotiable-quote-data-negotiable-quote-item-totals-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemTotalsInterface + quote-data-total-segment-interface: + type: object + description: Interface TotalsInterface + properties: + code: + type: string + description: Code + title: + type: string + description: Total title + value: + type: number + description: Total value + area: + type: string + description: Display area code. + extension_attributes: + "$ref": "#/definitions/quote-data-total-segment-extension-interface" + required: + - code + - value + quote-data-total-segment-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalSegmentInterface + properties: + tax_grandtotal_details: + type: array + items: + "$ref": "#/definitions/tax-data-grand-total-details-interface" + gift_cards: + type: string + gw_order_id: + type: string + gw_item_ids: + type: array + items: + type: string + gw_allow_gift_receipt: + type: string + gw_add_card: + type: string + gw_price: + type: string + gw_base_price: + type: string + gw_items_price: + type: string + gw_items_base_price: + type: string + gw_card_price: + type: string + gw_card_base_price: + type: string + gw_base_tax_amount: + type: string + gw_tax_amount: + type: string + gw_items_base_tax_amount: + type: string + gw_items_tax_amount: + type: string + gw_card_base_tax_amount: + type: string + gw_card_tax_amount: + type: string + gw_price_incl_tax: + type: string + gw_base_price_incl_tax: + type: string + gw_card_price_incl_tax: + type: string + gw_card_base_price_incl_tax: + type: string + gw_items_price_incl_tax: + type: string + gw_items_base_price_incl_tax: + type: string + tax-data-grand-total-details-interface: + type: object + description: Interface GrandTotalDetailsInterface + properties: + amount: + type: number + description: Tax amount value + rates: + type: array + description: Tax rates info + items: + "$ref": "#/definitions/tax-data-grand-total-rates-interface" + group_id: + type: integer + description: Group identifier + required: + - amount + - rates + - group_id + tax-data-grand-total-rates-interface: + type: object + description: Interface GrandTotalRatesInterface + properties: + percent: + type: string + description: Tax percentage value + title: + type: string + description: Rate title + required: + - percent + - title + quote-data-totals-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsInterface + properties: + coupon_label: + type: string + negotiable_quote_totals: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-totals-interface" + base_customer_balance_amount: + type: number + customer_balance_amount: + type: number + coupon_codes: + type: array + items: + type: string + coupons_labels: + type: array + items: + type: string + reward_points_balance: + type: number + reward_currency_amount: + type: number + base_reward_currency_amount: + type: number + negotiable-quote-data-negotiable-quote-totals-interface: + type: object + description: Extension attribute for quote totals model. + properties: + items_count: + type: integer + description: The number of different items or products in the cart. + quote_status: + type: string + description: Negotiable quote status. + created_at: + type: string + description: The cart creation date and time. + updated_at: + type: string + description: The cart last update date and time. + customer_group: + type: integer + description: Customer group id. + base_to_quote_rate: + type: number + description: Base currency to quote currency rate. + cost_total: + type: number + description: Total cost for quote. + base_cost_total: + type: number + description: Total cost for quote in base currency. + original_total: + type: number + description: Original quote total. + base_original_total: + type: number + description: Original quote total in base currency. + original_tax: + type: number + description: Original tax amount for quote. + base_original_tax: + type: number + description: Original tax amount for quote in base currency. + original_price_incl_tax: + type: number + description: Original price with included tax for quote. + base_original_price_incl_tax: + type: number + description: Original price with included tax for quote in base currency. + negotiated_price_type: + type: integer + description: Negotiable quote type. + negotiated_price_value: + type: number + description: Negotiable price value for quote. + required: + - items_count + - quote_status + - created_at + - updated_at + - customer_group + - base_to_quote_rate + - cost_total + - base_cost_total + - original_total + - base_original_total + - original_tax + - base_original_tax + - original_price_incl_tax + - base_original_price_incl_tax + - negotiated_price_type + - negotiated_price_value + framework-search-search-result-interface: + type: object + description: Interface SearchResultInterface + properties: + items: + type: array + items: + "$ref": "#/definitions/framework-search-document-interface" + aggregations: + "$ref": "#/definitions/framework-search-aggregation-interface" + search_criteria: + "$ref": "#/definitions/framework-search-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - aggregations + - search_criteria + - total_count + framework-search-document-interface: + type: object + description: Interface Search Document + properties: + id: + type: integer + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + required: + - id + framework-search-aggregation-interface: + type: object + description: Interface Aggregation to get faceted data + properties: + buckets: + type: array + description: All Document fields + items: + "$ref": "#/definitions/framework-search-bucket-interface" + bucket_names: + type: array + description: Document field names + items: + type: string + required: + - buckets + - bucket_names + framework-search-bucket-interface: + type: object + description: Interface for facet Bucket + properties: + name: + type: string + description: Field name + values: + type: array + description: Field values + items: + "$ref": "#/definitions/framework-search-aggregation-value-interface" + required: + - name + - values + framework-search-aggregation-value-interface: + type: object + description: Interface Aggregation Value + properties: + value: + type: string + description: Aggregation + metrics: + type: array + description: Metrics + items: + type: string + required: + - value + - metrics + framework-search-search-criteria-interface: + type: object + description: Interface SearchCriteriaInterface + properties: + request_name: + type: string + filter_groups: + type: array + description: A list of filter groups. + items: + "$ref": "#/definitions/framework-search-filter-group" + sort_orders: + type: array + description: Sort order. + items: + "$ref": "#/definitions/framework-sort-order" + page_size: + type: integer + description: Page size. + current_page: + type: integer + description: Current page. + required: + - request_name + - filter_groups + framework-search-filter-group: + type: object + description: Groups two or more filters together using a logical OR + properties: + filters: + type: array + description: A list of filters in this group + items: + "$ref": "#/definitions/framework-filter" + framework-filter: + type: object + description: Filter which can be used by any methods from service layer. + properties: + field: + type: string + description: Field + value: + type: string + description: Value + condition_type: + type: string + description: Condition type + required: + - field + - value + framework-sort-order: + type: object + description: Data object for sort order. + properties: + field: + type: string + description: Sorting field. + direction: + type: string + description: Sorting direction. + required: + - field + - direction + requisition-list-data-requisition-list-interface: + type: object + description: Interface RequisitionListInterface + properties: + id: + type: integer + description: Requisition List ID + customer_id: + type: integer + description: Customer ID + name: + type: string + description: Requisition List Name + updated_at: + type: string + description: Requisition List Update Time + description: + type: string + description: Requisition List Description + items: + type: array + description: Requisition List Items + items: + "$ref": "#/definitions/requisition-list-data-requisition-list-item-interface" + extension_attributes: + "$ref": "#/definitions/requisition-list-data-requisition-list-extension-interface" + required: + - id + - customer_id + - name + - updated_at + - description + - items + requisition-list-data-requisition-list-item-interface: + type: object + description: Interface RequisitionListItemInterface + properties: + id: + type: integer + description: Requisition List ID. + sku: + type: string + description: Product SKU. + requisition_list_id: + type: integer + description: Requisition List ID. + qty: + type: number + description: Product Qty. + options: + type: array + description: Requisition list item options. + items: + type: string + store_id: + type: integer + description: Store ID. + added_at: + type: string + description: Added_at value. + extension_attributes: + "$ref": "#/definitions/requisition-list-data-requisition-list-item-extension-interface" + required: + - id + - sku + - requisition_list_id + - qty + - options + - store_id + - added_at + requisition-list-data-requisition-list-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListItemInterface + requisition-list-data-requisition-list-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\RequisitionList\Api\Data\RequisitionListInterface + checkout-data-shipping-information-interface: + type: object + description: Interface ShippingInformationInterface + properties: + shipping_address: + "$ref": "#/definitions/quote-data-address-interface" + billing_address: + "$ref": "#/definitions/quote-data-address-interface" + shipping_method_code: + type: string + description: Shipping method code + shipping_carrier_code: + type: string + description: Carrier code + extension_attributes: + "$ref": "#/definitions/checkout-data-shipping-information-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + required: + - shipping_address + - shipping_method_code + - shipping_carrier_code + checkout-data-shipping-information-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\ShippingInformationInterface + checkout-data-payment-details-interface: + type: object + description: Interface PaymentDetailsInterface + properties: + payment_methods: + type: array + items: + "$ref": "#/definitions/quote-data-payment-method-interface" + totals: + "$ref": "#/definitions/quote-data-totals-interface" + extension_attributes: + "$ref": "#/definitions/checkout-data-payment-details-extension-interface" + required: + - payment_methods + - totals + checkout-data-payment-details-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\PaymentDetailsInterface + checkout-data-totals-information-interface: + type: object + description: Interface TotalsInformationInterface + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + shipping_method_code: + type: string + description: Shipping method code + shipping_carrier_code: + type: string + description: Carrier code + extension_attributes: + "$ref": "#/definitions/checkout-data-totals-information-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + required: + - address + checkout-data-totals-information-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\TotalsInformationInterface + gift-card-account-data-gift-card-account-interface: + type: object + description: Gift Card Account data + properties: + gift_cards: + type: array + description: Cards codes. + items: + type: string + gift_cards_amount: + type: number + description: Cards amount in quote currency. + base_gift_cards_amount: + type: number + description: Cards amount in base currency. + gift_cards_amount_used: + type: number + description: Cards amount used in quote currency. + base_gift_cards_amount_used: + type: number + description: Cards amount used in base currency. + extension_attributes: + "$ref": "#/definitions/gift-card-account-data-gift-card-account-extension-interface" + required: + - gift_cards_amount + - base_gift_cards_amount + - gift_cards_amount_used + - base_gift_cards_amount_used + gift-card-account-data-gift-card-account-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface + negotiable-quote-data-attachment-content-interface: + type: object + description: Attachment files content interface. + properties: + base64_encoded_data: + type: string + description: Media data (base64 encoded content). + type: + type: string + description: MIME type. + name: + type: string + description: File name. + extension_attributes: + "$ref": "#/definitions/negotiable-quote-data-attachment-content-extension-interface" + required: + - base64_encoded_data + - type + - name + negotiable-quote-data-attachment-content-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\AttachmentContentInterface + two-factor-auth-provider-interface: + type: object + description: 2FA provider interface + properties: + enabled: + type: boolean + description: True if this provider has been enabled by admin + engine: + "$ref": "#/definitions/two-factor-auth-engine-interface" + code: + type: string + description: Provider code + name: + type: string + description: Provider name + icon: + type: string + description: Icon + reset_allowed: + type: boolean + description: True if this provider configuration can be reset + configure_action: + type: string + description: Configure action + auth_action: + type: string + description: Auth action + extra_actions: + type: array + description: Allowed extra actions + items: + type: string + required: + - enabled + - engine + - code + - name + - icon + - reset_allowed + - configure_action + - auth_action + - extra_actions + two-factor-auth-engine-interface: + type: object + description: 2FA engine interface + properties: + enabled: + type: boolean + description: True if this provider has been enabled by admin + required: + - enabled + two-factor-auth-data-google-configure-interface: + type: object + description: Google configuration data interface + properties: + qr_code_base64: + type: string + description: Value for QR code base 64 + secret_code: + type: string + description: Value for secret code + extension_attributes: + "$ref": "#/definitions/two-factor-auth-data-google-configure-extension-interface" + required: + - qr_code_base64 + - secret_code + two-factor-auth-data-google-configure-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\GoogleConfigureInterface + two-factor-auth-data-authy-device-interface: + type: object + description: Authy device data interface + properties: + country: + type: string + description: The country + phone_number: + type: string + description: The phone number + method: + type: string + description: The method to authenticate with + extension_attributes: + "$ref": "#/definitions/two-factor-auth-data-authy-device-extension-interface" + required: + - country + - phone_number + - method + two-factor-auth-data-authy-device-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyDeviceInterface + two-factor-auth-data-authy-registration-prompt-response-interface: + type: object + description: Response for device registration prompt + properties: + message: + type: string + description: The message + expiration_seconds: + type: string + description: The seconds to expire + extension_attributes: + "$ref": "#/definitions/two-factor-auth-data-authy-registration-prompt-response-extension-interface" + required: + - message + - expiration_seconds + two-factor-auth-data-authy-registration-prompt-response-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseInterface + two-factor-auth-data-u2f-web-authn-request-interface: + type: object + description: Represents a WebAuthn dataset + properties: + credential_request_options_json: + type: string + description: The needed data to initiate a WebAuthn registration ceremony + extension_attributes: + "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-extension-interface" + required: + - credential_request_options_json + two-factor-auth-data-u2f-web-authn-request-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\U2fWebAuthnRequestInterface + inventory-in-store-pickup-api-data-search-result-interface: + type: object + description: Search results for providing pickup locations. + properties: + items: + type: array + description: Items list. + items: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-pickup-location-interface" + search_request: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_request + - total_count + inventory-in-store-pickup-api-data-pickup-location-interface: + type: object + description: Represents sources projection on In-Store Pickup context. Realisation + must follow immutable DTO concept. Partial immutability done according to restriction + of current Extension Attributes implementation. + properties: + pickup_location_code: + type: string + description: Source code of Pickup Location. + name: + type: string + description: Pickup Location name. + email: + type: string + description: Pickup Location contact email. + fax: + type: string + description: Fax contact info. + contact_name: + type: string + description: Pickup Location contact name. + description: + type: string + description: Pickup Location description. + latitude: + type: number + description: Pickup Location latitude. + longitude: + type: number + description: Pickup Location longitude. + country_id: + type: string + description: Pickup Location country ID. + region_id: + type: integer + description: Pickup Location region ID. + region: + type: string + description: Pickup Location region. + city: + type: string + description: Pickup Location city. + street: + type: string + description: Pickup Location street. + postcode: + type: string + description: Pickup Location postcode. + phone: + type: string + description: Pickup Location phone. + extension_attributes: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-pickup-location-extension-interface" + required: + - pickup_location_code + inventory-in-store-pickup-api-data-pickup-location-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface + inventory-in-store-pickup-api-data-search-request-interface: + type: object + description: 'Endpoint used to search Pickup Locations by different parameters: + - by attribute filters fields @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\FiltersInterface + - by distance to the address @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\AreaInterface + Also, endpoint supports paging and sort orders.' + properties: + area: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-area-interface" + filters: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filters-interface" + page_size: + type: integer + description: Page size. + current_page: + type: integer + description: Current page. + scope_type: + type: string + description: Sales Channel Type. + scope_code: + type: string + description: Sales Channel code. + sort: + type: array + description: Sort Order. + items: + "$ref": "#/definitions/framework-sort-order" + extension_attributes: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-extension-interface" + required: + - current_page + - scope_type + - scope_code + inventory-in-store-pickup-api-data-search-request-area-interface: + type: object + description: 'Filter by Distance to the Address. Pickup Locations will be filtered + by distance according to the geo-position of the entered address. Required fields + for the address are country and one of the field: region or city or postcode.' + properties: + radius: + type: integer + description: Search radius in KM. + search_term: + type: string + description: Search term string. + required: + - radius + - search_term + inventory-in-store-pickup-api-data-search-request-filters-interface: + type: object + description: Filter to filter by Fields. Each field may be filtered with different + condition type. Supported condition types restricted by @see \Magento\Framework\Api\SearchCriteriaInterface + properties: + country: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + postcode: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + region: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + region_id: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + city: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + street: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + name: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + pickup_location_code: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + inventory-in-store-pickup-api-data-search-request-filter-interface: + type: object + description: Filter for Pickup Location search. + properties: + value: + type: string + description: Value. + condition_type: + type: string + description: Condition Type. + required: + - value + - condition_type + inventory-in-store-pickup-api-data-search-request-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequestInterface + properties: + products_info: + type: array + items: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-product-info-interface" + inventory-in-store-pickup-api-data-search-request-product-info-interface: + type: object + description: Product Info Data Transfer Object. + properties: + sku: + type: string + description: Product SKU. + extension_attributes: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-product-info-extension-interface" + required: + - sku + inventory-in-store-pickup-api-data-search-request-product-info-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\ProductInfoInterface + payment-services-paypal-payment-config-response-interface: + type: object + description: '' + properties: + apple_pay: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-apple-pay-interface" + google_pay: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-interface" + hosted_fields: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-hosted-fields-interface" + smart_buttons: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-interface" + required: + - apple_pay + - google_pay + - hosted_fields + - smart_buttons + payment-services-paypal-data-payment-config-apple-pay-interface: + type: object + description: '' + properties: + button_styles: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-button-styles-interface" + payment_source: + type: string + description: PaymentSource + code: + type: string + description: Code + sdk_params: + type: array + description: SDK params + items: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" + is_visible: + type: boolean + description: Visible + sort_order: + type: string + description: Sort Order + payment_intent: + type: string + description: Payment intent + title: + type: string + description: Title + required: + - button_styles + - payment_source + - code + - sdk_params + - is_visible + - sort_order + - payment_intent + - title + payment-services-paypal-data-payment-config-button-styles-interface: + type: object + description: '' + properties: + layout: + type: string + description: Layout + color: + type: string + description: Color + shape: + type: string + description: Shape + label: + type: string + description: Label + tagline: + type: boolean + description: ShowTagline + height: + type: integer + description: Height + use_default_height: + type: boolean + description: Height + required: + - layout + - color + - shape + - label + - tagline + - height + - use_default_height + payment-services-paypal-data-payment-config-sdk-params-interface: + type: object + description: '' + properties: + name: + type: string + description: Code + value: + type: string + description: Config + required: + - name + - value + payment-services-paypal-data-payment-config-google-pay-interface: + type: object + description: '' + properties: + button_styles: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-button-styles-interface" + payment_source: + type: string + description: PaymentSource + three_d_s: + type: string + description: ThreeDS + code: + type: string + description: Code + sdk_params: + type: array + description: SDK params + items: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" + is_visible: + type: boolean + description: Visible + sort_order: + type: string + description: Sort Order + payment_intent: + type: string + description: Payment intent + title: + type: string + description: Title + required: + - button_styles + - payment_source + - three_d_s + - code + - sdk_params + - is_visible + - sort_order + - payment_intent + - title + payment-services-paypal-data-payment-config-google-pay-button-styles-interface: + type: object + description: '' + properties: + color: + type: string + description: Color + height: + type: integer + description: Height + type: + type: string + description: Type + required: + - color + - height + - type + payment-services-paypal-data-payment-config-hosted-fields-interface: + type: object + description: '' + properties: + payment_source: + type: string + description: Payment Source + three_d_s: + type: string + description: ThreeDS + is_vault_enabled: + type: boolean + description: HasIsVaultEnabled + cc_vault_code: + type: string + description: CcVaultCode + requires_card_details: + type: boolean + description: RequiresCardDetails + code: + type: string + description: Code + sdk_params: + type: array + description: SDK params + items: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" + is_visible: + type: boolean + description: Visible + sort_order: + type: string + description: Sort Order + payment_intent: + type: string + description: Payment intent + title: + type: string + description: Title + required: + - payment_source + - three_d_s + - is_vault_enabled + - cc_vault_code + - requires_card_details + - code + - sdk_params + - is_visible + - sort_order + - payment_intent + - title + payment-services-paypal-data-payment-config-smart-buttons-interface: + type: object + description: '' + properties: + display_message: + type: boolean + description: CanDisplayMessage + display_venmo: + type: boolean + description: Venmo + message_styles: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-message-styles-interface" + button_styles: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-button-styles-interface" + app_switch_when_available: + type: boolean + description: AppSwitchWhenAvailable + code: + type: string + description: Code + sdk_params: + type: array + description: SDK params + items: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" + is_visible: + type: boolean + description: Visible + sort_order: + type: string + description: Sort Order + payment_intent: + type: string + description: Payment intent + title: + type: string + description: Title + required: + - display_message + - display_venmo + - message_styles + - button_styles + - app_switch_when_available + - code + - sdk_params + - is_visible + - sort_order + - payment_intent + - title + payment-services-paypal-data-payment-config-smart-buttons-message-styles-interface: + type: object + description: '' + properties: + layout: + type: string + description: CanDisplayMessage + logo: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-logo-interface" + required: + - layout + - logo + payment-services-paypal-data-payment-config-smart-buttons-logo-interface: + type: object + description: '' + properties: + type: + type: string + description: CanDisplayMessage + required: + - type + payment-services-paypal-data-payment-order-interface: + type: object + description: Interface PaymentOrderInterface + properties: + id: + type: string + description: Payment order id + mp_order_id: + type: string + description: Payment order mpOrderId + status: + type: string + description: Payment order status + amount: + type: number + description: Payment order amount + currency_code: + type: string + description: Payment order currency code + required: + - id + - mp_order_id + - status + - amount + - currency_code + payment-services-paypal-data-payment-order-details-interface: + type: object + description: Interface PaymentOrderDetailsInterface + properties: + payment_source_details: + "$ref": "#/definitions/payment-services-paypal-data-payment-source-details-interface" + id: + type: string + description: Payment order id + mp_order_id: + type: string + description: Payment order mpOrderId + status: + type: string + description: Payment order status + amount: + type: number + description: Payment order amount + currency_code: + type: string + description: Payment order currency code + required: + - payment_source_details + - id + - mp_order_id + - status + - amount + - currency_code + payment-services-paypal-data-payment-source-details-interface: + type: object + description: '' + properties: + card: + "$ref": "#/definitions/payment-services-paypal-data-payment-card-details-interface" + required: + - card + payment-services-paypal-data-payment-card-details-interface: + type: object + description: '' + properties: + name: + type: string + description: Name + last_digits: + type: string + description: Last digits + card_expiry_month: + type: string + description: Card expiry month + card_expiry_year: + type: string + description: Card expiry year + bin_details: + "$ref": "#/definitions/payment-services-paypal-data-payment-card-bin-details-interface" + required: + - name + - last_digits + - card_expiry_month + - card_expiry_year + - bin_details + payment-services-paypal-data-payment-card-bin-details-interface: + type: object + description: '' + properties: + bin: + type: string + description: Bin + required: + - bin + payment-services-paypal-data-payment-sdk-params-interface: + type: object + description: '' + properties: + code: + type: string + description: The payments sdk code + params: + type: array + description: The payments sdk params + items: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" + required: + - code + - params + pay-pal-braintree-data-auth-data-interface: + type: object + description: Interface AuthDataInterface + properties: + client_token: + type: string + description: Client token + display_name: + type: string + description: Display name + action_success: + type: string + description: To success page + logged_in: + type: boolean + description: Logged in + store_code: + type: string + description: Current store code + required: + - display_name + - action_success + - logged_in + - store_code + pay-pal-braintree-data-payment-interface: + type: object + description: '' + properties: + payment_method_code: + type: string + description: The payment method code. + payment_method_nonce: + type: string + description: The payment method nonce. + device_data: + type: string + description: The device data. +x-tagGroups: +- name: applepay + tags: + - applepay/auth +- name: braintree + tags: + - braintree/mine/payment/vault +- name: carts + tags: + - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} + - carts/guest-carts/{cartId}/giftCards + - carts/guest-carts/{cartId}/giftCards/{giftCardCode} + - carts/mine + - carts/mine/balance/apply + - carts/mine/checkGiftCard/{giftCardCode} + - carts/mine/collect-totals + - carts/mine/payment-information + - carts/mine/payment-order + - carts/mine/payment-order/{id} + - carts/mine/po-payment-information + - carts/mine/set-payment-information +- name: customers + tags: + - customers + - customers/isEmailAvailable + - customers/me/activate + - customers/me/password + - customers/password + - customers/resetPassword + - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} +- name: directory + tags: + - directory/countries + - directory/countries/{countryId} + - directory/currency +- name: giftregistry + tags: + - giftregistry/mine/estimate-shipping-methods +- name: guest carts + tags: + - guest-carts + - guest-carts/{cartId} + - guest-carts/{cartId}/billing-address + - guest-carts/{cartId}/collect-totals + - guest-carts/{cartId}/coupons + - guest-carts/{cartId}/coupons/{couponCode} + - guest-carts/{cartId}/estimate-shipping-methods + - guest-carts/{cartId}/gift-message + - guest-carts/{cartId}/gift-message/{itemId} + - guest-carts/{cartId}/items + - guest-carts/{cartId}/items/{itemId} + - guest-carts/{cartId}/order + - guest-carts/{cartId}/payment-information + - guest-carts/{cartId}/payment-methods + - guest-carts/{cartId}/payment-order + - guest-carts/{cartId}/payment-order/{id} + - guest-carts/{cartId}/selected-payment-method + - guest-carts/{cartId}/set-payment-information + - guest-carts/{cartId}/shipping-information + - guest-carts/{cartId}/shipping-methods + - guest-carts/{cartId}/totals + - guest-carts/{cartId}/totals-information +- name: guest giftregistry + tags: + - guest-giftregistry/{cartId}/estimate-shipping-methods +- name: integration + tags: + - integration/admin/token + - integration/customer/revoke-customer-token + - integration/customer/token +- name: inventory + tags: + - inventory/in-store-pickup/pickup-locations/ +- name: negotiable carts + tags: + - negotiable-carts/{cartId}/billing-address + - negotiable-carts/{cartId}/coupons + - negotiable-carts/{cartId}/coupons/{couponCode} + - negotiable-carts/{cartId}/estimate-shipping-methods + - negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id + - negotiable-carts/{cartId}/giftCards + - negotiable-carts/{cartId}/giftCards/{giftCardCode} + - negotiable-carts/{cartId}/payment-information + - negotiable-carts/{cartId}/po-payment-information + - negotiable-carts/{cartId}/set-payment-information + - negotiable-carts/{cartId}/shipping-information + - negotiable-carts/{cartId}/totals +- name: negotiableQuoteTemplate + tags: + - negotiableQuoteTemplate/accept + - negotiableQuoteTemplate/generateQuote + - negotiableQuoteTemplate/submitToSeller +- name: payment order + tags: + - payment-order/completeOrder +- name: payments config + tags: + - payments-config/apple-pay/{location} + - payments-config/google-pay/{location} + - payments-config/hosted-fields/{location} + - payments-config/smart-buttons/{location} + - payments-config/{location} +- name: payments sdk + tags: + - payments-sdk/{location} + - payments-sdk/{location}/{methodCode} +- name: paypal + tags: + - paypal/lineItems + - paypal/oneClick + - paypal/validatePhoneNumber +- name: products render info + tags: + - products-render-info +- name: purchase order carts + tags: + - purchase-order-carts/{cartId}/payment-information + - purchase-order-carts/{cartId}/set-payment-information +- name: requisition_lists + tags: + - requisition_lists +- name: reward + tags: + - reward/mine/use-reward +- name: search + tags: + - search +- name: tfa + tags: + - tfa/provider/authy/activate + - tfa/provider/authy/authenticate + - tfa/provider/authy/authenticate-onetouch + - tfa/provider/authy/configure + - tfa/provider/authy/send-token/{via} + - tfa/provider/duo_security/activate + - tfa/provider/duo_security/authenticate + - tfa/provider/duo_security/configure + - tfa/provider/google/activate + - tfa/provider/google/authenticate + - tfa/provider/google/configure + - tfa/provider/u2fkey/activate + - tfa/provider/u2fkey/authentication-challenge + - tfa/provider/u2fkey/configure + - tfa/provider/u2fkey/verify + - tfa/tfat-providers-to-activate + - tfa/tfat-user-providers diff --git a/src/openapi/guest-schema-2.4.9-beta-1.yaml b/src/openapi/guest-schema-2.4.9-beta-1.yaml new file mode 100644 index 000000000..dc1df7e0b --- /dev/null +++ b/src/openapi/guest-schema-2.4.9-beta-1.yaml @@ -0,0 +1,6073 @@ +--- +securityDefinitions: + api_key: + type: apiKey + name: api_key + in: header +swagger: '2.0' +info: + version: 2.4.9-beta-1 + title: Commerce Guest REST endpoints - All inclusive + description: + "$ref": "../_includes/redocly-intro.md" +host: example.com +basePath: "/rest/default" +schemes: +- http +tags: +- name: applepay/auth +- name: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} +- name: carts/guest-carts/{cartId}/giftCards +- name: carts/guest-carts/{cartId}/giftCards/{giftCardCode} +- name: customers +- name: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} +- name: customers/isEmailAvailable +- name: customers/password +- name: customers/resetPassword +- name: directory/countries +- name: directory/countries/{countryId} +- name: directory/currency +- name: guest-carts +- name: guest-carts/{cartId} +- name: guest-carts/{cartId}/billing-address +- name: guest-carts/{cartId}/collect-totals +- name: guest-carts/{cartId}/coupons +- name: guest-carts/{cartId}/coupons/{couponCode} +- name: guest-carts/{cartId}/estimate-shipping-methods +- name: guest-carts/{cartId}/gift-message +- name: guest-carts/{cartId}/gift-message/{itemId} +- name: guest-carts/{cartId}/items +- name: guest-carts/{cartId}/items/{itemId} +- name: guest-carts/{cartId}/order +- name: guest-carts/{cartId}/payment-information +- name: guest-carts/{cartId}/payment-methods +- name: guest-carts/{cartId}/payment-order +- name: guest-carts/{cartId}/payment-order/{id} +- name: guest-carts/{cartId}/selected-payment-method +- name: guest-carts/{cartId}/set-payment-information +- name: guest-carts/{cartId}/shipping-information +- name: guest-carts/{cartId}/shipping-methods +- name: guest-carts/{cartId}/totals +- name: guest-carts/{cartId}/totals-information +- name: guest-giftregistry/{cartId}/estimate-shipping-methods +- name: integration/admin/token +- name: integration/customer/token +- name: inventory/in-store-pickup/pickup-locations/ +- name: payment-order/completeOrder +- name: payments-config/{location} +- name: payments-config/apple-pay/{location} +- name: payments-config/google-pay/{location} +- name: payments-config/hosted-fields/{location} +- name: payments-config/smart-buttons/{location} +- name: payments-sdk/{location} +- name: payments-sdk/{location}/{methodCode} +- name: paypal/lineItems +- name: paypal/oneClick +- name: paypal/validatePhoneNumber +- name: products-render-info +- name: search +- name: tfa/provider/authy/activate +- name: tfa/provider/authy/authenticate +- name: tfa/provider/authy/authenticate-onetouch +- name: tfa/provider/authy/configure +- name: tfa/provider/authy/send-token/{via} +- name: tfa/provider/duo_security/activate +- name: tfa/provider/duo_security/authenticate +- name: tfa/provider/duo_security/configure +- name: tfa/provider/google/activate +- name: tfa/provider/google/authenticate +- name: tfa/provider/google/configure +- name: tfa/provider/u2fkey/activate +- name: tfa/provider/u2fkey/authentication-challenge +- name: tfa/provider/u2fkey/configure +- name: tfa/provider/u2fkey/verify +- name: tfa/tfat-providers-to-activate +- name: tfa/tfat-user-providers +paths: + "/V1/applepay/auth": + get: + tags: + - applepay/auth + description: Returns details required to be able to submit a payment with Apple + Pay + operationId: GetV1ApplepayAuth + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/pay-pal-braintree-data-auth-data-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: applepay/auth + "/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}": + get: + tags: + - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} + description: Check gift card balance if added to the cart. + operationId: GetV1CartsGuestcartsCartIdCheckGiftCardGiftCardCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: giftCardCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: number + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} + "/V1/carts/guest-carts/{cartId}/giftCards": + post: + tags: + - carts/guest-carts/{cartId}/giftCards + description: Add gift card to the cart. + operationId: PostV1CartsGuestcartsCartIdGiftCards + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1CartsGuestcartsCartIdGiftCardsBody + in: body + schema: + required: + - giftCardAccountData + properties: + giftCardAccountData: + "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/guest-carts/{cartId}/giftCards + "/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}": + delete: + tags: + - carts/guest-carts/{cartId}/giftCards/{giftCardCode} + description: Remove GiftCard Account entity. + operationId: DeleteV1CartsGuestcartsCartIdGiftCardsGiftCardCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: giftCardCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: carts/guest-carts/{cartId}/giftCards/{giftCardCode} + "/V1/customers": + post: + tags: + - customers + description: Create customer account. Perform necessary business operations + like sending email. + operationId: PostV1Customers + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CustomersBody + in: body + schema: + required: + - customer + properties: + customer: + "$ref": "#/definitions/customer-data-customer-interface" + password: + type: string + redirectUrl: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/customer-data-customer-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers + "/V1/customers/isEmailAvailable": + post: + tags: + - customers/isEmailAvailable + description: Check if given email is associated with a customer account in given + website. + operationId: PostV1CustomersIsEmailAvailable + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CustomersIsEmailAvailableBody + in: body + schema: + required: + - customerEmail + properties: + customerEmail: + type: string + websiteId: + type: integer + description: If not set, will use the current websiteId + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/isEmailAvailable + "/V1/customers/password": + put: + tags: + - customers/password + description: Send an email to the customer with a password reset link. + operationId: PutV1CustomersPassword + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PutV1CustomersPasswordBody + in: body + schema: + required: + - email + - template + properties: + email: + type: string + template: + type: string + websiteId: + type: integer + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/password + "/V1/customers/resetPassword": + post: + tags: + - customers/resetPassword + description: Reset customer password. + operationId: PostV1CustomersResetPassword + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1CustomersResetPasswordBody + in: body + schema: + required: + - email + - resetToken + - newPassword + properties: + email: + type: string + description: If empty value given then the customer will be matched + by the RP token. + resetToken: + type: string + newPassword: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: true on success + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/resetPassword + "/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}": + get: + tags: + - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} + description: Check if password reset token is valid. + operationId: GetV1CustomersCustomerIdPasswordResetLinkTokenResetPasswordLinkToken + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: customerId + in: path + type: integer + required: true + description: If null is given then a customer will be matched by the RP token. + - name: resetPasswordLinkToken + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + description: True if the token is valid + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} + "/V1/directory/countries": + get: + tags: + - directory/countries + description: Get all countries and regions information for the store. + operationId: GetV1DirectoryCountries + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/directory-data-country-information-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: directory/countries + "/V1/directory/countries/{countryId}": + get: + tags: + - directory/countries/{countryId} + description: Get country and region information for the store. + operationId: GetV1DirectoryCountriesCountryId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: countryId + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/directory-data-country-information-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: directory/countries/{countryId} + "/V1/directory/currency": + get: + tags: + - directory/currency + description: Get currency information for the store. + operationId: GetV1DirectoryCurrency + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/directory-data-currency-information-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: directory/currency + "/V1/guest-carts": + post: + tags: + - guest-carts + description: Enable an customer or guest user to create an empty cart and quote + for an anonymous customer. + operationId: PostV1Guestcarts + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: string + description: Cart ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts + "/V1/guest-carts/{cartId}": + get: + tags: + - guest-carts/{cartId} + description: Enable a guest user to return information for a specified cart. + operationId: GetV1GuestcartsCartId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-cart-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId} + "/V1/guest-carts/{cartId}/billing-address": + get: + tags: + - guest-carts/{cartId}/billing-address + description: Return the billing address for a specified quote. + operationId: GetV1GuestcartsCartIdBillingaddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-address-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/billing-address + post: + tags: + - guest-carts/{cartId}/billing-address + description: Assign a specified billing address to a specified cart. + operationId: PostV1GuestcartsCartIdBillingaddress + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: PostV1GuestcartsCartIdBillingaddressBody + in: body + schema: + required: + - address + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + useForShipping: + type: boolean + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Address ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/billing-address + "/V1/guest-carts/{cartId}/collect-totals": + put: + tags: + - guest-carts/{cartId}/collect-totals + description: Set shipping/billing methods and additional data for cart and collect + totals for guest. + operationId: PutV1GuestcartsCartIdCollecttotals + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: PutV1GuestcartsCartIdCollecttotalsBody + in: body + schema: + required: + - paymentMethod + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + shippingCarrierCode: + type: string + description: The carrier code. + shippingMethodCode: + type: string + description: The shipping method code. + additionalData: + "$ref": "#/definitions/quote-data-totals-additional-data-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-totals-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/collect-totals + "/V1/guest-carts/{cartId}/coupons": + get: + tags: + - guest-carts/{cartId}/coupons + description: Return information for a coupon in a specified cart. + operationId: GetV1GuestcartsCartIdCoupons + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + type: string + description: The coupon code data. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/coupons + delete: + tags: + - guest-carts/{cartId}/coupons + description: Delete a coupon from a specified cart. + operationId: DeleteV1GuestcartsCartIdCoupons + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/coupons + "/V1/guest-carts/{cartId}/coupons/{couponCode}": + put: + tags: + - guest-carts/{cartId}/coupons/{couponCode} + description: Add a coupon by code to a specified cart. + operationId: PutV1GuestcartsCartIdCouponsCouponCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: couponCode + in: path + type: string + required: true + description: The coupon code data. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/coupons/{couponCode} + "/V1/guest-carts/{cartId}/estimate-shipping-methods": + post: + tags: + - guest-carts/{cartId}/estimate-shipping-methods + description: Estimate shipping by address and return list of available shipping + methods + operationId: PostV1GuestcartsCartIdEstimateshippingmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdEstimateshippingmethodsBody + in: body + schema: + required: + - address + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/estimate-shipping-methods + "/V1/guest-carts/{cartId}/gift-message": + get: + tags: + - guest-carts/{cartId}/gift-message + description: Return the gift message for a specified order. + operationId: GetV1GuestcartsCartIdGiftmessage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The shopping cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/gift-message-data-message-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/gift-message + post: + tags: + - guest-carts/{cartId}/gift-message + description: Set the gift message for an entire order. + operationId: PostV1GuestcartsCartIdGiftmessage + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: PostV1GuestcartsCartIdGiftmessageBody + in: body + schema: + required: + - giftMessage + properties: + giftMessage: + "$ref": "#/definitions/gift-message-data-message-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/gift-message + "/V1/guest-carts/{cartId}/gift-message/{itemId}": + get: + tags: + - guest-carts/{cartId}/gift-message/{itemId} + description: Return the gift message for a specified item in a specified shopping + cart. + operationId: GetV1GuestcartsCartIdGiftmessageItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The shopping cart ID. + - name: itemId + in: path + type: integer + required: true + description: The item ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/gift-message-data-message-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/gift-message/{itemId} + post: + tags: + - guest-carts/{cartId}/gift-message/{itemId} + description: Set the gift message for a specified item in a specified shopping + cart. + operationId: PostV1GuestcartsCartIdGiftmessageItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: itemId + in: path + type: integer + required: true + description: The item ID. + - name: PostV1GuestcartsCartIdGiftmessageItemIdBody + in: body + schema: + required: + - giftMessage + properties: + giftMessage: + "$ref": "#/definitions/gift-message-data-message-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/gift-message/{itemId} + "/V1/guest-carts/{cartId}/items": + get: + tags: + - guest-carts/{cartId}/items + description: List items that are assigned to a specified cart. + operationId: GetV1GuestcartsCartIdItems + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + type: array + description: Array of items. + items: + "$ref": "#/definitions/quote-data-cart-item-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/items + post: + tags: + - guest-carts/{cartId}/items + description: Add/update the specified cart item. + operationId: PostV1GuestcartsCartIdItems + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdItemsBody + in: body + schema: + required: + - cartItem + properties: + cartItem: + "$ref": "#/definitions/quote-data-cart-item-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-cart-item-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/items + "/V1/guest-carts/{cartId}/items/{itemId}": + put: + tags: + - guest-carts/{cartId}/items/{itemId} + description: Add/update the specified cart item. + operationId: PutV1GuestcartsCartIdItemsItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: itemId + in: path + type: string + required: true + - name: PutV1GuestcartsCartIdItemsItemIdBody + in: body + schema: + required: + - cartItem + properties: + cartItem: + "$ref": "#/definitions/quote-data-cart-item-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-cart-item-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/items/{itemId} + delete: + tags: + - guest-carts/{cartId}/items/{itemId} + description: Remove the specified item from the specified cart. + operationId: DeleteV1GuestcartsCartIdItemsItemId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: itemId + in: path + type: integer + required: true + description: The item ID of the item to be removed. + responses: + '200': + description: 200 Success. + schema: + type: boolean + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/items/{itemId} + "/V1/guest-carts/{cartId}/order": + put: + tags: + - guest-carts/{cartId}/order + description: Place an order for a specified cart. + operationId: PutV1GuestcartsCartIdOrder + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: PutV1GuestcartsCartIdOrderBody + in: body + schema: + properties: + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/order + "/V1/guest-carts/{cartId}/payment-information": + post: + tags: + - guest-carts/{cartId}/payment-information + description: Set payment information and place order for a specified cart. + operationId: PostV1GuestcartsCartIdPaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdPaymentinformationBody + in: body + schema: + required: + - email + - paymentMethod + properties: + email: + type: string + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/payment-information + get: + tags: + - guest-carts/{cartId}/payment-information + description: Get payment information + operationId: GetV1GuestcartsCartIdPaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/checkout-data-payment-details-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/payment-information + "/V1/guest-carts/{cartId}/payment-methods": + get: + tags: + - guest-carts/{cartId}/payment-methods + description: List available payment methods for a specified shopping cart. This + call returns an array of objects, but detailed information about each object’s + attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#GuestPaymentMethodManagementInterface + to determine which call to use to get detailed information about all attributes + for an object. + operationId: GetV1GuestcartsCartIdPaymentmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + type: array + description: Array of payment methods. + items: + "$ref": "#/definitions/quote-data-payment-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/payment-methods + "/V1/guest-carts/{cartId}/payment-order": + post: + tags: + - guest-carts/{cartId}/payment-order + description: Create a payment order for guest customer + operationId: PostV1GuestcartsCartIdPaymentorder + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdPaymentorderBody + in: body + schema: + required: + - methodCode + - paymentSource + - location + properties: + methodCode: + type: string + paymentSource: + type: string + location: + type: string + vaultIntent: + type: boolean + threeDSMode: + type: string + description: "| null $threeDSMode" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-order-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/payment-order + "/V1/guest-carts/{cartId}/payment-order/{id}": + get: + tags: + - guest-carts/{cartId}/payment-order/{id} + description: Get payment order for guest customer + operationId: GetV1GuestcartsCartIdPaymentorderId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: id + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-order-details-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/payment-order/{id} + post: + tags: + - guest-carts/{cartId}/payment-order/{id} + description: Sync payment order for guest customer + operationId: PostV1GuestcartsCartIdPaymentorderId + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: id + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: boolean + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/payment-order/{id} + "/V1/guest-carts/{cartId}/selected-payment-method": + get: + tags: + - guest-carts/{cartId}/selected-payment-method + description: Return the payment method for a specified shopping cart. + operationId: GetV1GuestcartsCartIdSelectedpaymentmethod + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-payment-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/selected-payment-method + put: + tags: + - guest-carts/{cartId}/selected-payment-method + description: Add a specified payment method to a specified shopping cart. + operationId: PutV1GuestcartsCartIdSelectedpaymentmethod + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + - name: PutV1GuestcartsCartIdSelectedpaymentmethodBody + in: body + schema: + required: + - method + properties: + method: + "$ref": "#/definitions/quote-data-payment-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Payment method ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/selected-payment-method + "/V1/guest-carts/{cartId}/set-payment-information": + post: + tags: + - guest-carts/{cartId}/set-payment-information + description: Set payment information for a specified cart. + operationId: PostV1GuestcartsCartIdSetpaymentinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdSetpaymentinformationBody + in: body + schema: + required: + - email + - paymentMethod + properties: + email: + type: string + paymentMethod: + "$ref": "#/definitions/quote-data-payment-interface" + billingAddress: + "$ref": "#/definitions/quote-data-address-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: integer + description: Order ID. + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/set-payment-information + "/V1/guest-carts/{cartId}/shipping-information": + post: + tags: + - guest-carts/{cartId}/shipping-information + description: '' + operationId: PostV1GuestcartsCartIdShippinginformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdShippinginformationBody + in: body + schema: + required: + - addressInformation + properties: + addressInformation: + "$ref": "#/definitions/checkout-data-shipping-information-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/checkout-data-payment-details-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/shipping-information + "/V1/guest-carts/{cartId}/shipping-methods": + get: + tags: + - guest-carts/{cartId}/shipping-methods + description: List applicable shipping methods for a specified quote. + operationId: GetV1GuestcartsCartIdShippingmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The shopping cart ID. + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods. + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/shipping-methods + "/V1/guest-carts/{cartId}/totals": + get: + tags: + - guest-carts/{cartId}/totals + description: Return quote totals data for a specified cart. + operationId: GetV1GuestcartsCartIdTotals + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The cart ID. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-totals-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/totals + "/V1/guest-carts/{cartId}/totals-information": + post: + tags: + - guest-carts/{cartId}/totals-information + description: Calculate quote totals based on address and shipping method. + operationId: PostV1GuestcartsCartIdTotalsinformation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + - name: PostV1GuestcartsCartIdTotalsinformationBody + in: body + schema: + required: + - addressInformation + properties: + addressInformation: + "$ref": "#/definitions/checkout-data-totals-information-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/quote-data-totals-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-carts/{cartId}/totals-information + "/V1/guest-giftregistry/{cartId}/estimate-shipping-methods": + post: + tags: + - guest-giftregistry/{cartId}/estimate-shipping-methods + description: Estimate shipping + operationId: PostV1GuestgiftregistryCartIdEstimateshippingmethods + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: cartId + in: path + type: string + required: true + description: The shopping cart ID. + - name: PostV1GuestgiftregistryCartIdEstimateshippingmethodsBody + in: body + schema: + required: + - registryId + properties: + registryId: + type: integer + description: The estimate registry id + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: array + description: An array of shipping methods. + items: + "$ref": "#/definitions/quote-data-shipping-method-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: guest-giftregistry/{cartId}/estimate-shipping-methods + "/V1/integration/admin/token": + post: + tags: + - integration/admin/token + description: Create access token for admin given the admin credentials. + operationId: PostV1IntegrationAdminToken + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1IntegrationAdminTokenBody + in: body + schema: + required: + - username + - password + properties: + username: + type: string + password: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + description: Token created + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: integration/admin/token + "/V1/integration/customer/token": + post: + tags: + - integration/customer/token + description: Create access token for admin given the customer credentials. + operationId: PostV1IntegrationCustomerToken + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1IntegrationCustomerTokenBody + in: body + schema: + required: + - username + - password + properties: + username: + type: string + password: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + description: Token created + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: integration/customer/token + "/V1/inventory/in-store-pickup/pickup-locations/": + get: + tags: + - inventory/in-store-pickup/pickup-locations/ + description: Get Pickup Locations according to the results of filtration by + Search Request. + operationId: GetV1InventoryInstorepickupPickuplocations + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchRequest[area][radius] + in: query + type: integer + description: Search radius in KM. + - name: searchRequest[area][searchTerm] + in: query + type: string + description: Search term string. + - name: searchRequest[filters][country][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][country][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][postcode][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][postcode][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][region][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][region][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][regionId][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][regionId][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][city][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][city][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][street][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][street][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][name][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][name][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[filters][pickupLocationCode][value] + in: query + type: string + description: Value. + - name: searchRequest[filters][pickupLocationCode][conditionType] + in: query + type: string + description: Condition Type. + - name: searchRequest[pageSize] + in: query + type: integer + description: Page size. + - name: searchRequest[currentPage] + in: query + type: integer + description: Current page. + - name: searchRequest[scopeType] + in: query + type: string + description: Sales Channel Type. + - name: searchRequest[scopeCode] + in: query + type: string + description: Sales Channel code. + - name: searchRequest[sort][0][field] + in: query + type: string + description: Sorting field. + - name: searchRequest[sort][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchRequest[extensionAttributes][productsInfo][0][sku] + in: query + type: string + description: Product SKU. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-result-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/in-store-pickup/pickup-locations/ + post: + tags: + - inventory/in-store-pickup/pickup-locations/ + description: Get Pickup Locations according to the results of filtration by + Search Request. + operationId: PostV1InventoryInstorepickupPickuplocations + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1InventoryInstorepickupPickuplocationsBody + in: body + schema: + required: + - searchRequest + properties: + searchRequest: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-result-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: inventory/in-store-pickup/pickup-locations/ + "/V1/payment-order/completeOrder": + post: + tags: + - payment-order/completeOrder + description: Rest API endpoint to place an order + operationId: PostV1PaymentorderCompleteOrder + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1PaymentorderCompleteOrderBody + in: body + schema: + required: + - orderId + properties: + orderId: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payment-order/completeOrder + "/V1/payments-config/apple-pay/{location}": + get: + tags: + - payments-config/apple-pay/{location} + description: Get Apple Pay Config. + operationId: GetV1PaymentsconfigApplepayLocation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + description: sdk location. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-apple-pay-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-config/apple-pay/{location} + "/V1/payments-config/google-pay/{location}": + get: + tags: + - payments-config/google-pay/{location} + description: Get Google Pay Config. + operationId: GetV1PaymentsconfigGooglepayLocation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + description: sdk location. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-config/google-pay/{location} + "/V1/payments-config/hosted-fields/{location}": + get: + tags: + - payments-config/hosted-fields/{location} + description: Get Hosted Fields Config. + operationId: GetV1PaymentsconfigHostedfieldsLocation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + description: sdk location. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-hosted-fields-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-config/hosted-fields/{location} + "/V1/payments-config/smart-buttons/{location}": + get: + tags: + - payments-config/smart-buttons/{location} + description: Get Smart Buttons Config. + operationId: GetV1PaymentsconfigSmartbuttonsLocation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + description: sdk location. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-config/smart-buttons/{location} + "/V1/payments-config/{location}": + get: + tags: + - payments-config/{location} + description: Get Config. + operationId: GetV1PaymentsconfigLocation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + description: sdk location. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-payment-config-response-interface" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-config/{location} + "/V1/payments-sdk/{location}": + get: + tags: + - payments-sdk/{location} + description: Get payment sdk url by location + operationId: GetV1PaymentssdkLocation + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/payment-services-paypal-data-payment-sdk-params-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-sdk/{location} + "/V1/payments-sdk/{location}/{methodCode}": + get: + tags: + - payments-sdk/{location}/{methodCode} + description: Get payment sdk url by location and methodCode + operationId: GetV1PaymentssdkLocationMethodCode + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: location + in: path + type: string + required: true + - name: methodCode + in: path + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/payment-services-paypal-data-payment-sdk-params-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: payments-sdk/{location}/{methodCode} + "/V1/paypal/lineItems": + post: + tags: + - paypal/lineItems + description: Rest endpoint to calculate totals and line items + operationId: PostV1PaypalLineItems + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1PaypalLineItemsBody + in: body + schema: + required: + - method + - cartId + properties: + method: + type: string + cartId: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: paypal/lineItems + "/V1/paypal/oneClick": + post: + tags: + - paypal/oneClick + description: Rest endpoint to add product to cart (mainly use for PayPal button + from PDP) + operationId: PostV1PaypalOneClick + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1PaypalOneClickBody + in: body + schema: + required: + - method + - productData + properties: + method: + type: string + productData: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: paypal/oneClick + "/V1/paypal/validatePhoneNumber": + post: + tags: + - paypal/validatePhoneNumber + description: Get & validate phone number and get shipping/billing email address + operationId: PostV1PaypalValidatePhoneNumber + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1PaypalValidatePhoneNumberBody + in: body + schema: + required: + - cartId + properties: + cartId: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: paypal/validatePhoneNumber + "/V1/products-render-info": + get: + tags: + - products-render-info + description: Collect and retrieve the list of product render info. This info + contains raw prices and formatted prices, product name, stock status, store_id, + etc. + operationId: GetV1Productsrenderinfo + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + - name: storeId + in: query + type: integer + required: true + - name: currencyCode + in: query + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-data-product-render-search-results-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: products-render-info + "/V1/search": + get: + tags: + - search + description: Make Full Text Search and return found Documents + operationId: GetV1Search + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: searchCriteria[requestName] + in: query + type: string + - name: searchCriteria[filterGroups][0][filters][0][field] + in: query + type: string + description: Field + - name: searchCriteria[filterGroups][0][filters][0][value] + in: query + type: string + description: Value + - name: searchCriteria[filterGroups][0][filters][0][conditionType] + in: query + type: string + description: Condition type + - name: searchCriteria[sortOrders][0][field] + in: query + type: string + description: Sorting field. + - name: searchCriteria[sortOrders][0][direction] + in: query + type: string + description: Sorting direction. + - name: searchCriteria[pageSize] + in: query + type: integer + description: Page size. + - name: searchCriteria[currentPage] + in: query + type: integer + description: Current page. + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/framework-search-search-result-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: search + "/V1/tfa/provider/authy/activate": + post: + tags: + - tfa/provider/authy/activate + description: Activate the provider and get an admin token + operationId: PostV1TfaProviderAuthyActivate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderAuthyActivateBody + in: body + schema: + required: + - tfaToken + - otp + properties: + tfaToken: + type: string + otp: + type: string + type: object + xml: + name: request + responses: + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/authy/activate + "/V1/tfa/provider/authy/authenticate": + post: + tags: + - tfa/provider/authy/authenticate + description: Get an admin token using authy 2fa + operationId: PostV1TfaProviderAuthyAuthenticate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderAuthyAuthenticateBody + in: body + schema: + required: + - username + - password + - otp + properties: + username: + type: string + password: + type: string + otp: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + description: "$otp" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/authy/authenticate + "/V1/tfa/provider/authy/authenticate-onetouch": + post: + tags: + - tfa/provider/authy/authenticate-onetouch + description: Authenticate using the present one touch response and get an admin + token + operationId: PostV1TfaProviderAuthyAuthenticateonetouch + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderAuthyAuthenticateonetouchBody + in: body + schema: + required: + - username + - password + properties: + username: + type: string + password: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/authy/authenticate-onetouch + "/V1/tfa/provider/authy/configure": + post: + tags: + - tfa/provider/authy/configure + description: Get the information required to configure google + operationId: PostV1TfaProviderAuthyConfigure + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderAuthyConfigureBody + in: body + schema: + required: + - tfaToken + - deviceData + properties: + tfaToken: + type: string + deviceData: + "$ref": "#/definitions/two-factor-auth-data-authy-device-interface" + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/two-factor-auth-data-authy-registration-prompt-response-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/authy/configure + "/V1/tfa/provider/authy/send-token/{via}": + post: + tags: + - tfa/provider/authy/send-token/{via} + description: Send a one time password to a device using authy + operationId: PostV1TfaProviderAuthySendtokenVia + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: via + in: path + type: string + required: true + - name: PostV1TfaProviderAuthySendtokenViaBody + in: body + schema: + required: + - username + - password + properties: + username: + type: string + password: + type: string + type: object + xml: + name: request + responses: + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/authy/send-token/{via} + "/V1/tfa/provider/duo_security/activate": + post: + tags: + - tfa/provider/duo_security/activate + description: Activate the provider and get an admin token + operationId: PostV1TfaProviderDuo_securityActivate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderDuo_securityActivateBody + in: body + schema: + required: + - tfaToken + properties: + tfaToken: + type: string + type: object + xml: + name: request + responses: + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/duo_security/activate + "/V1/tfa/provider/duo_security/authenticate": + post: + tags: + - tfa/provider/duo_security/authenticate + description: Authenticate and get an admin token with passcode + operationId: PostV1TfaProviderDuo_securityAuthenticate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderDuo_securityAuthenticateBody + in: body + schema: + required: + - username + - password + - passcode + properties: + username: + type: string + password: + type: string + passcode: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/duo_security/authenticate + "/V1/tfa/provider/duo_security/configure": + post: + tags: + - tfa/provider/duo_security/configure + description: Configure duo for first time user + operationId: PostV1TfaProviderDuo_securityConfigure + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderDuo_securityConfigureBody + in: body + schema: + required: + - tfaToken + properties: + tfaToken: + type: string + type: object + xml: + name: request + responses: + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/duo_security/configure + "/V1/tfa/provider/google/activate": + post: + tags: + - tfa/provider/google/activate + description: Activate the provider and get an admin token + operationId: PostV1TfaProviderGoogleActivate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderGoogleActivateBody + in: body + schema: + required: + - tfaToken + - otp + properties: + tfaToken: + type: string + otp: + type: string + type: object + xml: + name: request + responses: + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/google/activate + "/V1/tfa/provider/google/authenticate": + post: + tags: + - tfa/provider/google/authenticate + description: Get an admin token by authenticating using google + operationId: PostV1TfaProviderGoogleAuthenticate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderGoogleAuthenticateBody + in: body + schema: + required: + - username + - password + - otp + properties: + username: + type: string + password: + type: string + otp: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/google/authenticate + "/V1/tfa/provider/google/configure": + post: + tags: + - tfa/provider/google/configure + description: Get the information required to configure google + operationId: PostV1TfaProviderGoogleConfigure + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderGoogleConfigureBody + in: body + schema: + required: + - tfaToken + properties: + tfaToken: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/two-factor-auth-data-google-configure-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/google/configure + "/V1/tfa/provider/u2fkey/activate": + post: + tags: + - tfa/provider/u2fkey/activate + description: Activate the provider and get a token + operationId: PostV1TfaProviderU2fkeyActivate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderU2fkeyActivateBody + in: body + schema: + required: + - tfaToken + - publicKeyCredentialJson + properties: + tfaToken: + type: string + publicKeyCredentialJson: + type: string + type: object + xml: + name: request + responses: + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/u2fkey/activate + "/V1/tfa/provider/u2fkey/authentication-challenge": + post: + tags: + - tfa/provider/u2fkey/authentication-challenge + description: Get the information to initiate a WebAuthn registration ceremony + operationId: PostV1TfaProviderU2fkeyAuthenticationchallenge + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderU2fkeyAuthenticationchallengeBody + in: body + schema: + required: + - username + - password + properties: + username: + type: string + password: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/u2fkey/authentication-challenge + "/V1/tfa/provider/u2fkey/configure": + post: + tags: + - tfa/provider/u2fkey/configure + description: Get the information to initiate a WebAuthn registration ceremony + operationId: PostV1TfaProviderU2fkeyConfigure + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderU2fkeyConfigureBody + in: body + schema: + required: + - tfaToken + properties: + tfaToken: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/u2fkey/configure + "/V1/tfa/provider/u2fkey/verify": + post: + tags: + - tfa/provider/u2fkey/verify + description: Authenticate with the provider and get a token + operationId: PostV1TfaProviderU2fkeyVerify + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: PostV1TfaProviderU2fkeyVerifyBody + in: body + schema: + required: + - username + - password + - publicKeyCredentialJson + properties: + username: + type: string + password: + type: string + publicKeyCredentialJson: + type: string + type: object + xml: + name: request + responses: + '200': + description: 200 Success. + schema: + type: string + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/provider/u2fkey/verify + "/V1/tfa/tfat-providers-to-activate": + get: + tags: + - tfa/tfat-providers-to-activate + description: Get the providers that the user still needs to configure + operationId: GetV1TfaTfatproviderstoactivate + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: tfaToken + in: query + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/two-factor-auth-provider-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/tfat-providers-to-activate + "/V1/tfa/tfat-user-providers": + get: + tags: + - tfa/tfat-user-providers + description: Get the providers that the user is able to use for 2fa + operationId: GetV1TfaTfatuserproviders + consumes: + - application/json + - application/xml + produces: + - application/json + - application/xml + parameters: + - name: tfaToken + in: query + type: string + required: true + responses: + '200': + description: 200 Success. + schema: + type: array + items: + "$ref": "#/definitions/two-factor-auth-provider-interface" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + summary: tfa/tfat-user-providers +definitions: + error-response: + type: object + properties: + message: + type: string + description: Error message + errors: + "$ref": "#/definitions/error-errors" + code: + type: integer + description: Error code + parameters: + "$ref": "#/definitions/error-parameters" + trace: + type: string + description: Stack trace + required: + - message + error-errors: + type: array + description: Errors list + items: + "$ref": "#/definitions/error-errors-item" + error-errors-item: + type: object + description: Error details + properties: + message: + type: string + description: Error message + parameters: + "$ref": "#/definitions/error-parameters" + error-parameters: + type: array + description: Error parameters list + items: + "$ref": "#/definitions/error-parameters-item" + error-parameters-item: + type: object + description: Error parameters item + properties: + resources: + type: string + description: ACL resource + fieldName: + type: string + description: Missing or invalid field name + fieldValue: + type: string + description: Incorrect field value + directory-data-currency-information-interface: + type: object + description: Currency Information interface. + properties: + base_currency_code: + type: string + description: The base currency code for the store. + base_currency_symbol: + type: string + description: The currency symbol of the base currency for the store. + default_display_currency_code: + type: string + description: The default display currency code for the store. + default_display_currency_symbol: + type: string + description: The currency symbol of the default display currency for the store. + available_currency_codes: + type: array + description: The list of allowed currency codes for the store. + items: + type: string + exchange_rates: + type: array + description: The list of exchange rate information for the store. + items: + "$ref": "#/definitions/directory-data-exchange-rate-interface" + extension_attributes: + "$ref": "#/definitions/directory-data-currency-information-extension-interface" + required: + - base_currency_code + - base_currency_symbol + - default_display_currency_code + - default_display_currency_symbol + - available_currency_codes + - exchange_rates + directory-data-exchange-rate-interface: + type: object + description: Exchange Rate interface. + properties: + currency_to: + type: string + description: The currency code associated with the exchange rate. + rate: + type: number + description: The exchange rate for the associated currency and the store's + base currency. + extension_attributes: + "$ref": "#/definitions/directory-data-exchange-rate-extension-interface" + required: + - currency_to + - rate + directory-data-exchange-rate-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Directory\Api\Data\ExchangeRateInterface + directory-data-currency-information-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Directory\Api\Data\CurrencyInformationInterface + directory-data-country-information-interface: + type: object + description: Country Information interface. + properties: + id: + type: string + description: The country id for the store. + two_letter_abbreviation: + type: string + description: The country 2 letter abbreviation for the store. + three_letter_abbreviation: + type: string + description: The country 3 letter abbreviation for the store. + full_name_locale: + type: string + description: The country full name (in store locale) for the store. + full_name_english: + type: string + description: The country full name (in English) for the store. + available_regions: + type: array + description: The available regions for the store. + items: + "$ref": "#/definitions/directory-data-region-information-interface" + extension_attributes: + "$ref": "#/definitions/directory-data-country-information-extension-interface" + required: + - id + - two_letter_abbreviation + - three_letter_abbreviation + - full_name_locale + - full_name_english + directory-data-region-information-interface: + type: object + description: Region Information interface. + properties: + id: + type: string + description: Region id + code: + type: string + description: Region code + name: + type: string + description: Region name + extension_attributes: + "$ref": "#/definitions/directory-data-region-information-extension-interface" + required: + - id + - code + - name + directory-data-region-information-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Directory\Api\Data\RegionInformationInterface + directory-data-country-information-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Directory\Api\Data\CountryInformationInterface + customer-data-customer-interface: + type: object + description: Customer entity interface for API handling. + properties: + id: + type: integer + description: Customer id + group_id: + type: integer + description: Group id + default_billing: + type: string + description: Default billing address id + default_shipping: + type: string + description: Default shipping address id + confirmation: + type: string + description: Confirmation + created_at: + type: string + description: Created at time + updated_at: + type: string + description: Updated at time + created_in: + type: string + description: Created in area + dob: + type: string + description: In keeping with current security and privacy best practices, + be sure you are aware of any potential legal and security risks associated + with the storage of customers’ full date of birth (month, day, year) along + with other personal identifiers (e.g., full name) before collecting or processing + such data. + email: + type: string + description: Email address + firstname: + type: string + description: First name + lastname: + type: string + description: Last name + middlename: + type: string + description: Middle name + prefix: + type: string + description: Prefix + suffix: + type: string + description: Suffix + gender: + type: integer + description: Gender + store_id: + type: integer + description: Store id + taxvat: + type: string + description: Tax Vat + website_id: + type: integer + description: Website id + addresses: + type: array + description: Customer addresses. + items: + "$ref": "#/definitions/customer-data-address-interface" + disable_auto_group_change: + type: integer + description: Disable auto group change flag. + extension_attributes: + "$ref": "#/definitions/customer-data-customer-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + required: + - email + - firstname + - lastname + customer-data-address-interface: + type: object + description: Customer address interface. + properties: + id: + type: integer + description: ID + customer_id: + type: integer + description: Customer ID + region: + "$ref": "#/definitions/customer-data-region-interface" + region_id: + type: integer + description: Region ID + country_id: + type: string + description: Country code in ISO_3166-2 format + street: + type: array + description: Street + items: + type: string + company: + type: string + description: Company + telephone: + type: string + description: Telephone number + fax: + type: string + description: Fax number + postcode: + type: string + description: Postcode + city: + type: string + description: City name + firstname: + type: string + description: First name + lastname: + type: string + description: Last name + middlename: + type: string + description: Middle name + prefix: + type: string + description: Prefix + suffix: + type: string + description: Suffix + vat_id: + type: string + description: Vat id + default_shipping: + type: boolean + description: If this address is default shipping address. + default_billing: + type: boolean + description: If this address is default billing address + extension_attributes: + "$ref": "#/definitions/customer-data-address-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + customer-data-region-interface: + type: object + description: Customer address region interface. + properties: + region_code: + type: string + description: Region code + region: + type: string + description: Region + region_id: + type: integer + description: Region id + extension_attributes: + "$ref": "#/definitions/customer-data-region-extension-interface" + required: + - region_code + - region + - region_id + customer-data-region-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Customer\Api\Data\RegionInterface + customer-data-address-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Customer\Api\Data\AddressInterface + framework-attribute-interface: + type: object + description: Interface for custom attribute value. + properties: + attribute_code: + type: string + description: Attribute code + value: + type: string + description: Attribute value + required: + - attribute_code + - value + customer-data-customer-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Customer\Api\Data\CustomerInterface + properties: + company_attributes: + "$ref": "#/definitions/company-data-company-customer-interface" + all_company_attributes: + type: array + items: + "$ref": "#/definitions/company-data-company-customer-interface" + is_subscribed: + type: boolean + assistance_allowed: + type: integer + company-data-company-customer-interface: + type: object + description: Extended customer custom attributes interface. + properties: + customer_id: + type: integer + description: Customer ID. + company_id: + type: integer + description: Company ID. + job_title: + type: string + description: Job title. + status: + type: integer + description: Customer status. + telephone: + type: string + description: Telephone. + is_default: + type: boolean + description: Is default + extension_attributes: + "$ref": "#/definitions/company-data-company-customer-extension-interface" + company-data-company-customer-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyCustomerInterface + catalog-data-product-render-search-results-interface: + type: object + description: Dto that holds render information about products + properties: + items: + type: array + description: List of products rendered information + items: + "$ref": "#/definitions/catalog-data-product-render-interface" + required: + - items + catalog-data-product-render-interface: + type: object + description: Represents Data Object which holds enough information to render product + This information is put into part as Add To Cart or Add to Compare Data or Price + Data + properties: + add_to_cart_button: + "$ref": "#/definitions/catalog-data-product-render-button-interface" + add_to_compare_button: + "$ref": "#/definitions/catalog-data-product-render-button-interface" + price_info: + "$ref": "#/definitions/catalog-data-product-render-price-info-interface" + images: + type: array + description: Enough information, that needed to render image on front + items: + "$ref": "#/definitions/catalog-data-product-render-image-interface" + url: + type: string + description: Product url + id: + type: integer + description: Product identifier + name: + type: string + description: Product name + type: + type: string + description: Product type. Such as bundle, grouped, simple, etc... + is_salable: + type: string + description: Information about product saleability (In Stock) + store_id: + type: integer + description: Information about current store id or requested store id + currency_code: + type: string + description: Current or desired currency code to product + extension_attributes: + "$ref": "#/definitions/catalog-data-product-render-extension-interface" + required: + - add_to_cart_button + - add_to_compare_button + - price_info + - images + - url + - id + - name + - type + - is_salable + - store_id + - currency_code + - extension_attributes + catalog-data-product-render-button-interface: + type: object + description: 'Button interface. This interface represents all manner of product + buttons: add to cart, add to compare, etc... The buttons describes by this interface + should have interaction with backend' + properties: + post_data: + type: string + description: Post data + url: + type: string + description: Url, needed to add product to cart + required_options: + type: boolean + description: Flag whether a product has options or not + extension_attributes: + "$ref": "#/definitions/catalog-data-product-render-button-extension-interface" + required: + - post_data + - url + - required_options + catalog-data-product-render-button-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ButtonInterface + catalog-data-product-render-price-info-interface: + type: object + description: Price interface. + properties: + final_price: + type: number + description: Final price + max_price: + type: number + description: Max price of a product + max_regular_price: + type: number + description: Max regular price + minimal_regular_price: + type: number + description: Minimal regular price + special_price: + type: number + description: Special price + minimal_price: + type: number + description: Minimal price + regular_price: + type: number + description: Regular price + formatted_prices: + "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-interface" + extension_attributes: + "$ref": "#/definitions/catalog-data-product-render-price-info-extension-interface" + required: + - final_price + - max_price + - max_regular_price + - minimal_regular_price + - special_price + - minimal_price + - regular_price + - formatted_prices + catalog-data-product-render-formatted-price-info-interface: + type: object + description: 'Formatted Price interface. Aggregate formatted html with price representations. + E.g.: $9.00 Consider currency, rounding and html' + properties: + final_price: + type: string + description: Html with final price + max_price: + type: string + description: Max price of a product + minimal_price: + type: string + description: The minimal price of the product or variation + max_regular_price: + type: string + description: Max regular price + minimal_regular_price: + type: string + description: Minimal regular price + special_price: + type: string + description: Special price + regular_price: + type: string + description: Price - is price of product without discounts and special price + with taxes and fixed product tax + extension_attributes: + "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-extension-interface" + required: + - final_price + - max_price + - minimal_price + - max_regular_price + - minimal_regular_price + - special_price + - regular_price + catalog-data-product-render-formatted-price-info-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\FormattedPriceInfoInterface + catalog-data-product-render-price-info-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\PriceInfoInterface + properties: + msrp: + "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-interface" + tax_adjustments: + "$ref": "#/definitions/catalog-data-product-render-price-info-interface" + weee_attributes: + type: array + items: + "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-interface" + weee_adjustment: + type: string + msrp-data-product-render-msrp-price-info-interface: + type: object + description: Price interface. + properties: + msrp_price: + type: string + is_applicable: + type: string + is_shown_price_on_gesture: + type: string + msrp_message: + type: string + explanation_message: + type: string + extension_attributes: + "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-extension-interface" + required: + - msrp_price + - is_applicable + - is_shown_price_on_gesture + - msrp_message + - explanation_message + msrp-data-product-render-msrp-price-info-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Msrp\Api\Data\ProductRender\MsrpPriceInfoInterface + weee-data-product-render-weee-adjustment-attribute-interface: + type: object + description: List of all weee attributes, their amounts, etc.., that product has + properties: + amount: + type: string + description: Weee attribute amount + tax_amount: + type: string + description: Tax which is calculated to fixed product tax attribute + tax_amount_incl_tax: + type: string + description: Tax amount of weee attribute + amount_excl_tax: + type: string + description: Product amount exclude tax + attribute_code: + type: string + description: Weee attribute code + extension_attributes: + "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-extension-interface" + required: + - amount + - tax_amount + - tax_amount_incl_tax + - amount_excl_tax + - attribute_code + - extension_attributes + weee-data-product-render-weee-adjustment-attribute-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Weee\Api\Data\ProductRender\WeeeAdjustmentAttributeInterface + catalog-data-product-render-image-interface: + type: object + description: Product Render image interface. Represents physical characteristics + of image, that can be used in product listing or product view + properties: + url: + type: string + description: Image url + code: + type: string + description: Image code + height: + type: number + description: Image height + width: + type: number + description: Image width in px + label: + type: string + description: Image label + resized_width: + type: number + description: Resize width + resized_height: + type: number + description: Resize height + extension_attributes: + "$ref": "#/definitions/catalog-data-product-render-image-extension-interface" + required: + - url + - code + - height + - width + - label + - resized_width + - resized_height + catalog-data-product-render-image-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRender\ImageInterface + catalog-data-product-render-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\ProductRenderInterface + properties: + wishlist_button: + "$ref": "#/definitions/catalog-data-product-render-button-interface" + review_html: + type: string + quote-data-cart-interface: + type: object + description: Interface CartInterface + properties: + id: + type: integer + description: Cart/quote ID. + created_at: + type: string + description: Cart creation date and time. Otherwise, null. + updated_at: + type: string + description: Cart last update date and time. Otherwise, null. + converted_at: + type: string + description: Cart conversion date and time. Otherwise, null. + is_active: + type: boolean + description: Active status flag value. Otherwise, null. + is_virtual: + type: boolean + description: Virtual flag value. Otherwise, null. + items: + type: array + description: Array of items. Otherwise, null. + items: + "$ref": "#/definitions/quote-data-cart-item-interface" + items_count: + type: integer + description: Number of different items or products in the cart. Otherwise, + null. + items_qty: + type: number + description: Total quantity of all cart items. Otherwise, null. + customer: + "$ref": "#/definitions/customer-data-customer-interface" + billing_address: + "$ref": "#/definitions/quote-data-address-interface" + reserved_order_id: + type: string + description: Reserved order ID. Otherwise, null. + orig_order_id: + type: integer + description: Original order ID. Otherwise, null. + currency: + "$ref": "#/definitions/quote-data-currency-interface" + customer_is_guest: + type: boolean + description: For guest customers, false for logged in customers + customer_note: + type: string + description: Notice text + customer_note_notify: + type: boolean + description: Customer notification flag + customer_tax_class_id: + type: integer + description: Customer tax class ID. + store_id: + type: integer + description: Store identifier + extension_attributes: + "$ref": "#/definitions/quote-data-cart-extension-interface" + required: + - id + - customer + - store_id + quote-data-cart-item-interface: + type: object + description: Interface CartItemInterface + properties: + item_id: + type: integer + description: Item ID. Otherwise, null. + sku: + type: string + description: Product SKU. Otherwise, null. + qty: + type: number + description: Product quantity. + name: + type: string + description: Product name. Otherwise, null. + price: + type: number + description: Product price. Otherwise, null. + product_type: + type: string + description: Product type. Otherwise, null. + quote_id: + type: string + description: Quote id. + product_option: + "$ref": "#/definitions/quote-data-product-option-interface" + extension_attributes: + "$ref": "#/definitions/quote-data-cart-item-extension-interface" + required: + - qty + - quote_id + quote-data-product-option-interface: + type: object + description: Product option interface + properties: + extension_attributes: + "$ref": "#/definitions/quote-data-product-option-extension-interface" + quote-data-product-option-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ProductOptionInterface + properties: + custom_options: + type: array + items: + "$ref": "#/definitions/catalog-data-custom-option-interface" + bundle_options: + type: array + items: + "$ref": "#/definitions/bundle-data-bundle-option-interface" + downloadable_option: + "$ref": "#/definitions/downloadable-data-downloadable-option-interface" + giftcard_item_option: + "$ref": "#/definitions/gift-card-data-gift-card-option-interface" + configurable_item_options: + type: array + items: + "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-interface" + grouped_options: + type: array + items: + "$ref": "#/definitions/grouped-product-data-grouped-options-interface" + catalog-data-custom-option-interface: + type: object + description: Interface CustomOptionInterface + properties: + option_id: + type: string + description: Option id + option_value: + type: string + description: Option value + extension_attributes: + "$ref": "#/definitions/catalog-data-custom-option-extension-interface" + required: + - option_id + - option_value + catalog-data-custom-option-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Catalog\Api\Data\CustomOptionInterface + properties: + file_info: + "$ref": "#/definitions/framework-data-image-content-interface" + framework-data-image-content-interface: + type: object + description: Image Content data interface + properties: + base64_encoded_data: + type: string + description: Media data (base64 encoded content) + type: + type: string + description: MIME type + name: + type: string + description: Image name + required: + - base64_encoded_data + - type + - name + bundle-data-bundle-option-interface: + type: object + description: Interface BundleOptionInterface + properties: + option_id: + type: integer + description: Bundle option id. + option_qty: + type: integer + description: Bundle option quantity. + option_selections: + type: array + description: Bundle option selection ids. + items: + type: integer + extension_attributes: + "$ref": "#/definitions/bundle-data-bundle-option-extension-interface" + required: + - option_id + - option_qty + - option_selections + bundle-data-bundle-option-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Bundle\Api\Data\BundleOptionInterface + downloadable-data-downloadable-option-interface: + type: object + description: Downloadable Option + properties: + downloadable_links: + type: array + description: The list of downloadable links + items: + type: integer + required: + - downloadable_links + gift-card-data-gift-card-option-interface: + type: object + description: Interface GiftCardOptionInterface + properties: + giftcard_amount: + type: string + description: Gift card amount. + custom_giftcard_amount: + type: number + description: Gift card open amount value. + giftcard_sender_name: + type: string + description: Gift card sender name. + giftcard_recipient_name: + type: string + description: Gift card recipient name. + giftcard_sender_email: + type: string + description: Gift card sender email. + giftcard_recipient_email: + type: string + description: Gift card recipient email. + giftcard_message: + type: string + description: Giftcard message. + extension_attributes: + "$ref": "#/definitions/gift-card-data-gift-card-option-extension-interface" + required: + - giftcard_amount + - giftcard_sender_name + - giftcard_recipient_name + - giftcard_sender_email + - giftcard_recipient_email + gift-card-data-gift-card-option-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\GiftCard\Api\Data\GiftCardOptionInterface + properties: + giftcard_created_codes: + type: array + items: + type: string + configurable-product-data-configurable-item-option-value-interface: + type: object + description: Interface ConfigurableItemOptionValueInterface + properties: + option_id: + type: string + description: Option SKU + option_value: + type: integer + description: Item id + extension_attributes: + "$ref": "#/definitions/configurable-product-data-configurable-item-option-value-extension-interface" + required: + - option_id + configurable-product-data-configurable-item-option-value-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\ConfigurableProduct\Api\Data\ConfigurableItemOptionValueInterface + grouped-product-data-grouped-options-interface: + type: object + description: Represents `product item id with qty` of a grouped product. + properties: + id: + type: integer + description: Associated product id + qty: + type: integer + description: Associated product qty + extension_attributes: + "$ref": "#/definitions/grouped-product-data-grouped-options-extension-interface" + grouped-product-data-grouped-options-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\GroupedProduct\Api\Data\GroupedOptionsInterface + quote-data-cart-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface + properties: + discounts: + type: array + items: + "$ref": "#/definitions/sales-rule-data-rule-discount-interface" + negotiable_quote_item: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-interface" + sales-rule-data-rule-discount-interface: + type: object + description: Rule discount Interface + properties: + discount_data: + "$ref": "#/definitions/sales-rule-data-discount-data-interface" + rule_label: + type: string + description: Rule Label + rule_i_d: + type: integer + description: Rule ID + required: + - discount_data + - rule_label + - rule_i_d + sales-rule-data-discount-data-interface: + type: object + description: Discount Data Interface + properties: + amount: + type: number + description: Amount + base_amount: + type: number + description: Base Amount + original_amount: + type: number + description: Original Amount + base_original_amount: + type: number + description: Base Original Amount + required: + - amount + - base_amount + - original_amount + - base_original_amount + negotiable-quote-data-negotiable-quote-item-interface: + type: object + description: Interface CompanyQuoteConfigInterface + properties: + item_id: + type: integer + description: Quote item id + original_price: + type: number + description: Quote item original price + original_tax_amount: + type: number + description: Quote item original tax amount + original_discount_amount: + type: number + description: Quote item original discount amount + extension_attributes: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-extension-interface" + required: + - item_id + - original_price + - original_tax_amount + - original_discount_amount + negotiable-quote-data-negotiable-quote-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemInterface + properties: + negotiated_price_type: + type: integer + negotiated_price_value: + type: number + last_item_notes: + type: array + items: + "$ref": "#/definitions/negotiable-quote-data-item-note-interface" + is_discounting_locked: + type: boolean + min_qty: + type: number + max_qty: + type: number + negotiable-quote-data-item-note-interface: + type: object + description: Interface ItemNoteInterface + properties: + note_id: + type: integer + description: Note ID. + negotiable_quote_item_id: + type: integer + description: Negotiable quote item Id + creator_type: + type: integer + description: The note creator type. + creator_id: + type: integer + description: Note creator ID. + note: + type: string + description: Note. + created_at: + type: string + description: Comment created at. + extension_attributes: + "$ref": "#/definitions/negotiable-quote-data-item-note-extension-interface" + required: + - negotiable_quote_item_id + - creator_type + - creator_id + - note + negotiable-quote-data-item-note-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\ItemNoteInterface + quote-data-address-interface: + type: object + description: Interface AddressInterface + properties: + id: + type: integer + description: Id + region: + type: string + description: Region name + region_id: + type: integer + description: Region id + region_code: + type: string + description: Region code + country_id: + type: string + description: Country id + street: + type: array + description: Street + items: + type: string + company: + type: string + description: Company + telephone: + type: string + description: Telephone number + fax: + type: string + description: Fax number + postcode: + type: string + description: Postcode + city: + type: string + description: City name + firstname: + type: string + description: First name + lastname: + type: string + description: Last name + middlename: + type: string + description: Middle name + prefix: + type: string + description: Prefix + suffix: + type: string + description: Suffix + vat_id: + type: string + description: Vat id + customer_id: + type: integer + description: Customer id + email: + type: string + description: Billing/shipping email + same_as_billing: + type: integer + description: Same as billing flag + customer_address_id: + type: integer + description: Customer address id + save_in_address_book: + type: integer + description: Save in address book flag + extension_attributes: + "$ref": "#/definitions/quote-data-address-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + required: + - region + - region_id + - region_code + - country_id + - street + - telephone + - postcode + - city + - firstname + - lastname + - email + quote-data-address-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\AddressInterface + properties: + discounts: + type: array + items: + "$ref": "#/definitions/sales-rule-data-rule-discount-interface" + gift_registry_id: + type: integer + pickup_location_code: + type: string + quote-data-currency-interface: + type: object + description: Interface CurrencyInterface + properties: + global_currency_code: + type: string + description: Global currency code + base_currency_code: + type: string + description: Base currency code + store_currency_code: + type: string + description: Store currency code + quote_currency_code: + type: string + description: Quote currency code + store_to_base_rate: + type: number + description: Store currency to base currency rate + store_to_quote_rate: + type: number + description: Store currency to quote currency rate + base_to_global_rate: + type: number + description: Base currency to global currency rate + base_to_quote_rate: + type: number + description: Base currency to quote currency rate + extension_attributes: + "$ref": "#/definitions/quote-data-currency-extension-interface" + quote-data-currency-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CurrencyInterface + quote-data-cart-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartInterface + properties: + shipping_assignments: + type: array + items: + "$ref": "#/definitions/quote-data-shipping-assignment-interface" + negotiable_quote: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-interface" + company_id: + type: integer + coupon_codes: + type: array + items: + type: string + quote-data-shipping-assignment-interface: + type: object + description: Interface ShippingAssignmentInterface + properties: + shipping: + "$ref": "#/definitions/quote-data-shipping-interface" + items: + type: array + items: + "$ref": "#/definitions/quote-data-cart-item-interface" + extension_attributes: + "$ref": "#/definitions/quote-data-shipping-assignment-extension-interface" + required: + - shipping + - items + quote-data-shipping-interface: + type: object + description: Interface ShippingInterface + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + method: + type: string + description: Shipping method + extension_attributes: + "$ref": "#/definitions/quote-data-shipping-extension-interface" + required: + - address + - method + quote-data-shipping-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingInterface + quote-data-shipping-assignment-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingAssignmentInterface + negotiable-quote-data-negotiable-quote-interface: + type: object + description: Interface NegotiableQuoteInterface + properties: + quote_id: + type: integer + description: Negotiable quote ID. + is_regular_quote: + type: boolean + description: Is regular quote. + status: + type: string + description: Negotiable quote status. + negotiated_price_type: + type: integer + description: Negotiated price type. + negotiated_price_value: + type: number + description: Negotiated price value. + shipping_price: + type: number + description: Proposed shipping price. + quote_name: + type: string + description: Negotiable quote name. + expiration_period: + type: string + description: Expiration period. + email_notification_status: + type: integer + description: Email notification status. + has_unconfirmed_changes: + type: boolean + description: Has unconfirmed changes. + is_shipping_tax_changed: + type: boolean + description: Shipping tax changes. + is_customer_price_changed: + type: boolean + description: Customer price changes. + notifications: + type: integer + description: Quote notifications. + applied_rule_ids: + type: string + description: Quote rules. + is_address_draft: + type: boolean + description: Is address draft. + deleted_sku: + type: string + description: Deleted products sku. + creator_id: + type: integer + description: Quote creator id. + creator_type: + type: integer + description: Quote creator type. + original_total_price: + type: number + description: Quote original total price. + base_original_total_price: + type: number + description: Quote original total price in base currency. + negotiated_total_price: + type: number + description: Quote negotiated total price. + base_negotiated_total_price: + type: number + description: Quote negotiated total price in base currency. + extension_attributes: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-extension-interface" + required: + - quote_id + - is_regular_quote + - status + - negotiated_price_type + - negotiated_price_value + - shipping_price + - quote_name + - expiration_period + - email_notification_status + - has_unconfirmed_changes + - is_shipping_tax_changed + - is_customer_price_changed + - notifications + - applied_rule_ids + - is_address_draft + - deleted_sku + - creator_id + - creator_type + negotiable-quote-data-negotiable-quote-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteInterface + quote-data-payment-interface: + type: object + description: Interface PaymentInterface + properties: + po_number: + type: string + description: Purchase order number + method: + type: string + description: Payment method code + additional_data: + type: array + description: Payment additional details + items: + type: string + extension_attributes: + "$ref": "#/definitions/quote-data-payment-extension-interface" + required: + - method + quote-data-payment-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\PaymentInterface + properties: + agreement_ids: + type: array + items: + type: string + quote-data-shipping-method-interface: + type: object + description: Interface ShippingMethodInterface + properties: + carrier_code: + type: string + description: Shipping carrier code. + method_code: + type: string + description: Shipping method code. + carrier_title: + type: string + description: Shipping carrier title. Otherwise, null. + method_title: + type: string + description: Shipping method title. Otherwise, null. + amount: + type: number + description: Shipping amount in store currency. + base_amount: + type: number + description: Shipping amount in base currency. + available: + type: boolean + description: The value of the availability flag for the current shipping method. + extension_attributes: + "$ref": "#/definitions/quote-data-shipping-method-extension-interface" + error_message: + type: string + description: Shipping Error message. + price_excl_tax: + type: number + description: Shipping price excl tax. + price_incl_tax: + type: number + description: Shipping price incl tax. + required: + - carrier_code + - method_code + - amount + - base_amount + - available + - error_message + - price_excl_tax + - price_incl_tax + quote-data-shipping-method-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\ShippingMethodInterface + quote-data-payment-method-interface: + type: object + description: Interface PaymentMethodInterface + properties: + code: + type: string + description: Payment method code + title: + type: string + description: Payment method title + required: + - code + - title + quote-data-totals-additional-data-interface: + type: object + description: Additional data for totals collection. + properties: + extension_attributes: + "$ref": "#/definitions/quote-data-totals-additional-data-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + quote-data-totals-additional-data-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsAdditionalDataInterface + properties: + gift_messages: + type: array + items: + "$ref": "#/definitions/gift-message-data-message-interface" + gift-message-data-message-interface: + type: object + description: Interface MessageInterface + properties: + gift_message_id: + type: integer + description: Gift message ID. Otherwise, null. + customer_id: + type: integer + description: Customer ID. Otherwise, null. + sender: + type: string + description: Sender name. + recipient: + type: string + description: Recipient name. + message: + type: string + description: Message text. + extension_attributes: + "$ref": "#/definitions/gift-message-data-message-extension-interface" + required: + - sender + - recipient + - message + gift-message-data-message-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\GiftMessage\Api\Data\MessageInterface + properties: + entity_id: + type: string + entity_type: + type: string + wrapping_id: + type: integer + wrapping_allow_gift_receipt: + type: boolean + wrapping_add_printed_card: + type: boolean + quote-data-totals-interface: + type: object + description: Interface TotalsInterface + properties: + grand_total: + type: number + description: Grand total in quote currency + base_grand_total: + type: number + description: Grand total in base currency + subtotal: + type: number + description: Subtotal in quote currency + base_subtotal: + type: number + description: Subtotal in base currency + discount_amount: + type: number + description: Discount amount in quote currency + base_discount_amount: + type: number + description: Discount amount in base currency + subtotal_with_discount: + type: number + description: Subtotal in quote currency with applied discount + base_subtotal_with_discount: + type: number + description: Subtotal in base currency with applied discount + shipping_amount: + type: number + description: Shipping amount in quote currency + base_shipping_amount: + type: number + description: Shipping amount in base currency + shipping_discount_amount: + type: number + description: Shipping discount amount in quote currency + base_shipping_discount_amount: + type: number + description: Shipping discount amount in base currency + tax_amount: + type: number + description: Tax amount in quote currency + base_tax_amount: + type: number + description: Tax amount in base currency + weee_tax_applied_amount: + type: number + description: Item weee tax applied amount in quote currency. + shipping_tax_amount: + type: number + description: Shipping tax amount in quote currency + base_shipping_tax_amount: + type: number + description: Shipping tax amount in base currency + subtotal_incl_tax: + type: number + description: Subtotal including tax in quote currency + base_subtotal_incl_tax: + type: number + description: Subtotal including tax in base currency + shipping_incl_tax: + type: number + description: Shipping including tax in quote currency + base_shipping_incl_tax: + type: number + description: Shipping including tax in base currency + base_currency_code: + type: string + description: Base currency code + quote_currency_code: + type: string + description: Quote currency code + coupon_code: + type: string + description: Applied coupon code + items_qty: + type: integer + description: Items qty + items: + type: array + description: Totals by items + items: + "$ref": "#/definitions/quote-data-totals-item-interface" + total_segments: + type: array + description: Dynamically calculated totals + items: + "$ref": "#/definitions/quote-data-total-segment-interface" + extension_attributes: + "$ref": "#/definitions/quote-data-totals-extension-interface" + required: + - weee_tax_applied_amount + - total_segments + quote-data-totals-item-interface: + type: object + description: Interface TotalsItemInterface + properties: + item_id: + type: integer + description: Item id + price: + type: number + description: Item price in quote currency. + base_price: + type: number + description: Item price in base currency. + qty: + type: number + description: Item quantity. + row_total: + type: number + description: Row total in quote currency. + base_row_total: + type: number + description: Row total in base currency. + row_total_with_discount: + type: number + description: Row total with discount in quote currency. Otherwise, null. + tax_amount: + type: number + description: Tax amount in quote currency. Otherwise, null. + base_tax_amount: + type: number + description: Tax amount in base currency. Otherwise, null. + tax_percent: + type: number + description: Tax percent. Otherwise, null. + discount_amount: + type: number + description: Discount amount in quote currency. Otherwise, null. + base_discount_amount: + type: number + description: Discount amount in base currency. Otherwise, null. + discount_percent: + type: number + description: Discount percent. Otherwise, null. + price_incl_tax: + type: number + description: Price including tax in quote currency. Otherwise, null. + base_price_incl_tax: + type: number + description: Price including tax in base currency. Otherwise, null. + row_total_incl_tax: + type: number + description: Row total including tax in quote currency. Otherwise, null. + base_row_total_incl_tax: + type: number + description: Row total including tax in base currency. Otherwise, null. + options: + type: string + description: Item price in quote currency. + weee_tax_applied_amount: + type: number + description: Item weee tax applied amount in quote currency. + weee_tax_applied: + type: string + description: Item weee tax applied in quote currency. + extension_attributes: + "$ref": "#/definitions/quote-data-totals-item-extension-interface" + name: + type: string + description: Product name. Otherwise, null. + required: + - item_id + - price + - base_price + - qty + - row_total + - base_row_total + - options + - weee_tax_applied_amount + - weee_tax_applied + quote-data-totals-item-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsItemInterface + properties: + negotiable_quote_item_totals: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-interface" + negotiable-quote-data-negotiable-quote-item-totals-interface: + type: object + description: Extension attribute for quote item totals model. + properties: + cost: + type: number + description: Cost for quote item. + catalog_price: + type: number + description: Catalog price for quote item. + base_catalog_price: + type: number + description: Catalog price for quote item in base currency. + catalog_price_incl_tax: + type: number + description: Catalog price with included tax for quote item. + base_catalog_price_incl_tax: + type: number + description: Catalog price with included tax for quote item in base currency. + cart_price: + type: number + description: Cart price for quote item. + base_cart_price: + type: number + description: Cart price for quote item in base currency. + cart_tax: + type: number + description: Tax from catalog price for quote item. + base_cart_tax: + type: number + description: Tax from catalog price for quote item in base currency. + cart_price_incl_tax: + type: number + description: Cart price with included tax for quote item. + base_cart_price_incl_tax: + type: number + description: Cart price with included tax for quote item in base currency. + extension_attributes: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-extension-interface" + required: + - cost + - catalog_price + - base_catalog_price + - catalog_price_incl_tax + - base_catalog_price_incl_tax + - cart_price + - base_cart_price + - cart_tax + - base_cart_tax + - cart_price_incl_tax + - base_cart_price_incl_tax + negotiable-quote-data-negotiable-quote-item-totals-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\NegotiableQuote\Api\Data\NegotiableQuoteItemTotalsInterface + quote-data-total-segment-interface: + type: object + description: Interface TotalsInterface + properties: + code: + type: string + description: Code + title: + type: string + description: Total title + value: + type: number + description: Total value + area: + type: string + description: Display area code. + extension_attributes: + "$ref": "#/definitions/quote-data-total-segment-extension-interface" + required: + - code + - value + quote-data-total-segment-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalSegmentInterface + properties: + tax_grandtotal_details: + type: array + items: + "$ref": "#/definitions/tax-data-grand-total-details-interface" + gift_cards: + type: string + gw_order_id: + type: string + gw_item_ids: + type: array + items: + type: string + gw_allow_gift_receipt: + type: string + gw_add_card: + type: string + gw_price: + type: string + gw_base_price: + type: string + gw_items_price: + type: string + gw_items_base_price: + type: string + gw_card_price: + type: string + gw_card_base_price: + type: string + gw_base_tax_amount: + type: string + gw_tax_amount: + type: string + gw_items_base_tax_amount: + type: string + gw_items_tax_amount: + type: string + gw_card_base_tax_amount: + type: string + gw_card_tax_amount: + type: string + gw_price_incl_tax: + type: string + gw_base_price_incl_tax: + type: string + gw_card_price_incl_tax: + type: string + gw_card_base_price_incl_tax: + type: string + gw_items_price_incl_tax: + type: string + gw_items_base_price_incl_tax: + type: string + tax-data-grand-total-details-interface: + type: object + description: Interface GrandTotalDetailsInterface + properties: + amount: + type: number + description: Tax amount value + rates: + type: array + description: Tax rates info + items: + "$ref": "#/definitions/tax-data-grand-total-rates-interface" + group_id: + type: integer + description: Group identifier + required: + - amount + - rates + - group_id + tax-data-grand-total-rates-interface: + type: object + description: Interface GrandTotalRatesInterface + properties: + percent: + type: string + description: Tax percentage value + title: + type: string + description: Rate title + required: + - percent + - title + quote-data-totals-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Quote\Api\Data\TotalsInterface + properties: + coupon_label: + type: string + negotiable_quote_totals: + "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-totals-interface" + base_customer_balance_amount: + type: number + customer_balance_amount: + type: number + coupon_codes: + type: array + items: + type: string + coupons_labels: + type: array + items: + type: string + reward_points_balance: + type: number + reward_currency_amount: + type: number + base_reward_currency_amount: + type: number + negotiable-quote-data-negotiable-quote-totals-interface: + type: object + description: Extension attribute for quote totals model. + properties: + items_count: + type: integer + description: The number of different items or products in the cart. + quote_status: + type: string + description: Negotiable quote status. + created_at: + type: string + description: The cart creation date and time. + updated_at: + type: string + description: The cart last update date and time. + customer_group: + type: integer + description: Customer group id. + base_to_quote_rate: + type: number + description: Base currency to quote currency rate. + cost_total: + type: number + description: Total cost for quote. + base_cost_total: + type: number + description: Total cost for quote in base currency. + original_total: + type: number + description: Original quote total. + base_original_total: + type: number + description: Original quote total in base currency. + original_tax: + type: number + description: Original tax amount for quote. + base_original_tax: + type: number + description: Original tax amount for quote in base currency. + original_price_incl_tax: + type: number + description: Original price with included tax for quote. + base_original_price_incl_tax: + type: number + description: Original price with included tax for quote in base currency. + negotiated_price_type: + type: integer + description: Negotiable quote type. + negotiated_price_value: + type: number + description: Negotiable price value for quote. + required: + - items_count + - quote_status + - created_at + - updated_at + - customer_group + - base_to_quote_rate + - cost_total + - base_cost_total + - original_total + - base_original_total + - original_tax + - base_original_tax + - original_price_incl_tax + - base_original_price_incl_tax + - negotiated_price_type + - negotiated_price_value + framework-search-search-result-interface: + type: object + description: Interface SearchResultInterface + properties: + items: + type: array + items: + "$ref": "#/definitions/framework-search-document-interface" + aggregations: + "$ref": "#/definitions/framework-search-aggregation-interface" + search_criteria: + "$ref": "#/definitions/framework-search-search-criteria-interface" + total_count: + type: integer + description: Total count. + required: + - items + - aggregations + - search_criteria + - total_count + framework-search-document-interface: + type: object + description: Interface Search Document + properties: + id: + type: integer + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + required: + - id + framework-search-aggregation-interface: + type: object + description: Interface Aggregation to get faceted data + properties: + buckets: + type: array + description: All Document fields + items: + "$ref": "#/definitions/framework-search-bucket-interface" + bucket_names: + type: array + description: Document field names + items: + type: string + required: + - buckets + - bucket_names + framework-search-bucket-interface: + type: object + description: Interface for facet Bucket + properties: + name: + type: string + description: Field name + values: + type: array + description: Field values + items: + "$ref": "#/definitions/framework-search-aggregation-value-interface" + required: + - name + - values + framework-search-aggregation-value-interface: + type: object + description: Interface Aggregation Value + properties: + value: + type: string + description: Aggregation + metrics: + type: array + description: Metrics + items: + type: string + required: + - value + - metrics + framework-search-search-criteria-interface: + type: object + description: Interface SearchCriteriaInterface + properties: + request_name: + type: string + filter_groups: + type: array + description: A list of filter groups. + items: + "$ref": "#/definitions/framework-search-filter-group" + sort_orders: + type: array + description: Sort order. + items: + "$ref": "#/definitions/framework-sort-order" + page_size: + type: integer + description: Page size. + current_page: + type: integer + description: Current page. + required: + - request_name + - filter_groups + framework-search-filter-group: + type: object + description: Groups two or more filters together using a logical OR + properties: + filters: + type: array + description: A list of filters in this group + items: + "$ref": "#/definitions/framework-filter" + framework-filter: + type: object + description: Filter which can be used by any methods from service layer. + properties: + field: + type: string + description: Field + value: + type: string + description: Value + condition_type: + type: string + description: Condition type + required: + - field + - value + framework-sort-order: + type: object + description: Data object for sort order. + properties: + field: + type: string + description: Sorting field. + direction: + type: string + description: Sorting direction. + required: + - field + - direction + checkout-data-shipping-information-interface: + type: object + description: Interface ShippingInformationInterface + properties: + shipping_address: + "$ref": "#/definitions/quote-data-address-interface" + billing_address: + "$ref": "#/definitions/quote-data-address-interface" + shipping_method_code: + type: string + description: Shipping method code + shipping_carrier_code: + type: string + description: Carrier code + extension_attributes: + "$ref": "#/definitions/checkout-data-shipping-information-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + required: + - shipping_address + - shipping_method_code + - shipping_carrier_code + checkout-data-shipping-information-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\ShippingInformationInterface + checkout-data-payment-details-interface: + type: object + description: Interface PaymentDetailsInterface + properties: + payment_methods: + type: array + items: + "$ref": "#/definitions/quote-data-payment-method-interface" + totals: + "$ref": "#/definitions/quote-data-totals-interface" + extension_attributes: + "$ref": "#/definitions/checkout-data-payment-details-extension-interface" + required: + - payment_methods + - totals + checkout-data-payment-details-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\PaymentDetailsInterface + checkout-data-totals-information-interface: + type: object + description: Interface TotalsInformationInterface + properties: + address: + "$ref": "#/definitions/quote-data-address-interface" + shipping_method_code: + type: string + description: Shipping method code + shipping_carrier_code: + type: string + description: Carrier code + extension_attributes: + "$ref": "#/definitions/checkout-data-totals-information-extension-interface" + custom_attributes: + type: array + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + required: + - address + checkout-data-totals-information-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\Checkout\Api\Data\TotalsInformationInterface + two-factor-auth-provider-interface: + type: object + description: 2FA provider interface + properties: + enabled: + type: boolean + description: True if this provider has been enabled by admin + engine: + "$ref": "#/definitions/two-factor-auth-engine-interface" + code: + type: string + description: Provider code + name: + type: string + description: Provider name + icon: + type: string + description: Icon + reset_allowed: + type: boolean + description: True if this provider configuration can be reset + configure_action: + type: string + description: Configure action + auth_action: + type: string + description: Auth action + extra_actions: + type: array + description: Allowed extra actions + items: + type: string + required: + - enabled + - engine + - code + - name + - icon + - reset_allowed + - configure_action + - auth_action + - extra_actions + two-factor-auth-engine-interface: + type: object + description: 2FA engine interface + properties: + enabled: + type: boolean + description: True if this provider has been enabled by admin + required: + - enabled + two-factor-auth-data-google-configure-interface: + type: object + description: Google configuration data interface + properties: + qr_code_base64: + type: string + description: Value for QR code base 64 + secret_code: + type: string + description: Value for secret code + extension_attributes: + "$ref": "#/definitions/two-factor-auth-data-google-configure-extension-interface" + required: + - qr_code_base64 + - secret_code + two-factor-auth-data-google-configure-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\GoogleConfigureInterface + two-factor-auth-data-authy-device-interface: + type: object + description: Authy device data interface + properties: + country: + type: string + description: The country + phone_number: + type: string + description: The phone number + method: + type: string + description: The method to authenticate with + extension_attributes: + "$ref": "#/definitions/two-factor-auth-data-authy-device-extension-interface" + required: + - country + - phone_number + - method + two-factor-auth-data-authy-device-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyDeviceInterface + two-factor-auth-data-authy-registration-prompt-response-interface: + type: object + description: Response for device registration prompt + properties: + message: + type: string + description: The message + expiration_seconds: + type: string + description: The seconds to expire + extension_attributes: + "$ref": "#/definitions/two-factor-auth-data-authy-registration-prompt-response-extension-interface" + required: + - message + - expiration_seconds + two-factor-auth-data-authy-registration-prompt-response-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\AuthyRegistrationPromptResponseInterface + two-factor-auth-data-u2f-web-authn-request-interface: + type: object + description: Represents a WebAuthn dataset + properties: + credential_request_options_json: + type: string + description: The needed data to initiate a WebAuthn registration ceremony + extension_attributes: + "$ref": "#/definitions/two-factor-auth-data-u2f-web-authn-request-extension-interface" + required: + - credential_request_options_json + two-factor-auth-data-u2f-web-authn-request-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\TwoFactorAuth\Api\Data\U2fWebAuthnRequestInterface + gift-card-account-data-gift-card-account-interface: + type: object + description: Gift Card Account data + properties: + gift_cards: + type: array + description: Cards codes. + items: + type: string + gift_cards_amount: + type: number + description: Cards amount in quote currency. + base_gift_cards_amount: + type: number + description: Cards amount in base currency. + gift_cards_amount_used: + type: number + description: Cards amount used in quote currency. + base_gift_cards_amount_used: + type: number + description: Cards amount used in base currency. + extension_attributes: + "$ref": "#/definitions/gift-card-account-data-gift-card-account-extension-interface" + required: + - gift_cards_amount + - base_gift_cards_amount + - gift_cards_amount_used + - base_gift_cards_amount_used + gift-card-account-data-gift-card-account-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\GiftCardAccount\Api\Data\GiftCardAccountInterface + inventory-in-store-pickup-api-data-search-result-interface: + type: object + description: Search results for providing pickup locations. + properties: + items: + type: array + description: Items list. + items: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-pickup-location-interface" + search_request: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-interface" + total_count: + type: integer + description: Total count. + required: + - items + - search_request + - total_count + inventory-in-store-pickup-api-data-pickup-location-interface: + type: object + description: Represents sources projection on In-Store Pickup context. Realisation + must follow immutable DTO concept. Partial immutability done according to restriction + of current Extension Attributes implementation. + properties: + pickup_location_code: + type: string + description: Source code of Pickup Location. + name: + type: string + description: Pickup Location name. + email: + type: string + description: Pickup Location contact email. + fax: + type: string + description: Fax contact info. + contact_name: + type: string + description: Pickup Location contact name. + description: + type: string + description: Pickup Location description. + latitude: + type: number + description: Pickup Location latitude. + longitude: + type: number + description: Pickup Location longitude. + country_id: + type: string + description: Pickup Location country ID. + region_id: + type: integer + description: Pickup Location region ID. + region: + type: string + description: Pickup Location region. + city: + type: string + description: Pickup Location city. + street: + type: string + description: Pickup Location street. + postcode: + type: string + description: Pickup Location postcode. + phone: + type: string + description: Pickup Location phone. + extension_attributes: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-pickup-location-extension-interface" + required: + - pickup_location_code + inventory-in-store-pickup-api-data-pickup-location-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\PickupLocationInterface + inventory-in-store-pickup-api-data-search-request-interface: + type: object + description: 'Endpoint used to search Pickup Locations by different parameters: + - by attribute filters fields @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\FiltersInterface + - by distance to the address @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\AreaInterface + Also, endpoint supports paging and sort orders.' + properties: + area: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-area-interface" + filters: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filters-interface" + page_size: + type: integer + description: Page size. + current_page: + type: integer + description: Current page. + scope_type: + type: string + description: Sales Channel Type. + scope_code: + type: string + description: Sales Channel code. + sort: + type: array + description: Sort Order. + items: + "$ref": "#/definitions/framework-sort-order" + extension_attributes: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-extension-interface" + required: + - current_page + - scope_type + - scope_code + inventory-in-store-pickup-api-data-search-request-area-interface: + type: object + description: 'Filter by Distance to the Address. Pickup Locations will be filtered + by distance according to the geo-position of the entered address. Required fields + for the address are country and one of the field: region or city or postcode.' + properties: + radius: + type: integer + description: Search radius in KM. + search_term: + type: string + description: Search term string. + required: + - radius + - search_term + inventory-in-store-pickup-api-data-search-request-filters-interface: + type: object + description: Filter to filter by Fields. Each field may be filtered with different + condition type. Supported condition types restricted by @see \Magento\Framework\Api\SearchCriteriaInterface + properties: + country: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + postcode: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + region: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + region_id: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + city: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + street: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + name: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + pickup_location_code: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-filter-interface" + inventory-in-store-pickup-api-data-search-request-filter-interface: + type: object + description: Filter for Pickup Location search. + properties: + value: + type: string + description: Value. + condition_type: + type: string + description: Condition Type. + required: + - value + - condition_type + inventory-in-store-pickup-api-data-search-request-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequestInterface + properties: + products_info: + type: array + items: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-product-info-interface" + inventory-in-store-pickup-api-data-search-request-product-info-interface: + type: object + description: Product Info Data Transfer Object. + properties: + sku: + type: string + description: Product SKU. + extension_attributes: + "$ref": "#/definitions/inventory-in-store-pickup-api-data-search-request-product-info-extension-interface" + required: + - sku + inventory-in-store-pickup-api-data-search-request-product-info-extension-interface: + type: object + description: ExtensionInterface class for @see \Magento\InventoryInStorePickupApi\Api\Data\SearchRequest\ProductInfoInterface + payment-services-paypal-payment-config-response-interface: + type: object + description: '' + properties: + apple_pay: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-apple-pay-interface" + google_pay: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-interface" + hosted_fields: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-hosted-fields-interface" + smart_buttons: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-interface" + required: + - apple_pay + - google_pay + - hosted_fields + - smart_buttons + payment-services-paypal-data-payment-config-apple-pay-interface: + type: object + description: '' + properties: + button_styles: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-button-styles-interface" + payment_source: + type: string + description: PaymentSource + code: + type: string + description: Code + sdk_params: + type: array + description: SDK params + items: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" + is_visible: + type: boolean + description: Visible + sort_order: + type: string + description: Sort Order + payment_intent: + type: string + description: Payment intent + title: + type: string + description: Title + required: + - button_styles + - payment_source + - code + - sdk_params + - is_visible + - sort_order + - payment_intent + - title + payment-services-paypal-data-payment-config-button-styles-interface: + type: object + description: '' + properties: + layout: + type: string + description: Layout + color: + type: string + description: Color + shape: + type: string + description: Shape + label: + type: string + description: Label + tagline: + type: boolean + description: ShowTagline + height: + type: integer + description: Height + use_default_height: + type: boolean + description: Height + required: + - layout + - color + - shape + - label + - tagline + - height + - use_default_height + payment-services-paypal-data-payment-config-sdk-params-interface: + type: object + description: '' + properties: + name: + type: string + description: Code + value: + type: string + description: Config + required: + - name + - value + payment-services-paypal-data-payment-config-google-pay-interface: + type: object + description: '' + properties: + button_styles: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-google-pay-button-styles-interface" + payment_source: + type: string + description: PaymentSource + three_d_s: + type: string + description: ThreeDS + code: + type: string + description: Code + sdk_params: + type: array + description: SDK params + items: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" + is_visible: + type: boolean + description: Visible + sort_order: + type: string + description: Sort Order + payment_intent: + type: string + description: Payment intent + title: + type: string + description: Title + required: + - button_styles + - payment_source + - three_d_s + - code + - sdk_params + - is_visible + - sort_order + - payment_intent + - title + payment-services-paypal-data-payment-config-google-pay-button-styles-interface: + type: object + description: '' + properties: + color: + type: string + description: Color + height: + type: integer + description: Height + type: + type: string + description: Type + required: + - color + - height + - type + payment-services-paypal-data-payment-config-hosted-fields-interface: + type: object + description: '' + properties: + payment_source: + type: string + description: Payment Source + three_d_s: + type: string + description: ThreeDS + is_vault_enabled: + type: boolean + description: HasIsVaultEnabled + cc_vault_code: + type: string + description: CcVaultCode + requires_card_details: + type: boolean + description: RequiresCardDetails + code: + type: string + description: Code + sdk_params: + type: array + description: SDK params + items: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" + is_visible: + type: boolean + description: Visible + sort_order: + type: string + description: Sort Order + payment_intent: + type: string + description: Payment intent + title: + type: string + description: Title + required: + - payment_source + - three_d_s + - is_vault_enabled + - cc_vault_code + - requires_card_details + - code + - sdk_params + - is_visible + - sort_order + - payment_intent + - title + payment-services-paypal-data-payment-config-smart-buttons-interface: + type: object + description: '' + properties: + display_message: + type: boolean + description: CanDisplayMessage + display_venmo: + type: boolean + description: Venmo + message_styles: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-message-styles-interface" + button_styles: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-button-styles-interface" + app_switch_when_available: + type: boolean + description: AppSwitchWhenAvailable + code: + type: string + description: Code + sdk_params: + type: array + description: SDK params + items: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" + is_visible: + type: boolean + description: Visible + sort_order: + type: string + description: Sort Order + payment_intent: + type: string + description: Payment intent + title: + type: string + description: Title + required: + - display_message + - display_venmo + - message_styles + - button_styles + - app_switch_when_available + - code + - sdk_params + - is_visible + - sort_order + - payment_intent + - title + payment-services-paypal-data-payment-config-smart-buttons-message-styles-interface: + type: object + description: '' + properties: + layout: + type: string + description: CanDisplayMessage + logo: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-smart-buttons-logo-interface" + required: + - layout + - logo + payment-services-paypal-data-payment-config-smart-buttons-logo-interface: + type: object + description: '' + properties: + type: + type: string + description: CanDisplayMessage + required: + - type + payment-services-paypal-data-payment-order-interface: + type: object + description: Interface PaymentOrderInterface + properties: + id: + type: string + description: Payment order id + mp_order_id: + type: string + description: Payment order mpOrderId + status: + type: string + description: Payment order status + amount: + type: number + description: Payment order amount + currency_code: + type: string + description: Payment order currency code + required: + - id + - mp_order_id + - status + - amount + - currency_code + payment-services-paypal-data-payment-order-details-interface: + type: object + description: Interface PaymentOrderDetailsInterface + properties: + payment_source_details: + "$ref": "#/definitions/payment-services-paypal-data-payment-source-details-interface" + id: + type: string + description: Payment order id + mp_order_id: + type: string + description: Payment order mpOrderId + status: + type: string + description: Payment order status + amount: + type: number + description: Payment order amount + currency_code: + type: string + description: Payment order currency code + required: + - payment_source_details + - id + - mp_order_id + - status + - amount + - currency_code + payment-services-paypal-data-payment-source-details-interface: + type: object + description: '' + properties: + card: + "$ref": "#/definitions/payment-services-paypal-data-payment-card-details-interface" + required: + - card + payment-services-paypal-data-payment-card-details-interface: + type: object + description: '' + properties: + name: + type: string + description: Name + last_digits: + type: string + description: Last digits + card_expiry_month: + type: string + description: Card expiry month + card_expiry_year: + type: string + description: Card expiry year + bin_details: + "$ref": "#/definitions/payment-services-paypal-data-payment-card-bin-details-interface" + required: + - name + - last_digits + - card_expiry_month + - card_expiry_year + - bin_details + payment-services-paypal-data-payment-card-bin-details-interface: + type: object + description: '' + properties: + bin: + type: string + description: Bin + required: + - bin + payment-services-paypal-data-payment-sdk-params-interface: + type: object + description: '' + properties: + code: + type: string + description: The payments sdk code + params: + type: array + description: The payments sdk params + items: + "$ref": "#/definitions/payment-services-paypal-data-payment-config-sdk-params-interface" + required: + - code + - params + pay-pal-braintree-data-auth-data-interface: + type: object + description: Interface AuthDataInterface + properties: + client_token: + type: string + description: Client token + display_name: + type: string + description: Display name + action_success: + type: string + description: To success page + logged_in: + type: boolean + description: Logged in + store_code: + type: string + description: Current store code + required: + - display_name + - action_success + - logged_in + - store_code +x-tagGroups: +- name: applepay + tags: + - applepay/auth +- name: carts + tags: + - carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode} + - carts/guest-carts/{cartId}/giftCards + - carts/guest-carts/{cartId}/giftCards/{giftCardCode} +- name: customers + tags: + - customers + - customers/isEmailAvailable + - customers/password + - customers/resetPassword + - customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken} +- name: directory + tags: + - directory/countries + - directory/countries/{countryId} + - directory/currency +- name: guest carts + tags: + - guest-carts + - guest-carts/{cartId} + - guest-carts/{cartId}/billing-address + - guest-carts/{cartId}/collect-totals + - guest-carts/{cartId}/coupons + - guest-carts/{cartId}/coupons/{couponCode} + - guest-carts/{cartId}/estimate-shipping-methods + - guest-carts/{cartId}/gift-message + - guest-carts/{cartId}/gift-message/{itemId} + - guest-carts/{cartId}/items + - guest-carts/{cartId}/items/{itemId} + - guest-carts/{cartId}/order + - guest-carts/{cartId}/payment-information + - guest-carts/{cartId}/payment-methods + - guest-carts/{cartId}/payment-order + - guest-carts/{cartId}/payment-order/{id} + - guest-carts/{cartId}/selected-payment-method + - guest-carts/{cartId}/set-payment-information + - guest-carts/{cartId}/shipping-information + - guest-carts/{cartId}/shipping-methods + - guest-carts/{cartId}/totals + - guest-carts/{cartId}/totals-information +- name: guest giftregistry + tags: + - guest-giftregistry/{cartId}/estimate-shipping-methods +- name: integration + tags: + - integration/admin/token + - integration/customer/token +- name: inventory + tags: + - inventory/in-store-pickup/pickup-locations/ +- name: payment order + tags: + - payment-order/completeOrder +- name: payments config + tags: + - payments-config/apple-pay/{location} + - payments-config/google-pay/{location} + - payments-config/hosted-fields/{location} + - payments-config/smart-buttons/{location} + - payments-config/{location} +- name: payments sdk + tags: + - payments-sdk/{location} + - payments-sdk/{location}/{methodCode} +- name: paypal + tags: + - paypal/lineItems + - paypal/oneClick + - paypal/validatePhoneNumber +- name: products render info + tags: + - products-render-info +- name: search + tags: + - search +- name: tfa + tags: + - tfa/provider/authy/activate + - tfa/provider/authy/authenticate + - tfa/provider/authy/authenticate-onetouch + - tfa/provider/authy/configure + - tfa/provider/authy/send-token/{via} + - tfa/provider/duo_security/activate + - tfa/provider/duo_security/authenticate + - tfa/provider/duo_security/configure + - tfa/provider/google/activate + - tfa/provider/google/authenticate + - tfa/provider/google/configure + - tfa/provider/u2fkey/activate + - tfa/provider/u2fkey/authentication-challenge + - tfa/provider/u2fkey/configure + - tfa/provider/u2fkey/verify + - tfa/tfat-providers-to-activate + - tfa/tfat-user-providers diff --git a/src/pages/_images/123.png b/src/pages/_images/123.png index 7382d8a67..086eb9905 100644 Binary files a/src/pages/_images/123.png and b/src/pages/_images/123.png differ diff --git a/src/pages/_images/api-frontend-new-image.png b/src/pages/_images/api-frontend-new-image.png index 557f55a39..da4f80f3a 100644 Binary files a/src/pages/_images/api-frontend-new-image.png and b/src/pages/_images/api-frontend-new-image.png differ diff --git a/src/pages/_images/api-new-image.png b/src/pages/_images/api-new-image.png index d515d9df5..0951adf1c 100644 Binary files a/src/pages/_images/api-new-image.png and b/src/pages/_images/api-new-image.png differ diff --git a/src/pages/_images/api-security-rate-limiting.png b/src/pages/_images/api-security-rate-limiting.png index 860cce075..614dbe055 100644 Binary files a/src/pages/_images/api-security-rate-limiting.png and b/src/pages/_images/api-security-rate-limiting.png differ diff --git a/src/pages/_images/delete-image-frontend.png b/src/pages/_images/delete-image-frontend.png index 83af145ad..4a868851b 100644 Binary files a/src/pages/_images/delete-image-frontend.png and b/src/pages/_images/delete-image-frontend.png differ diff --git a/src/pages/_images/graphql/payment-services-pdp-cartinactive.svg b/src/pages/_images/graphql/payment-services-pdp-cartinactive.svg new file mode 100644 index 000000000..f172735ab --- /dev/null +++ b/src/pages/_images/graphql/payment-services-pdp-cartinactive.svg @@ -0,0 +1,4 @@ + + + +

Commerce returns available payment configuration.

Commerce returns available paym...
2
2

Client integration

Client integration

Adobe Commerce

Adobe Commerce

PayPal

PayPal

Run getPaymentConfig.

Run getPaymentConfig.
1
1

Commerce returns an object Cart.

Commerce returns an object Cart.
4
4

Run addProductsToNewCart.

Run addProductsToNewCart.
3
3

Commerce returns a Success:True.

Commerce returns a Success:True.
6
6

Run setCartAsInactive.

Run setCartAsInactive.
5
5Text is not SVG - cannot display \ No newline at end of file diff --git a/src/pages/_images/graphql/payment-services-pdp.svg b/src/pages/_images/graphql/payment-services-pdp.svg new file mode 100644 index 000000000..c970d547e --- /dev/null +++ b/src/pages/_images/graphql/payment-services-pdp.svg @@ -0,0 +1,4 @@ + + + +

Commerce returns available payment configuration.

Commerce returns available paym...
2
2

Client integration

Client integration

Adobe Commerce

Adobe Commerce

PayPal

PayPal

Run getPaymentConfig.

Run getPaymentConfig.
1
1

Commerce returns a Cart ID.

Commerce returns a Cart ID.
6
6

Run addProductsToNewCart.

Run addProductsToNewCart.
5
5
4
4

Commerce returns a cart object.

Commerce returns a cart object.
11
11

Run placeOrder.

Run placeOrder.

Commerce sends an authorization request to PayPal.

Commerce sends an authorizat...
12
12

Run setPaymentMethodonCart to assign payment methods for the order.

Run setPaymentMethodonCart to as...
3
3

Commerce forwards request to PayPal.

Commerce forwards request...

Run createPaymentOrder.

Run createPaymentOrder.
7
7

PayPal returns an id value.

PayPal returns an id value.
9
9

Commerce sends id and mp_order_id values.

Commerce sends id and mp_order...
10
10
8
8

PayPal returns results to Commerce.

PayPal returns results to Co...
13
13

Commerce creates an order.

Commerce creates an order.
14
14Text is not SVG - cannot display \ No newline at end of file diff --git a/src/pages/_images/layers.png b/src/pages/_images/layers.png index 8e7b449e7..e9826259a 100644 Binary files a/src/pages/_images/layers.png and b/src/pages/_images/layers.png differ diff --git a/src/pages/_images/list-product-images.png b/src/pages/_images/list-product-images.png index 068e870e8..990236387 100644 Binary files a/src/pages/_images/list-product-images.png and b/src/pages/_images/list-product-images.png differ diff --git a/src/pages/_images/search-desktop-computer.png b/src/pages/_images/search-desktop-computer.png index 744e13a8f..91a225d00 100644 Binary files a/src/pages/_images/search-desktop-computer.png and b/src/pages/_images/search-desktop-computer.png differ diff --git a/src/pages/_images/shopping-cart-desktop-computer.png b/src/pages/_images/shopping-cart-desktop-computer.png index 894409379..67bf577df 100644 Binary files a/src/pages/_images/shopping-cart-desktop-computer.png and b/src/pages/_images/shopping-cart-desktop-computer.png differ diff --git a/src/pages/_images/simple-products-admin-grid.png b/src/pages/_images/simple-products-admin-grid.png index 2079a6146..dc2d712ea 100644 Binary files a/src/pages/_images/simple-products-admin-grid.png and b/src/pages/_images/simple-products-admin-grid.png differ diff --git a/src/pages/_images/site-desktop-computer.png b/src/pages/_images/site-desktop-computer.png index 6d3aae7af..effb52f00 100644 Binary files a/src/pages/_images/site-desktop-computer.png and b/src/pages/_images/site-desktop-computer.png differ diff --git a/src/pages/_images/update-image-frontend.png b/src/pages/_images/update-image-frontend.png index ca64f4626..9825c988a 100644 Binary files a/src/pages/_images/update-image-frontend.png and b/src/pages/_images/update-image-frontend.png differ diff --git a/src/pages/_images/update-new-image.png b/src/pages/_images/update-new-image.png index a84f3c2ec..d3d75b516 100644 Binary files a/src/pages/_images/update-new-image.png and b/src/pages/_images/update-new-image.png differ diff --git a/src/pages/_images/upload-file.png b/src/pages/_images/upload-file.png new file mode 100644 index 000000000..9df9a2063 Binary files /dev/null and b/src/pages/_images/upload-file.png differ diff --git a/src/pages/_images/upload-file.svg b/src/pages/_images/upload-file.svg new file mode 100644 index 000000000..6f738103f --- /dev/null +++ b/src/pages/_images/upload-file.svg @@ -0,0 +1,3 @@ + + +
Client
Client
Adobe Commerce
Adobe Commerce
S3 Temporary Storage
S3 Temporary Storage
S3 Permanent Storage
S3 Permanent StorageInitiate an uploadReturn S3 upload URL and moreSend file to S3 temporary storageFinish the upload processSend tenant ID and keyCopy file to permanent storage using credentialsReturn responseSend acknowledgementCreate object with uploaded file
2
2
3
3
1
1
4
4
5
5
6
6
7
7
8
8
9
9 \ No newline at end of file diff --git a/src/pages/_images/viewtable.png b/src/pages/_images/viewtable.png index 6b73c4d7d..a77ab9d95 100644 Binary files a/src/pages/_images/viewtable.png and b/src/pages/_images/viewtable.png differ diff --git a/src/pages/_images/workflow.png b/src/pages/_images/workflow.png index 2524d3f14..236def226 100644 Binary files a/src/pages/_images/workflow.png and b/src/pages/_images/workflow.png differ diff --git a/src/pages/graphql/payment-services-extension/mutations/add-products-new-cart.md b/src/pages/graphql/payment-services-extension/mutations/add-products-new-cart.md new file mode 100644 index 000000000..ee29df0d4 --- /dev/null +++ b/src/pages/graphql/payment-services-extension/mutations/add-products-new-cart.md @@ -0,0 +1,127 @@ +--- +title: addProductsToNewCart mutation +description: This mutation creates a new cart in Payment Services, supporting guest and logged-in customers in the Product Details Page (PDP). +--- + +# addProductsToNewCart mutation + + + +This mutation is available only if you have installed [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.12.0 or higher. + +The `addProductsToNewCart` mutation always creates a new cart for the shopper then adds the specified products to that cart. This contrasts with the `addProductsToCart` mutation, which requires you to specify an existing cart ID as input. + +For a logged-in customer, the customer token is passed in the [Authorization header](../../usage/authorization-tokens.md#customer-tokens). + +## Use case: smart button on the Product Details Page (PDP) + +1. When a shopper clicks a smartbutton on the Product Details Page (PDP), the `addProductsToNewCart` mutation creates a new cart and adds the items, then returns a `cart` object, which includes the `cart ID` field. + +1. It is recommended to use the [`setCartAsInactive`](set-cart-inactive.md) mutation after the `addProductsToNewCart` mutation is successful, in case of an error during the payment process, or the shopper cancelling the payment process in the PDP, to avoid having multiple active carts for logged-in customers. + +1. If the shopper clicks the smartbutton again, `addProductsToNewCart` mutation runs once more to return a new `cart` object. + +## Syntax + +```graphql +mutation { +addProductsToNewCart( + cartItems: [CartItemInput!]! + ): AddProductsToNewCartOutput +} +``` + +## Reference + +The [`addProductsToNewCart`](https://developer.adobe.com/commerce/webapi/graphql-api/saas/index.html#mutation-addProductsToNewCart) reference provides detailed information about the types and fields defined in this mutation. + +## Example usage + +These examples show when the `addProductsToNewCart` mutation returns a successful, or error message, when creating a new cart in the PDP. + +### Create a new cart (success) + +The following example adds a simple product to a new cart successfully, returning a [Cart](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-Cart) object. + +**Request:** + +```graphql +mutation { + addProductsToNewCart( + cartItems: [ + { + quantity: 1 + sku: "24-MB04" + } + ] + ) { + cart { + id + } + user_errors { + code + message + } + } +} +``` + +**Response:** + +```json +{ + "data": { + "addProductsToNewCart": { + "cart": { + "id": "848QJWDI9WJr0LrIz3n6lRdJQkoGRGYf" + }, + "user_errors": null + } + } +} +``` + +### Create a new cart (failure) + +The following example fails to create a new cart beccause the `sku` does not exist in the catalog. It returns a [CartUserInputError](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-CartUserInputError) object. + +**Request:** + +```graphql +mutation { + addProductsToNewCart( + cartItems: [ + { + quantity: 1 + sku: "24-MB0ee4" + } + ] + ) { + cart { + id + } + user_errors { + code + message + } + } +} +``` + +**Response:** + +```json +{ + "data": { + "addProductsToNewCart": { + "cart": null, + "user_errors": [ + { + "code": "PRODUCT_NOT_FOUND", + "message": "Could not find a product with SKU \"24-MB0ee4\"" + } + ] + } + } +} +``` diff --git a/src/pages/graphql/payment-services-extension/mutations/complete-order.md b/src/pages/graphql/payment-services-extension/mutations/complete-order.md new file mode 100644 index 000000000..b49066bbe --- /dev/null +++ b/src/pages/graphql/payment-services-extension/mutations/complete-order.md @@ -0,0 +1,123 @@ +--- +title: completeOrder mutation +description: This mutation synchronizes order details before you run the `placeOrder` mutation. +--- + +# completeOrder mutation + + + +This mutation is available only if you have installed [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.12.0 or higher. + +The `completeOrder` mutation synchronizes order details before you run the `placeOrder` mutation. + +When the mutation runs, Commerce generates and returns a token in the `orderV2.token` field. You can supply the token value to the [`guestOrderByToken` query](../../schema/orders/queries/guest-order-by-token.md) to retrieve details about an order created by a guest shopper. + +## Preconditions + +Before you run the `completeOrder` mutation, ensure that: + +1. A cart has been created (guest or logged-in customer). +1. Products have been added to the cart. +1. Billing and shipping addresses have been set, if applicable. +1. A shipping method has been selected (for physical products). +1. A payment or checkout ID has been generated and is available. +1. For guest carts, a valid email address has been assigned. + +## Limitations + +- The `completeOrder` mutation is similar to the [`placeOrder`](../../schema/cart/mutations/place-order.md) mutation, but includes an additional required field `id` to capture the payment identifier. +- On success, the mutation returns the `orderV2` object containing the `number` and `token` fields. +- The `token` field allows guest users to retrieve their order using queries such as `guestOrderByToken`. + +## Syntax + +```graphql +mutation { + completeOrder( + input: CompleteOrderInput + ) { + CompleteOrderOutput + } +} +``` + +## Example usage + +**Request:** + +```graphql +mutation { + completeOrder(input: { + cartId: "AJCY8dhIfuch9LcDHAxEkw7oG3DjGdKt" + id: "88455624KT013492F" + }) { + orderV2 { + number + token + } + errors { + message + code + } + } +} +``` + +**Response:** + +```json +{ + "data": { + "completeOrder": { + "orderV2": { + "number": "0000000012", + "token": "0:3:OSScWU6PKLn3kFyMhNWyskG0opgVvFBnJmtuaFHKGwDFT83S6Kv9U39iYwixuU+vhwDz2AF4pCs3GtLhHbQ=" + }, + "errors": [] + } + } +} +``` + +## Input attributes + +### CompleteOrderInput + +| Field | Type | Description | +|-------|------|--------------| +| `cartId` | String! | The unique identifier of the shopping cart (quote). | +| `id` | String! | The payment, checkout, or transaction identifier tied to the order. | + +## Output attributes + +### CompleteOrderOutput + +| Field | Type | Description | +|-------|------|--------------| +| `errors` | Error! | List of error objects. The array is empty if there are no errors. | +| `orderV2` | OrderV2 | Contains minimal order details if successful. | + +### OrderV2 object + +| Field | Type | Description | +|-------|------|--------------| +| `number` | String | The order number assigned by the system. | +| `token` | String | A token that can be used to retrieve the order, especially for guest checkouts. | + +### Error object + +| Field | Type | Description | +|-------|------|--------------| +| `code` | String | A machine-readable error code. | +| `message` | String | A human-readable message describing the error. | + +#### Possible error codes + +| Code | Description | +|------|--------------| +| `CART_NOT_FOUND` | The provided cart ID does not exist. | +| `CART_NOT_ACTIVE` | The cart is not active (already converted or expired). | +| `GUEST_EMAIL_MISSING` | A guest cart does not have an email address assigned. | +| `PAYMENT_ID_INVALID` | The provided payment or transaction ID is invalid. | +| `UNABLE_TO_COMPLETE_ORDER` | A general error occurred while finalizing the order (for example, missing information or out-of-stock items). | diff --git a/src/pages/graphql/payment-services-extension/mutations/index.md b/src/pages/graphql/payment-services-extension/mutations/index.md index ec8aabfd6..d2ff46e36 100644 --- a/src/pages/graphql/payment-services-extension/mutations/index.md +++ b/src/pages/graphql/payment-services-extension/mutations/index.md @@ -21,3 +21,11 @@ If you have installed [Payment Services for Adobe Commerce](https://commercemark * [`createVaultCardSetupToken`](../mutations/create-vault-card-setup-token.md) * [`createVaultCardPaymentToken`](../mutations/create-vault-card-payment-token.md) + +If you have installed [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.12.0 or higher, you can use the following mutations to manage your carts in the Product Details Page (PDP): + +* [`addProductsToNewCart`](../mutations/add-products-new-cart.md) + +* [`setCartAsInactive`](../mutations/set-cart-inactive.md) + +* [`completeOrtder`](../mutations/complete-order.md) diff --git a/src/pages/graphql/payment-services-extension/mutations/set-cart-inactive.md b/src/pages/graphql/payment-services-extension/mutations/set-cart-inactive.md new file mode 100644 index 000000000..6499a8caf --- /dev/null +++ b/src/pages/graphql/payment-services-extension/mutations/set-cart-inactive.md @@ -0,0 +1,79 @@ +--- +title: setCartAsInactive mutation +description: This mutation marks a cart as inactive in Payment Services, helping prevent multiple active carts for logged-in customers during specific payment flows. +--- + +# setCartAsInactive mutation + + + +This mutation is available only if you have installed [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.12.0 or higher. + +The `setCartAsInactive` mutation sets a specific `cartId` as inactive. Use this mutation when a payment error occurs, or when a shopper cancels a payment flow, after the [`addProductsToNewCart`](add-products-new-cart.md) mutation returns a `cartId`. This mutation helps prevent a customer having multiple active carts created with the [`addProductsToNewCart`](add-products-new-cart.md) mutation. + +See the [`addProductsToNewCart` mutation use case](add-products-new-cart.md#use-case-smart-button-on-the-product-details-page-pdp) for more information about a common workflow for the `setCartAsInactive` mutation. + +## Syntax + +```graphql +mutation { + setCartAsInactive( + cartId: String! + ): SetCartAsInactiveOutput + } +``` + +## Reference + +The [`setCartAsInactive`](https://developer.adobe.com/commerce/webapi/graphql-api/saas/index.html#mutation-setCartAsInactive) reference provides detailed information about the types and fields defined in this mutation. + +## Example usage + +The following examples show responses to the `setCartAsInactive` mutation. + +**Request:** + +```graphql +mutation { + setCartAsInactive( + cartId: "gVFVNBSJPt7L6uCQis4Q1ryj6DQtcwM2" + ) { + success + error + } + } +``` + +### Set cart as inactive (success) + +The following response example shows what the mutation returns when `setCartAsInactive` is successful, and no error. + +**Response:** + +```json +{ + "data": { + "setCartAsInactive": { + "success": true, + "error": null + } + } +} +``` + +### Set cart as inactive (failure) + +The following example response indicates the mutation failed due to a non-existent `cartId`. + +**Response:** + +```json +{ + "data": { + "setCartAsInactive": { + "success": false, + "error": "Error when setting the cart gVFVNBSJPt7L6uCQis4Q1ryj6QtcwM2 as inactive - No such entity with cartId = null " + } + } +} +``` diff --git a/src/pages/graphql/payment-services-extension/workflows/cart-pdp.md b/src/pages/graphql/payment-services-extension/workflows/cart-pdp.md new file mode 100644 index 000000000..40c9040fb --- /dev/null +++ b/src/pages/graphql/payment-services-extension/workflows/cart-pdp.md @@ -0,0 +1,67 @@ +--- +title: Add product to a new cart on a Product Details Page +description: Learn how Adobe Commerce uses GraphQL to create a new cart in the Product Details Page with smart buttons (Apple Pay). +keywords: + - GraphQL + - Payments +--- + +# Create a new cart in the Product Details Page workflows + + + +This workflow is available only with Apple Pay if you have installed [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.12.0 or higher. + +These steps describe the flow of requests and responses with the [Payment Services](https://experienceleague.adobe.com/docs/commerce-merchant-services/payment-services/guide-overview.html) solution enabled for guests and logged-in customers. This workflow is required to [create a new cart](../mutations/add-products-new-cart.md) in the Product Details Page (PDP) with smart buttons. + +## Add product to a new cart in a PDP workflow + +These steps describe the use case when a shopper adds a product to the cart on a PDP. + +![Payment Services sequence diagram](../../../_images/graphql/payment-services-pdp.svg) + +1. Run the [`getPaymentConfig`](../../payment-services-extension/queries/get-payment-config.md) query to fetch the payment configuration needed to render details about PayPal components, such as hosted fields, smart buttons, and Apple Pay. + +1. Adobe Commerce returns payment configuration information. + +1. Run [`addProductsToNewCart`](../../payment-services-extension/mutations/add-products-new-cart.md) to create a new cart and add the item. + +1. Commerce returns a `cart` object, which includes the cart `id` field. + +1. Run [`createPaymentOrder`](../../payment-services-extension/mutations/create-payment-order.md) to begin the authorization process. + +1. Commerce forwards the request to PayPal. + + If there is an error during the payment process, or the shopper cancels the payment process on the PDP, run [`setCartAsInactive`](../../payment-services-extension/mutations/set-cart-inactive.md) to set the corresponding `cartId` as inactive and to avoid having multiple active carts for logged-in customers. + +1. PayPal returns an `id` value. + +1. Adobe Commerce generates a `order_id` and forwards the value in the `mp_order_id` field and the PayPal response in the `id` field. + +1. Run the [`placeOrder`](../../schema/cart/mutations/place-order.md) mutation. + +1. Commerce sends an authorization request to PayPal. + +1. PayPal returns the result to Commerce. + +1. Commerce creates an order. + +## Payment cancellation while on a PDP workflow + +These steps describe the use case when a shopper cancels the payment process on the PDP. + +![Payment Services sequence diagram](../../../_images/graphql/payment-services-pdp-cartinactive.svg) + +1. Run the [`getPaymentConfig`](../../payment-services-extension/queries/get-payment-config.md) query to fetch the payment configuration needed to render details about PayPal components, such as hosted fields, smart buttons, and Apple Pay. + +1. Adobe Commerce returns payment configuration information. + +1. Run [`addProductsToNewCart`](../../payment-services-extension/mutations/add-products-new-cart.md) to create a new cart and add the item. + +1. Commerce returns a `cart` object, which includes the cart `id` field. + +1. Run [`setCartAsInactive`](../../payment-services-extension/mutations/set-cart-inactive.md) to set a specific `cartId` as inactive. + +1. Commerce returns a confirmation that a specific `cartId` is inactive. + +1. If the shopper clicks the smart button again, `addProductsToNewCart` mutation runs once more to return a new `cart` object. diff --git a/src/pages/graphql/payment-services-extension/workflows/index.md b/src/pages/graphql/payment-services-extension/workflows/index.md index 55c9cdada..043e1c5a2 100644 --- a/src/pages/graphql/payment-services-extension/workflows/index.md +++ b/src/pages/graphql/payment-services-extension/workflows/index.md @@ -17,3 +17,7 @@ If you have installed [Payment Services for Adobe Commerce](https://commercemark * [Minicart](../workflows/minicart.md)---This workflow describes the additional flow of requests and responses required to place an order after adding a product to your cart with the Payment Services extension enabled. * [Checkout using a vaulted card](../workflows/vaulted-card.md)---This workflow describes a checkout authorization using a vaulted card. + +If you have installed [Payment Services for Adobe Commerce](https://commercemarketplace.adobe.com/magento-payment-services.html) 2.12.0 or higher, check the following workflows: + +* [Smart buttons in the Product Details Page (PDP)](../workflows/cart-pdp.md)---This workflow describes the flow of requests and responses, in Payment Services for guests and logged-in customers, required to create a new cart in the Product Details Page (PDP) with smart buttons. diff --git a/src/pages/graphql/reference/index.md b/src/pages/graphql/reference/index.md index fdc96c743..86691b1e9 100644 --- a/src/pages/graphql/reference/index.md +++ b/src/pages/graphql/reference/index.md @@ -12,6 +12,7 @@ The Adobe Commerce and Magento Open Source GraphQL API provides a flexible, powe See the following page for the full reference documentation for the Adobe Commerce and Magento Open Source GraphQL API schema: * ​[GraphQL API reference](../../reference/graphql/saas/) +* ​[2.4.9-beta-1 GraphQL API reference](../../reference/graphql/2.4.9-beta-1/) * ​[2.4.8 GraphQL API reference](../../reference/graphql/2.4.8/) * ​[2.4.7 GraphQL API reference](../../reference/graphql/2.4.7/) * ​[2.4.6 GraphQL API reference](../../reference/graphql/2.4.6/) diff --git a/src/pages/graphql/schema/attributes/interfaces/index.md b/src/pages/graphql/schema/attributes/interfaces/index.md index 0cb4be9c9..44e70eaaa 100644 --- a/src/pages/graphql/schema/attributes/interfaces/index.md +++ b/src/pages/graphql/schema/attributes/interfaces/index.md @@ -4,6 +4,7 @@ title: Attribute Interfaces and Implementations import CustomAttributeCustomer from '/src/_includes/graphql/examples/custom-attribute-customer.md' import CustomAttributeFilterProduct from '/src/_includes/graphql/examples/custom-attribute-filter-product.md' +import CustomerS3Download from '/src/_includes/graphql/examples/customer-s3-download.md' # Attribute interfaces and implementations @@ -12,10 +13,14 @@ Adobe Commerce provides the following interfaces to access system attributes and Interface | Implementations --- | --- [`AttributeSelectedOptionInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-AttributeSelectedOptionInterface) | [`AttributeSelectedOption`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-AttributeSelectedOption) -[`AttributeValueInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-AttributeValueInterface) | [`AttributeValue`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-AttributeValue)
[`AttributeSelectedOptions`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-AttributeSelectedOptions) +[`AttributeValueInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-AttributeValueInterface) | [`AttributeValue`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-AttributeValue)
[`AttributeSelectedOptions`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-AttributeSelectedOptions)
`AttributeFile` (SaaS only)
`AttributeImage` (SaaS only) [`CustomAttributeMetadataInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-CustomerAttributeMetadata) | [`AttributeMetadata`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-AttributeMetadata) [`CustomAttributeOptionInterface`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-CustomAttributeOptionInterface) | [`AttributeOptionMetadata`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-AttributeOptionMetadata). + + +Adobe Commerce as a Cloud Service (SaaS) provides two additional implementations of the `AttributeValueInterface` interface (`AttributeFile` and `AttributeImage`) to handle files and images uploaded to Amazon S3. If you are migrating from Adobe Commerce on Cloud Infrastructure or on-premise, these changes represent a backward incompatible change. If your project uses custom attributes for files or images, you must update your code to use the new implementations. + ## Example usage ### Retrieve custom attributes metadata from a customer @@ -25,3 +30,9 @@ Interface | Implementations ### Filter `custom_attributesV2` of a product < CustomAttributeFilterProduct /> + +### Retrieve a file uploaded to Amazon S3 + + + +< CustomerS3Download /> diff --git a/src/pages/graphql/schema/attributes/mutations/set-custom-cart-item.md b/src/pages/graphql/schema/attributes/mutations/set-custom-cart-item.md index cf41e88e9..1a6427e7a 100644 --- a/src/pages/graphql/schema/attributes/mutations/set-custom-cart-item.md +++ b/src/pages/graphql/schema/attributes/mutations/set-custom-cart-item.md @@ -28,7 +28,7 @@ mutation { ## Reference -The [`setCustomAttributesOnCartItem`](https://developer.adobe.com/commerce/services/graphql/reference/saas-api/index.html#mutation-setCustomAttributesOnCartItem) reference provides detailed information about the types and fields defined in this mutation. +The [`setCustomAttributesOnCartItem`](/graphql-api/saas/index.html#mutation-setCustomAttributesOnCartItem) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/attributes/mutations/set-custom-cart.md b/src/pages/graphql/schema/attributes/mutations/set-custom-cart.md index 35f40fee0..b35e1f08b 100644 --- a/src/pages/graphql/schema/attributes/mutations/set-custom-cart.md +++ b/src/pages/graphql/schema/attributes/mutations/set-custom-cart.md @@ -28,7 +28,7 @@ mutation { ## Reference -The [`setCustomAttributesOnCart`](https://developer.adobe.com/commerce/services/graphql/reference/saas-api/index.html#mutation-setCustomAttributesOnCart) reference provides detailed information about the types and fields defined in this mutation. +The [`setCustomAttributesOnCart`](https://developer.adobe.com/commerce/webapi/graphql-api/saas/index.html#mutation-setCustomAttributesOnCart) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/attributes/mutations/set-custom-company.md b/src/pages/graphql/schema/attributes/mutations/set-custom-company.md index 169a8e234..89c618256 100644 --- a/src/pages/graphql/schema/attributes/mutations/set-custom-company.md +++ b/src/pages/graphql/schema/attributes/mutations/set-custom-company.md @@ -27,7 +27,7 @@ mutation { ## Reference -The [`setCustomAttributesOnCompany`](https://developer.adobe.com/commerce/services/graphql/reference/saas-api/index.html#mutation-setCustomAttributesOnCompany) reference provides detailed information about the types and fields defined in this mutation. +The [`setCustomAttributesOnCompany`](https://developer.adobe.com/commerce/webapi/graphql-api/saas/index.html#mutation-setCustomAttributesOnCompany) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/attributes/mutations/set-custom-credit-memo-item.md b/src/pages/graphql/schema/attributes/mutations/set-custom-credit-memo-item.md index 7ca48327a..74dc4a955 100644 --- a/src/pages/graphql/schema/attributes/mutations/set-custom-credit-memo-item.md +++ b/src/pages/graphql/schema/attributes/mutations/set-custom-credit-memo-item.md @@ -26,7 +26,7 @@ mutation { ## Reference -The [`setCustomAttributesOnCreditMemoItem`](https://developer.adobe.com/commerce/services/graphql/reference/saas-api/index.html#mutation-setCustomAttributesOnCreditMemoItem) reference provides detailed information about the types and fields defined in this mutation. +The [`setCustomAttributesOnCreditMemoItem`](https://developer.adobe.com/commerce/webapi/graphql-api/saas/index.html#mutation-setCustomAttributesOnCreditMemoItem) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/attributes/mutations/set-custom-credit-memo.md b/src/pages/graphql/schema/attributes/mutations/set-custom-credit-memo.md index 5d4c8c214..17c5014b8 100644 --- a/src/pages/graphql/schema/attributes/mutations/set-custom-credit-memo.md +++ b/src/pages/graphql/schema/attributes/mutations/set-custom-credit-memo.md @@ -26,7 +26,7 @@ mutation { ## Reference -The [`setCustomAttributesOnCreditMemo`](https://developer.adobe.com/commerce/services/graphql/reference/saas-api/index.html#mutation-setCustomAttributesOnCreditMemo) reference provides detailed information about the types and fields defined in this mutation. +The [`setCustomAttributesOnCreditMemo`](https://developer.adobe.com/commerce/webapi/graphql-api/saas/index.html#mutation-setCustomAttributesOnCreditMemo) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/attributes/mutations/set-custom-invoice-item.md b/src/pages/graphql/schema/attributes/mutations/set-custom-invoice-item.md index 9d78eb3dd..3ba2c600e 100644 --- a/src/pages/graphql/schema/attributes/mutations/set-custom-invoice-item.md +++ b/src/pages/graphql/schema/attributes/mutations/set-custom-invoice-item.md @@ -26,7 +26,7 @@ mutation { ## Reference -The [`setCustomAttributesOnInvoiceItem`](https://developer.adobe.com/commerce/services/graphql/reference/saas-api/index.html#mutation-setCustomAttributesOnInvoiceItem) reference provides detailed information about the types and fields defined in this mutation. +The [`setCustomAttributesOnInvoiceItem`](https://developer.adobe.com/commerce/webapi/graphql-api/saas/index.html#mutation-setCustomAttributesOnInvoiceItem) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/attributes/mutations/set-custom-invoice.md b/src/pages/graphql/schema/attributes/mutations/set-custom-invoice.md index 97ef50370..44ea1ca26 100644 --- a/src/pages/graphql/schema/attributes/mutations/set-custom-invoice.md +++ b/src/pages/graphql/schema/attributes/mutations/set-custom-invoice.md @@ -26,7 +26,7 @@ mutation { ## Reference -The [`setCustomAttributesOnInvoice`](https://developer.adobe.com/commerce/services/graphql/reference/saas-api/index.html#mutation-setCustomAttributesOnInvoice) reference provides detailed information about the types and fields defined in this mutation. +The [`setCustomAttributesOnInvoice`](https://developer.adobe.com/commerce/webapi/graphql-api/saas/index.html#mutation-setCustomAttributesOnInvoice) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/attributes/mutations/set-custom-negotiable-quote.md b/src/pages/graphql/schema/attributes/mutations/set-custom-negotiable-quote.md index 3aaa03180..791575a96 100644 --- a/src/pages/graphql/schema/attributes/mutations/set-custom-negotiable-quote.md +++ b/src/pages/graphql/schema/attributes/mutations/set-custom-negotiable-quote.md @@ -27,7 +27,7 @@ mutation { ## Reference -The [`setCustomAttributesOnNegotiableQuote`](https://developer.adobe.com/commerce/services/graphql/reference/saas-api/index.html#mutation-setCustomAttributesOnNegotiableQuote) reference provides detailed information about the types and fields defined in this mutation. +The [`setCustomAttributesOnNegotiableQuote`](https://developer.adobe.com/commerce/webapi/graphql-api/saas/index.html#mutation-setCustomAttributesOnNegotiableQuote) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/index.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/index.md index b64c01942..f0e661284 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/index.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/index.md @@ -28,3 +28,7 @@ The B2B negotiable quote mutations allow you to perform the following operations - [Set the shipping method](set-shipping-methods.md) - [Set the payment method](set-payment-method.md) - [Place the order](place-order.md) + - [Place the order V2](place-order-v2.md) +- Manage Quote Templates + - [Set Negotiable Quote Template Expiration Date](set-quote-template-expiration-date.md) + \ No newline at end of file diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/place-order-v2.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/place-order-v2.md new file mode 100644 index 000000000..545fa4a96 --- /dev/null +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/place-order-v2.md @@ -0,0 +1,109 @@ +--- +title: placeNegotiableQuoteOrderV2 mutation +edition: saas +keywords: + - B2B +--- + +import CommerceOnly from '/src/_includes/commerce-only.md' + + + +# placeNegotiableQuoteOrderV2 mutation + + + +This mutation is part of the B2B Storefront Compatibility Package and is only available on [Adobe Commerce as a Cloud Service](https://experienceleague.adobe.com/en/docs/commerce/cloud-service/overview). + +The `placeNegotiableQuoteOrderV2` mutation converts a negotiable quote into an order and returns the full order object. + +The negotiable quote must have one of the following statuses: + +- SUBMITTED +- DECLINED +- EXPIRED + +If the status is DECLINED or EXPIRED, the negotiable quote is processed like a standard cart, without applying any discounts. The negotiable quote is not converted to a standard cart. + +Perform the following actions before using the `placeNegotiableQuoteOrderV2` mutation. It might be necessary to perform additional steps during the process of coming to an agreement during the negotiable quote lifecycle. + +- [Create an empty cart](../../../cart/mutations/create-empty-cart.md) +- [Add one or more products](../../../cart/mutations/add-products.md) to the cart +- [Request a negotiable quote](request.md) +- [Set the billing address](set-billing-address.md) +- [Set the shipping address](set-shipping-address.md) +- [Set the shipping method](set-shipping-methods.md) +- [Set the payment method](set-payment-method.md) + +You cannot manage orders with GraphQL, because orders are part of the backend. You can use REST calls to manage orders to their completion. + +## Syntax + +```graphql +mutation { + placeNegotiableQuoteOrderV2( + input: PlaceNegotiableQuoteOrderInput + ) { + PlaceNegotiableQuoteOrderOutputV2 + } +} +``` + +## Reference + +The [`placeNegotiableQuoteOrderV2`](https://developer.adobe.com/commerce/webapi/graphql-api/saas/index.html#mutation-placeNegotiableQuoteOrderV2) reference provides detailed information about the types and fields defined in this mutation. + +## Example usage + +**Request:** + +```graphql +mutation { + placeNegotiableQuoteOrderV2( + input: { + quote_uid: "xCA4wSZEHsb5QbFiKfoq5k1Dk8vIPBgb" + } + ) { + order { + number + token + #... + } + errors { + message + code + } + } +} +``` + +**Response:** + +```json +{ + "data": { + "placeNegotiableQuoteOrderV2": { + "order": { + "number": "000000006", + "token": "0:3:OSScWU6PKLn3kFyMhNWyskG0opgVvFBnJmtuaFHKGwDFT83S6Kv9U39iYwixuU+vhwDz2AF4pCs3GtLhHbQ=" + }, + "errors": [] + } + } +} +``` + +## Errors + +Code | Error | Description +--- | --- | --- +`CART_NOT_FOUND` | `Could not find a cart with ID` | The specified cart ID is invalid. +`CART_NOT_ACTIVE` | `The cart isn't active.` | The specified cart ID is not active. +`GUEST_EMAIL_MISSING` | `Guest email for cart is missing.` | The guest attempted to place an order but did not provide an email address. See [setGuestEmailOnCart](../../../cart/mutations/set-guest-email.md) mutation. +`UNABLE_TO_PLACE_ORDER` | `A server error stopped your order from being placed. Please try to place your order again` | The shopper tried to place an order when no products are in the shopping cart. +`UNABLE_TO_PLACE_ORDER` | `Some addresses can't be used due to the configurations for specific countries` | The shipping method was not set. See [setShippingMethodsOnCart](set-shipping-methods.md) mutation. +`UNABLE_TO_PLACE_ORDER` | `The shipping method is missing. Select the shipping method and try again` | The shipping method was not set. See [setShippingMethodsOnCart](set-shipping-methods.md) mutation. +`UNABLE_TO_PLACE_ORDER` | `Please check the billing address information` | The billing address was not set. See [setBillingAddressOnCart](../../../cart/mutations/set-billing-address.md) mutation. +`UNABLE_TO_PLACE_ORDER` | `Enter a valid payment method and try again` | The payment method was not set. See [setPaymentMethodOnCart](../../../cart/mutations/set-payment-method.md) mutation. +`UNABLE_TO_PLACE_ORDER` | `Some of the products are out of stock` | One of the products in the shopping cart are currently out of stock. +`UNDEFINED` | `UNDEFINED` | The error message does not match any error code diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/place-order.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/place-order.md index be70c1708..2dfa6fd9a 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/place-order.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/place-order.md @@ -10,6 +10,10 @@ import CommerceOnly from '/src/_includes/commerce-only.md' # placeNegotiableQuoteOrder mutation + + +This mutation has been deprecated in Adobe Commerce as a Cloud Service. Use the [placeNegotiableQuoteOrderV2 mutation](./place-order-v2.md) instead. + The `placeNegotiableQuoteOrder` mutation converts a negotiable quote into an order and returns an order ID. The negotiable quote must have one of the following statuses: @@ -30,7 +34,7 @@ Perform the following actions before using the `placeNegotiableQuoteOrder` mutat - [Set the shipping method](set-shipping-methods.md) - [Set the payment method](set-payment-method.md) -You cannot manage orders with GraphQL, because orders are part of the backend. You can use REST or SOAP calls to manage orders to their completion. +You cannot manage orders with GraphQL, because orders are part of the backend. You can use REST calls to manage orders to their completion. ## Syntax diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/request.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/request.md index 81f0fbc53..e54e24c7d 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/request.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/request.md @@ -36,6 +36,10 @@ The [`requestNegotiableQuote`](https://developer.adobe.com/commerce/webapi/graph ## Example usage +The following examples show negotiable quote requests with and without attachments. + +### Request a negotiable quote + The following example requests a negotiable quote. The cart contains three items. **Request:** @@ -194,3 +198,70 @@ mutation { } } ``` + +### Request a negotiable quote with attachments + + + +The following example requests a negotiable quote with an attachment. The attachment must be uploaded to Amazon S3 before you can reference it in the mutation. See the [`initiateUpload` mutation](../../../uploads/mutations/initiate-upload.md) and [finishUpload` mutation](../../../uploads/mutations/finish-upload.md)for more information about uploading files. + +**Request:** + +```graphql +mutation { + requestNegotiableQuote( + input: { + cart_id: "SAIanv9ZcoVbQwAFRWq6XzQbU1jK1dUT" + quote_name: "Test NQ" + comment: { + comment: "Please provide your best pricing for these bulk office supplies. We're looking for a long-term partnership." + attachments: [ + { + key: "test-document1_32cb1fe50dab390be841461e.txt" + } + ] + } + } + ) { + quote { + uid + name + status + comments { + text + attachments { + name + url + } + } + } + } +} +``` + +**Response:** + +```json +{ + "data": { + "requestNegotiableQuote": { + "quote": { + "uid": "SAIanv9ZcoVbQwAFRWq6XzQbU1jK1dUT", + "name": "Test NQ", + "status": "SUBMITTED", + "comments": [ + { + "text": "Please provide your best pricing for these bulk office supplies. We're looking for a long-term partnership.", + "attachments": [ + { + "name": "test-document1.txt", + "url": "http://bucket1.s3mock:9000/bucket1/tenant1/negotiable_quotes_attachment/test-document1_32cb1fe50dab390be841461e.txt?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20250909%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250909T170138Z&X-Amz-SignedHeaders=host&X-Amz-Expires=6600&X-Amz-Signature=a4fa238e4f4f88d4819f0b80fe2699ec6374e81cd88e70fd281a7fc8fae232ec" + } + ] + } + ] + } + } + } +} +``` diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-quote-template-expiration-date.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-quote-template-expiration-date.md new file mode 100644 index 000000000..cdb093473 --- /dev/null +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-quote-template-expiration-date.md @@ -0,0 +1,65 @@ +--- +title: setQuoteTemplateExpirationDate mutation +edition: saas +keywords: + - B2B +--- + +import CommerceOnly from '/src/_includes/commerce-only.md' + + + +# setQuoteTemplateExpirationDate mutation + + + +This mutation is part of the B2B Storefront Compatibility Package and is only available on [Adobe Commerce as a Cloud Service](https://experienceleague.adobe.com/en/docs/commerce/cloud-service/overview). + +The `setQuoteTemplateExpirationDate` mutation can be used to set an expiration date for a negotiable quote, as it is not set by default. The mutation requires `template_id` and `expiration_date` as input parameters. + +## Syntax + +```graphql +{ + setQuoteTemplateExpirationDate( + input: QuoteTemplateExpirationDateInput! + ): NegotiableQuoteTemplate +} +``` + +## Reference + +The [`setQuoteTemplateExpirationDate`](https://developer.adobe.com/commerce/webapi/graphql-api/saas/index.html#mutation-setQuoteTemplateExpirationDate) reference provides detailed information about the types and fields defined in this mutation. + +## Example usage + +The following example sets the expiration date for a negotiable quote. + +**Request:** + +```graphql +mutation { + setQuoteTemplateExpirationDate( + input: { + template_id: "10" + expiration_date: "2030-13-01" + } + ) { + template_id + expiration_date + } +} +``` + +**Response:** + +```json +{ + "data": { + "setQuoteTemplateExpirationDate": { + "template_id": "10", + "expiration_date": "2030-13-01" + } + } +} +``` diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/queries/index.md b/src/pages/graphql/schema/b2b/negotiable-quote/queries/index.md index 02c9cefd1..303cb859b 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/queries/index.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/queries/index.md @@ -10,4 +10,8 @@ import CommerceOnly from '/src/_includes/commerce-only.md' # Negotiable quote (B2B) queries -B2B for Adobe Commerce provides two negotiable quote queries. [`negotiableQuote`](./quote.md) returns details about a single quote. [`negotiableQuotes`](./quotes.md) returns multiple quotes, filtered by name or ID. +B2B for Adobe Commerce provides two negotiable quote queries. + +- [`negotiableQuote`](./quote.md) returns details about a single quote. +- [`negotiableQuotes`](./quotes.md) returns multiple quotes, filtered by name or ID. +- [`negotiableQuoteTemplates`](./templates.md) returns multiple quote templates, filtered by name or ID. diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/queries/quote.md b/src/pages/graphql/schema/b2b/negotiable-quote/queries/quote.md index 1a7d96871..e4f1854ec 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/queries/quote.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/queries/quote.md @@ -60,6 +60,10 @@ query{ lastname } text + attachments { + name + url + } } history { uid @@ -162,7 +166,13 @@ query{ "firstname": "Taina", "lastname": "Garofalo" }, - "text": "Requesting a 10% discount for being a repeat customer." + "text": "Requesting a 10% discount for being a repeat customer.", + "attachments": [ + { + "name": "terms_and_conditions.pdf", + "url": "https://.s3..amazonaws.com/negotiable-quote/terms_and_conditions_5f4dcc3b5aa765d61d8327deb882cf99.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..." + } + ] }, { "uid": "Mg==", @@ -171,7 +181,13 @@ query{ "firstname": "John Paul", "lastname": "Pope" }, - "text": "Hello Taina! Thanks for registering with Luma as a partner company.\r\n\r\nUnfortunately, we cannot grant your request, because the 10% discount is reserved for our frequent customers, and this is your first order. We can offer a 5% discount on this order." + "text": "Hello Taina! Thanks for registering with Luma as a partner company.\r\n\r\nUnfortunately, we cannot grant your request, because the 10% discount is reserved for our frequent customers, and this is your first order. We can offer a 5% discount on this order.", + "attachments": [ + { + "name": "terms_and_conditions.pdf", + "url": "https://.s3..amazonaws.com/negotiable-quote/terms_and_conditions_5f4dcc3b5aa765d61d8327deb882cf99.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..." + } + ] }, { "uid": "Mw==", @@ -180,7 +196,13 @@ query{ "firstname": "Taina", "lastname": "Garofalo" }, - "text": "I understand. I'll accept your offer." + "text": "I understand. I'll accept your offer.", + "attachments": [ + { + "name": "terms_and_conditions.pdf", + "url": "https://.s3..amazonaws.com/negotiable-quote/terms_and_conditions_5f4dcc3b5aa765d61d8327deb882cf99.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..." + } + ] }, { "uid": "NA==", @@ -189,7 +211,13 @@ query{ "firstname": "John Paul", "lastname": "Pope" }, - "text": "Great! You should see a 5% discount in your cart. Shipping fees and taxes might apply." + "text": "Great! You should see a 5% discount in your cart. Shipping fees and taxes might apply.", + "attachments": [ + { + "name": "terms_and_conditions.pdf", + "url": "https://.s3..amazonaws.com/negotiable-quote/terms_and_conditions_5f4dcc3b5aa765d61d8327deb882cf99.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..." + } + ] }, { "uid": "NQ==", @@ -198,7 +226,13 @@ query{ "firstname": "Taina", "lastname": "Garofalo" }, - "text": "Adding a shipping address" + "text": "Adding a shipping address", + "attachments": [ + { + "name": "terms_and_conditions.pdf", + "url": "https://.s3..amazonaws.com/negotiable-quote/terms_and_conditions_5f4dcc3b5aa765d61d8327deb882cf99.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..." + } + ] } ], "history": [ diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/queries/quotes.md b/src/pages/graphql/schema/b2b/negotiable-quote/queries/quotes.md index eb70aee83..bbf58e2c4 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/queries/quotes.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/queries/quotes.md @@ -32,6 +32,8 @@ The [`negotiableQuotes`](https://developer.adobe.com/commerce/webapi/graphql-api ## Example usage +### Find quotes that contain a specific string + The following example returns general information about the negotiable quotes containing the string `request` that are accessible to the company user. The results are sorted by negotiable quote name, listed in ascending order. **Request:** @@ -90,3 +92,75 @@ query { } } ``` + +### Retrieve attachments associated with comments on quotes + + + +The following example returns detailed information about all negotiable quotes that are accessible to the company user, including any attachments associated with comments on the quotes. + +**Request:** + +```graphql +{ + negotiableQuotes { + total_count + items { + uid + name + status + created_at + updated_at + comments { + attachments { + name + url + } + } + } + } +} +``` + +**Response:** + +```json +{ + "data": { + "negotiableQuotes": { + "total_count": 2, + "items": [ + { + "uid": "SAIanv9ZcoVbQwAFRWq6XzQbU1jK1dUT", + "name": "Test NQ", + "status": "SUBMITTED", + "created_at": "2025-09-09 16:59:10", + "updated_at": "2025-09-09 16:59:37", + "comments": [ + { + "attachments": [ + { + "name": "test-document1.txt", + "url": "http://bucket1.s3mock:9000/bucket1/tenant1/negotiable_quotes_attachment/test-document1_32cb1fe50dab390be841461e.txt?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20250909%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250909T170138Z&X-Amz-SignedHeaders=host&X-Amz-Expires=6600&X-Amz-Signature=a4fa238e4f4f88d4819f0b80fe2699ec6374e81cd88e70fd281a7fc8fae232ec" + } + ] + } + ] + }, + { + "uid": "NYw9JKZW1BCQ8ZtsYyUKrGkGLlrJ34Kr", + "name": "Test NQ", + "status": "SUBMITTED", + "created_at": "2025-09-09 16:54:28", + "updated_at": "2025-09-09 16:57:58", + "comments": [ + { + "attachments": [] + } + ] + } + ] + } + } +} +``` diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/queries/templates.md b/src/pages/graphql/schema/b2b/negotiable-quote/queries/templates.md new file mode 100644 index 000000000..179e0dead --- /dev/null +++ b/src/pages/graphql/schema/b2b/negotiable-quote/queries/templates.md @@ -0,0 +1,122 @@ +--- +title: negotiableQuoteTemplates query +edition: saas +keywords: + - B2B +--- + +import CommerceOnly from '/src/_includes/commerce-only.md' + + + +# negotiableQuoteTemplates query + +The `negotiableQuoteTemplates` query returns a list of negotiable quote templates that can be viewed by the logged-in customer, including quote templates created by the customer or by subordinates in the company hierarchy. + +This query requires a valid [customer authentication token](../../../customer/mutations/generate-token.md). + +## Syntax + +```graphql +{ + negotiableQuoteTemplates( + filter: NegotiableQuoteTemplateFilterInput, + pageSize: Int = 20, + currentPage: Int = 1 + sort: NegotiableQuoteTemplateSortInput + ): NegotiableQuoteTemplatesOutput +} +``` + +## Reference + +The [`negotiableQuoteTemplates`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#query-negotiableQuoteTemplates) reference provides detailed information about the types and fields defined in this query. + +## Example usage + +### Find quote templates that contain a specific string + +The following example returns general information about the negotiable quote templates containing the string `request` that are accessible to the company user. The results are sorted by negotiable quote name, listed in ascending order. + +**Request:** + +```graphql +query { + negotiableQuoteTemplates(filter: { name: + { match: "request" } + }) + { + items { + uid + name + created_at + status + } + total_count + page_info { + page_size + current_page + total_pages + } + sort_fields { + default + options { + label + value + } + } + } +} +``` + +**Response:** + +```json +{ + "data": { + "negotiableQuoteTemplates": { + "items": [ + { + "uid": "MTU0", + "name": "Last request Template", + "created_at": "2021-04-28 15:43:09", + "status": "Active" + }, + { + "uid": "MTUz", + "name": "Latest request Template", + "created_at": "2021-04-26 16:35:48", + "status": "Active" + }, + { + "uid": "MTUy", + "name": "April 22 request", + "created_at": "2021-04-22 15:59:47", + "status": "Active" + }, + { + "uid": "MTUx", + "name": "Discount request", + "created_at": "2021-04-20 19:01:38", + "status": "Active" + } + ], + "total_count": 4, + "page_info": { + "page_size": 20, + "current_page": 1, + "total_pages": 1 + }, + "sort_fields": { + "default": "TEMPLATE_ID", + "options": [ + { + "label": "Last Shared", + "value": "LAST_SHARED_AT" + } + ] + } + } + } +} +``` diff --git a/src/pages/graphql/schema/b2b/purchase-order/index.md b/src/pages/graphql/schema/b2b/purchase-order/index.md index e1f99164c..51b87392a 100644 --- a/src/pages/graphql/schema/b2b/purchase-order/index.md +++ b/src/pages/graphql/schema/b2b/purchase-order/index.md @@ -207,7 +207,7 @@ The following example returns the purchase order information. "items": [ { "product": { - "sku": "Simple product" + "sku": "Simple-product" } } ], diff --git a/src/pages/graphql/schema/b2b/purchase-order/mutations/add-items-to-cart.md b/src/pages/graphql/schema/b2b/purchase-order/mutations/add-items-to-cart.md index b5e26a92b..6b662daf6 100644 --- a/src/pages/graphql/schema/b2b/purchase-order/mutations/add-items-to-cart.md +++ b/src/pages/graphql/schema/b2b/purchase-order/mutations/add-items-to-cart.md @@ -70,7 +70,7 @@ mutation { "items": [ { "product": { - "sku": "Simple product" + "sku": "Simple-product" } } ] diff --git a/src/pages/graphql/schema/catalog-service/queries/index.md b/src/pages/graphql/schema/catalog-service/queries/index.md index 6325e7554..857070465 100644 --- a/src/pages/graphql/schema/catalog-service/queries/index.md +++ b/src/pages/graphql/schema/catalog-service/queries/index.md @@ -14,5 +14,3 @@ Catalog Service provides the following queries: * [`products`](products.md) * [`refineProduct`](refine-product.md) * [`variants`](product-variants.md) - -It also extends the Live Search [`productSearch`](../../live-search/queries/product-search.md#catalog-service) query to return product view data. diff --git a/src/pages/graphql/schema/customer/mutations/create-address.md b/src/pages/graphql/schema/customer/mutations/create-address.md index 5cc121b8d..edd834350 100644 --- a/src/pages/graphql/schema/customer/mutations/create-address.md +++ b/src/pages/graphql/schema/customer/mutations/create-address.md @@ -200,6 +200,56 @@ mutation { } ``` +### Create an address that includes a custom file + + + +The following call creates an address for the specified customer that includes a file that was uploaded to Amazon S3 using the [`initiateUpload` mutation](../../uploads/mutations/initiate-upload.md). + +#### Request + +```graphql +mutation { + createCustomerAddress( + input: { + "region": { + "region": "Arizona", + "region_code": "AZ" + }, + "country_code": "US", + "street": [ + "123 Main Street" + ], + "telephone": "5553217890", + "postcode": "77777", + "city": "Phoenix", + "default_shipping": true, + "default_billing": false, + custom_attributesV2: [ + { + attribute_code: "test_file_add" + value: "example_a367071e1639483de735c639.jpg" + } + ] + } + ) { + id + } +} +``` + +#### Response + +```json +{ + "data": { + "createCustomerAddress": { + "id": 5, + } + } +} +``` + ## Errors Error | Description diff --git a/src/pages/graphql/schema/customer/mutations/delete-address-v2.md b/src/pages/graphql/schema/customer/mutations/delete-address-v2.md new file mode 100644 index 000000000..b24b72be9 --- /dev/null +++ b/src/pages/graphql/schema/customer/mutations/delete-address-v2.md @@ -0,0 +1,85 @@ +--- +title: deleteCustomerAddressV2 mutation +--- + +# deleteCustomerAddressV2 mutation + +Use the `deleteCustomerAddressV2` mutation to delete the specified customer address. It returns a Boolean value that indicates whether the operation was successful. + +We recommend you use a customer token in the header of your call to delete a customer. However, you also can use [session authentication](https://developer.adobe.com/commerce/webapi/get-started/authentication/gs-authentication-session). + + + +This mutation is part of the [Storefront Compatibility Package](https://experienceleague.adobe.com/developer/commerce/storefront/setup/configuration/storefront-compatibility/v248/). It will be added to Adobe Commerce 2.4.9. + +## Syntax + +```graphql +mutation { + deleteCustomerAddressV2( + uid: ID! + ) { + Boolean + } +} +``` + + + +## Example usage + +The following call deletes a customer's address. + +**Request:** + +```graphql +mutation { + deleteCustomerAddressV2(uid: "ODU=") +} +``` + +**Response:** + +```json +{ + "data": { + "deleteCustomerAddressV2": true + } +} +``` + +## Input attributes + +The `deleteCustomerAddressV2` mutation requires the following input: + +Attribute | Data Type | Description +--- | --- | --- +`uid` | ID! | The unique ID for a `CustomerAddress` object. + +## Output attributes + +The `deleteCustomerAddressV2` mutation returns a Boolean value that indicates whether the operation was successful. + +## Errors + +Error | Description +--- | --- +`Address "uid" value must be specified` | The `uid` argument is null or empty. +`Could not find an address with ID "XXX"` | The customer address specified in the `uid` argument does not exist. +`Customer Address XXX is set as default billing address and cannot be deleted` | You cannot delete a default billing address. +`Customer Address XXX is set as default shipping address and cannot be deleted` | You cannot delete a default shipping address. +`Field "deleteCustomerAddressV2" argument "uid" requires type ID!, found "XXX".` | The specified `uid` argument value has the wrong type. +`Syntax Error: Expected Name, found )` | The `uid` argument was omitted or does not have a value. +`The current customer isn't authorized.` | The current customer is not currently logged in, or the customer's token does not exist in the `oauth_token` table. + +## Related topics + +* [customer query](../queries/customer.md) +* [createCustomer mutation](create.md) +* [updateCustomer mutation](update.md) +* [createCustomerAddress mutation](create-address.md) +* [updateCustomerAddress mutation](update-address.md) diff --git a/src/pages/graphql/schema/customer/mutations/delete-address.md b/src/pages/graphql/schema/customer/mutations/delete-address.md index c9afbb158..948be1ab3 100644 --- a/src/pages/graphql/schema/customer/mutations/delete-address.md +++ b/src/pages/graphql/schema/customer/mutations/delete-address.md @@ -4,6 +4,10 @@ title: deleteCustomerAddress mutation # deleteCustomerAddress mutation + + +This mutation has been deprecated in Adobe Commerce as a Cloud Service and will be deprecated in Adobe Commerce 2.4.9. We recommend using the [deleteCustomerAddressV2 mutation](./delete-address-v2.md) instead. + Use the `deleteCustomerAddress` mutation to delete the specified customer address. It returns a Boolean value that indicates whether the operation was successful. We recommend you use a customer token in the header of your call to delete a customer. However, you also can use [session authentication](https://developer.adobe.com/commerce/webapi/get-started/authentication/gs-authentication-session). diff --git a/src/pages/graphql/schema/customer/mutations/exchange-otp-customer-token.md b/src/pages/graphql/schema/customer/mutations/exchange-otp-customer-token.md new file mode 100644 index 000000000..04e80ed23 --- /dev/null +++ b/src/pages/graphql/schema/customer/mutations/exchange-otp-customer-token.md @@ -0,0 +1,48 @@ +--- +title: exchangeOtpForCustomerToken mutation +edition: saas +--- + +# exchangeOtpForCustomerToken mutation + +The `exchangeOtpForCustomerToken` mutation allows you to specify a shopper's email address and one-time password (OTP) and receive a customer token in exchange. This mutation is typically used in scenarios where a customer needs to authenticate using an OTP sent to their email or phone. + +Upon successful exchange, the module invalidates the OTP so it cannot be reused. The endpoint also integrates with reCAPTCHA configuration to mitigate automated abuse. + +## Syntax + +`mutation: { + exchangeOtpForCustomerToken(email: String!, otp: String!) {CustomerToken}}` + +## Example usage + +The following example uses the specified email and one-time password (OTP) to return a customer token. + +**Request:** + +```graphql +mutation { + exchangeOtpForCustomerToken( + email: "customer@example.com" + otp: "gTQySBnj2w4ql9EL6XdnF267mzkK3cQG" + ) { + token + } +} +``` + +**Response:** + +```json +{ + "data": { + "exchangeOtpForCustomerToken": { + "token": "" + } + } +} +``` + +## Related topic + +* [customer query](../queries/customer.md) diff --git a/src/pages/graphql/schema/customer/mutations/index.md b/src/pages/graphql/schema/customer/mutations/index.md index 454d81568..cd6f977c3 100644 --- a/src/pages/graphql/schema/customer/mutations/index.md +++ b/src/pages/graphql/schema/customer/mutations/index.md @@ -13,14 +13,18 @@ The customer mutations allow you to perform the following operations: * [`createCustomerAddress`](create-address.md) * [`createCustomerV2`](create-v2.md) * [`deleteCustomerAddress`](delete-address.md) + * [`deleteCustomerAddressV2`](delete-address-v2.md) * [`updateCustomer`](update.md) * [`updateCustomerAddress`](update-address.md) + * [`updateCustomerAddressV2`](update-address-v2.md) * [`updateCustomerEmail`](update-email.md) * [`updateCustomerV2`](update-v2.md) * Manage customer tokens and passwords * [`changeCustomerPassword`](change-password.md) + * [`exchangeExternalCustomerToken`](exchange-external-customer-token.md) + * | [​`exchangeOtpForCustomerToken`](exchange-otp-customer-token.md) * [`generateCustomerTokenAsAdmin`](generate-token-as-admin.md) * [`generateCustomerToken`](generate-token.md) * [`requestPasswordResetEmail`](request-password-reset-email.md) diff --git a/src/pages/graphql/schema/customer/mutations/update-address-v2.md b/src/pages/graphql/schema/customer/mutations/update-address-v2.md new file mode 100644 index 000000000..72ddcb1f8 --- /dev/null +++ b/src/pages/graphql/schema/customer/mutations/update-address-v2.md @@ -0,0 +1,164 @@ +--- +title: updateCustomerAddressV2 mutation +--- + +# updateCustomerAddressV2 mutation + +Use the `updateCustomerAddressV2` mutation to update the customer's address. + +To return or modify information about a customer, we recommend you use customer tokens in the header of your GraphQL calls. However, you also can use [session authentication](https://developer.adobe.com/commerce/webapi/get-started/authentication/gs-authentication-session). + + + +This mutation is part of the [Storefront Compatibility Package](https://experienceleague.adobe.com/developer/commerce/storefront/setup/configuration/storefront-compatibility/v248/). It will be added to Adobe Commerce 2.4.9. + +## Syntax + +```graphql +mutation { + updateCustomerAddressV2( + uid: ID!, + input: CustomerAddressInput + ) { + CustomerAddress + } +} +``` + + + +## Example usage + +### Update a customer address + +The following call updates the customer's city and postcode. + +**Request:** + +```graphql +mutation { + updateCustomerAddressV2(uid:"ODU=", input: { + city: "New City" + postcode: "55555" + }) { + uid + city + postcode + } +} +``` + +**Response:** + +```json +{ + "data": { + "updateCustomerAddressV2": { + "uid": "ODU=", + "city": "New City", + "postcode": 55555 + } + } +} +``` + +### Update a customer address with custom attributes + +The following call updates the customer's city, postcode, and custom attributes. The merchant has previously created the `station` and `services` attributes for customer addresses. + +**Request:** + +```graphql +mutation { + updateCustomerAddressV2(uid: "ODU=", input: { + city: "New City" + postcode: "55555" + custom_attributesV2: [ + { + attribute_code: "station", + value: "Times Sq - 42 St" + }, + { + attribute_code: "services" + value: "507" + selected_options: [ + { + uid: "NTA3" + value: "507" + } + ] + } + ] + }) { + uid + city + postcode + custom_attributesV2 { + code + ... on AttributeValue { + value + } + ... on AttributeSelectedOptions { + selected_options { + label + value + } + } + } + } +} +``` + +**Response:** + +```json +{ + "data": { + "updateCustomerAddressV2": { + "uid": "ODU=", + "city": "New City", + "postcode": 55555, + "custom_attributesV2": [ + { + "code": "station", + "value": "Times Sq - 42 St" + }, + { + "code": "services", + "selected_options": [ + { + "label": "hospital", + "value": "507" + } + ] + } + ] + } + } +} +``` + +## Errors + +Error | Description +--- | --- +`Address "uid" value must be specified` | The `uid` argument is null or empty. +`Could not find an address with ID "XXX"` | The customer address specified in the `uid` argument does not exist. +`Current customer does not have permission to address with ID "XXX"` | The customer tries to update the address of another customer. +`Field "updateCustomerAddressV2" argument "uid" of type "ID!" is required but not provided.` | The `uid` argument was omitted. +`Field "updateCustomerAddressV2" argument "uid" requires type ID!, found "XXX".` | The specified `uid` argument value has the wrong type. +`"input" value must be specified` | The `input` argument was omitted or was specified but is empty. +`Syntax Error: Expected Name, found )` | The `uid` and `input` arguments are omitted. +`The current customer isn't authorized.` | The current customer is not currently logged in, or the customer's token does not exist in the `oauth_token` table. + +## Related topics + +* [customer query](../queries/customer.md) +* [createCustomer mutation](create.md) +* [updateCustomer mutation](update.md) +* [createCustomerAddress mutation](create-address.md) +* [deleteCustomerAddress mutation](delete-address.md) diff --git a/src/pages/graphql/schema/customer/mutations/update-address.md b/src/pages/graphql/schema/customer/mutations/update-address.md index f16a757ee..08e1ca4d9 100644 --- a/src/pages/graphql/schema/customer/mutations/update-address.md +++ b/src/pages/graphql/schema/customer/mutations/update-address.md @@ -4,6 +4,10 @@ title: updateCustomerAddress mutation # updateCustomerAddress mutation + + +This mutation has been deprecated in Adobe Commerce as a Cloud Service and will be deprecated in Adobe Commerce 2.4.9. We recommend using the [`updateCustomerAddressV2` mutation](./update-address-v2.md) instead. + Use the `updateCustomerAddress` mutation to update the customer's address. To return or modify information about a customer, we recommend you use customer tokens in the header of your GraphQL calls. However, you also can use [session authentication](https://developer.adobe.com/commerce/webapi/get-started/authentication/gs-authentication-session). diff --git a/src/pages/graphql/schema/customer/queries/customer.md b/src/pages/graphql/schema/customer/queries/customer.md index ecaa53c54..413724267 100644 --- a/src/pages/graphql/schema/customer/queries/customer.md +++ b/src/pages/graphql/schema/customer/queries/customer.md @@ -3,6 +3,7 @@ title: customer query --- import CustomAttributeCustomer from '/src/_includes/graphql/examples/custom-attribute-customer.md' +import CustomerS3Download from '/src/_includes/graphql/examples/customer-s3-download.md' # customer query @@ -1034,6 +1035,12 @@ The [Purchase order approval rules](../../b2b/purchase-order-rule/) topic contai } ``` +### Retrieve a file uploaded to Amazon S3 + + + +< CustomerS3Download /> + ## Related topics * [isEmailAvailable query](../../b2b/company/queries/is-company-email-available.md) diff --git a/src/pages/graphql/schema/live-search/queries/product-search.md b/src/pages/graphql/schema/live-search/queries/product-search.md index 94b0a5f03..6fa6334af 100644 --- a/src/pages/graphql/schema/live-search/queries/product-search.md +++ b/src/pages/graphql/schema/live-search/queries/product-search.md @@ -18,7 +18,7 @@ See [Boundaries and Limits](https://experienceleague.adobe.com/en/docs/commerce- ```graphql productSearch( phrase: String! - context: [QueryContextInput!] + context: QueryContextInput! current_page: Int = 1 page_size: Int = 20 sort: [ProductSearchSortInput!] @@ -32,7 +32,7 @@ Live Search uses the `productSearch` query to search for products instead of the -The Catalog Service `productSearch` query uses Live Search to return details about the SKUs specified as input. [Learn more](#catalog-service). +The Catalog Service `productSearch` query uses Live Search to return details about the SKUs specified as input. The `productSearch` query accepts the following fields as input: @@ -165,20 +165,22 @@ Only facets specified in Live Search are returned. Use the [`attributeMetadata` query](./attribute-metadata.md) to return a list of product attributes that can be used to define a filter. -#### Filtering using search capability +#### Layered search and expansion of search types - +Layered search, or search within a search, is an attribute-based filtering system that extends the traditional search functionality to include additional search parameters. These additional search parameters allow more precise and flexible product discovery. See the [merchant documentation](https://experienceleague.adobe.com/en/docs/commerce/live-search/workspace#layered-search-and-expansion-of-search-types) to learn how to update the search types in the Admin to enable layered search. + + -This feature is in beta. For installation information, see the [Live Search guide](https://experienceleague.adobe.com/en/docs/commerce-merchant-services/live-search/install#install-the-live-search-beta) in the merchant documentation. +Layered search is available in Live Search 4.6.0 (PaaS) or in the latest version of [Commerce Optimizer](https://experienceleague.adobe.com/en/docs/commerce/optimizer/release-notes) (SaaS). -This beta supports three new capabilities: +The advanced search capabilities are implemented through the `filter` parameter in the `productSearch` query using specific operators: - **Layered search** - Search within another search context - With this capability, you can undertake up to two layers of search for your search queries. For example: - - **Layer 1 search** - Search for "motor" on "product_attribute_1". - - **Layer 2 search** - Search for "part number 123" on "product_attribute_2". This example searches for "part number 123" within the results for "motor". + - **Layer 1 search** - Search for "motor" on `product_attribute_1`. + - **Layer 2 search** - Search for "part number 123" on `product_attribute_2`. This example searches for "part number 123" within the results for "motor". - Layered search is available for both `startsWith` search indexation and `contains` search indexation as described below: + Layered search is available for both `startsWith` search indexation and `contains` search indexation in the second layer of the layered search, as described below: - **startsWith search indexation** - Search using `startsWith` indexation. This new capability allows: @@ -191,7 +193,40 @@ This beta supports three new capabilities: - Note: This search type is different from the existing [phrase search](#phrase), which performs an autocomplete search. For example, if your product attribute value is "outdoor pants", a phrase search returns a response for "out pan", but does not return a response for "oor ants". A contains search, however, does return a response for "oor ants". -Refer to the following examples to learn how to implement these new search capabilities in your Live Search API. +##### Examples + +Learn how to implement these new search capabilities in your Live Search API by following the examples below. First, review the requirements to ensure proper configuration. + +**Frontend support:** + +Layered search is available on the following architectures: + +- Commerce Optimizer [Product Discovery drop-ins](https://experienceleague.adobe.com/developer/commerce/storefront/dropins/product-discovery/functions/) +- Live Search (headless) + + + +The Live Search Product Listing Page (PLP) and popover widgets do not support layered search. + +**API configuration requirements:** + +- Attributes must have the **Use in Search Results Layered Navigation** checkbox set to **Filterable (with results)** in the [Admin](https://experienceleague.adobe.com/en/docs/commerce-admin/catalog/product-attributes/product-attributes-add#step-5-describe-the-storefront-properties). +- Each attribute must have the correct search type specified: `contains` or `startsWith`. +- A maximum of 6 attributes can be enabled for `contains` search. +- A maximum of 6 attributes can be enabled for `startsWith` search. + +**Performance considerations:** + +- `startsWith` and `contains` searches are optimized for performance through specialized indexing. +- Both `startsWith` and `contains` searches require a minimum of two characters. +- A search term is limited to 10 characters or less. +- For the **Contains** indexation, string length is limited to 50 characters or less. + +**Error handling:** + +- 500 error returned if an attribute is not set to `filterableInSearch: true`. +- Invalid attribute codes will result in no matches. +- Exceeding character limits will fall back to autocomplete search. ##### startsWith condition example @@ -232,9 +267,7 @@ filter: [ ] ``` -**Example queries** - -The following example shows how to search within search results using "motor" as the search phrase and filtering on "manufacturer" that "startsWith" the term "Sieme": +The following example shows how to search within search results using "motor" as the search phrase and filtering on `manufacturer` that `startsWith` the term "Sieme": ```graphql productSearch( @@ -306,7 +339,7 @@ productSearch( ##### Limitations -The beta has the following limitations: +The advanced search capabilitiies have the following limitations: - You can specify a maximum of six attributes to be enabled for **Contains** and six attributes to be enabled for **Starts with**. - Each aggregation returns a maximum of 1000 facets. @@ -351,6 +384,52 @@ filter:[ ] ``` +##### Error handling for categories, categoryPath, and categoryIds + +When sorting by category `position` with an empty or invalid `categories`, `categoryPath`, or `categoryIDs`, the Search service gracefully handles the request to prevent `FAILED_PRECONDITION` errors. This scenario commonly occurs when attempting to sort by position at the root category level, where category paths are not standardized across store views. + +**Behavior when an empty or invalid `categories`, `categoryPath`, or `categoryIDs` is detected with position sorting:** + +- Category position sort is ignored +- The system falls back to relevance-based sorting +- Products are returned successfully + + + +Despite the empty or invalid `categories`, `categoryPath`, or `categoryIDs`, the query executes successfully and returns product data in the `data` object, sorted by relevance instead of position. + +**Example query:** + +```graphql +{ + productSearch( + phrase: "pants" + page_size: 8 + filter: [ + { + attribute: "categoryPath", + eq: null + } + ] + sort: [ + { + attribute: "position", + direction: ASC + } + ] + ) { + items { + productView { + name + sku + } + } + } +} +``` + +In this example, the system returns products sorted by relevance. + #### categories `categories` can be used as a filter in a query when a category facet is selected in the layered navigation. @@ -437,36 +516,15 @@ facets { The `items` object primarily provides details about each item returned. The structure of this object varies between Catalog Service and Live Search. For Catalog Service, specify a `ProductSearchItem.productView` object. For Live Search, specify a `ProductSearchItem.product` object -#### ProductSearchItem.product (Live Search) + -The following snippet returns relevant information about each item when Catalog Service is not installed or used: +The `ProductInterface` object in the Search service GraphQL schema has been deprecated. Use the `ProductView` object instead, which is defined and documented as the recommended alternative for use with the Catalog Service. -```graphql -items { - product { - name - sku - price_range { - maximum_price { - final_price { - value - currency - } - } - minimum_price { - final_price { - value - currency - } - } - } - } -} -``` +#### ProductSearchItem.productView -#### ProductSearchItem.productView (Catalog Service) + -If [Catalog Service](https://experienceleague.adobe.com/docs/commerce-merchant-services/catalog-service/guide-overview.html) is installed, you can optionally use the `productView` field instead of the `product` field to return product details. Catalog Service uses [Catalog Sync](https://experienceleague.adobe.com/docs/commerce-merchant-services/user-guides/data-services/catalog-sync.html) to manage product data, resulting in query responses with less latency than is possible with the `ProductInterface`. With Catalog Service, the structure of the pricing information varies, depending on whether the product is designated as a `SimpleProduct` (simple, downloadable, gift card) or as a `ComplexProduct` (configurable, grouped, or bundle). +Use the `ProductView` field instead of the deprecated `product` field to return product details. Catalog Service uses [Catalog Sync](https://experienceleague.adobe.com/docs/commerce-merchant-services/user-guides/data-services/catalog-sync.html) to manage product data, resulting in query responses with less latency than is possible with the `ProductInterface`. With Catalog Service, the structure of the pricing information varies, depending on whether the product is designated as a `SimpleProduct` (simple, downloadable, gift card) or as a `ComplexProduct` (configurable, grouped, or bundle). The following Catalog Service snippet returns relevant information about each item: @@ -543,7 +601,7 @@ The `items` object can also optionally return highlighted text that shows the ma The query response can also contain the following top-level fields and objects: - `page_info` - An object that lists the `page_size` and `current_page` input arguments and the total number of pages available. -- `suggestions` - An array of strings that include the names of products and categories that exist in the catalog that are similar to the search query. +- `suggestions` - An array of strings that include the names of products and categories that exist in the catalog that are similar to the search query. See [Logic used for `suggestions`](#common-fields) to learn more. - `total_count` - The number of products returned. ## Endpoints @@ -563,7 +621,7 @@ Header name| Description `Magento-Store-Code` | The code assigned to the store associated with the active store view. For example, `main_website_store`. `Magento-Store-View-Code` | The code assigned to the active store view. For example, `default`. `Magento-Website-Code` | The code assigned to the website associated with the active store view. For example, `base`. -`X-Api-Key` | For Live Search queries, set this value to `search_gql`. For Catalog Service queries, set this value to the [unique API key](https://experienceleague.adobe.com/en/docs/commerce-merchant-services/user-guides/integration-services/saas#genapikey) generated for your Commerce environment. +`X-Api-Key` | Set this value to the [unique API key](https://experienceleague.adobe.com/en/docs/commerce/user-guides/integration-services/saas#genapikey) generated for your Commerce environment. ### Find the customer group code @@ -573,474 +631,7 @@ import CustomerGroupCode from '/src/_includes/graphql/customer-group-code.md' ## Example usage -In the following sections provide examples for using Live Search and Catalog Service. - -### Live Search - -This is an example of using Live Search to retrieve and filter results. The query uses the core `ProductInterface` to access product information. As a result, the query has a longer response time than using [Catalog Service](https://experienceleague.adobe.com/docs/commerce-merchant-services/catalog-service/guide-overview.html) to retrieve this information. - -For an example of using Live Search with Catalog Service, see [Catalog Service productSearch query](#catalog-service). Other than returning the `productView` object, all other attributes are the same. - -In the example below, there is no search `phrase` passed and results are filtered on the "women/bottoms-women" category. In the response, two categories are returned: - -```json -{ - "title": "women/bottoms-women/shorts-women", - "__typename": "ScalarBucket", - "id": "28", - "count": 12 -}, -{ - "title": "women/bottoms-women/pants-women", - "__typename": "ScalarBucket", - "id": "27", - "count": 13 -} -``` - -If the `phrase` "pants" is added, only one category is returned and "shorts" are not returned by the query: - -```json -{ - "title": "women/bottoms-women/pants-women", - "__typename": "ScalarBucket", - "id": "27", - "count": 13 -} -``` - -**Request:** - -```graphql -{ - productSearch( - phrase: "" - sort: [ - { attribute: "price", direction: DESC } - { attribute: "name", direction: DESC } - ] - filter: [ - { attribute: "categoryPath", in: ["women/bottoms-women"] } - ] - page_size: 9 - ) { - total_count - page_info { - current_page - page_size - total_pages - } - facets { - attribute - title - type - buckets { - title - __typename - ... on RangeBucket { - title - to - from - count - } - ... on ScalarBucket { - title - id - count - } - ... on StatsBucket { - title - min - max - } - } - } - items { - product { - name - sku - } - } - suggestions - } -} -``` - -**Response:** - -
-Response - -```json -"data": { - "productSearch": { - "total_count": 25, - "page_info": { - "current_page": 1, - "page_size": 9, - "total_pages": 3 - }, - "facets": [ - { - "attribute": "categories", - "title": "Categories", - "type": "PINNED", - "buckets": [ - { - "title": "women/bottoms-women/shorts-women", - "__typename": "ScalarBucket", - "id": "28", - "count": 12 - }, - { - "title": "women/bottoms-women/pants-women", - "__typename": "ScalarBucket", - "id": "27", - "count": 13 - } - ] - }, - { - "attribute": "price", - "title": "Price", - "type": "PINNED", - "buckets": [ - { - "title": "0.0-25.0", - "__typename": "RangeBucket", - "to": 25, - "from": 0, - "count": 1 - }, - { - "title": "25.0-50.0", - "__typename": "RangeBucket", - "to": 50, - "from": 25, - "count": 20 - }, - { - "title": "50.0-75.0", - "__typename": "RangeBucket", - "to": 75, - "from": 50, - "count": 4 - } - ] - }, - { - "attribute": "material", - "title": "Material", - "type": "POPULAR", - "buckets": [ - { - "title": "Organic Cotton", - "__typename": "ScalarBucket", - "id": "Organic Cotton", - "count": 13 - }, - { - "title": "Spandex", - "__typename": "ScalarBucket", - "id": "Spandex", - "count": 11 - }, - { - "title": "Polyester", - "__typename": "ScalarBucket", - "id": "Polyester", - "count": 7 - }, - { - "title": "Cotton", - "__typename": "ScalarBucket", - "id": "Cotton", - "count": 4 - }, - { - "title": "LumaTech™", - "__typename": "ScalarBucket", - "id": "LumaTech™", - "count": 5 - }, - { - "title": "CoolTech™", - "__typename": "ScalarBucket", - "id": "CoolTech™", - "count": 4 - }, - { - "title": "Mesh", - "__typename": "ScalarBucket", - "id": "Mesh", - "count": 3 - }, - { - "title": "Cocona® performance fabric", - "__typename": "ScalarBucket", - "id": "Cocona® performance fabric", - "count": 4 - } - ] - }, - { - "attribute": "new", - "title": "New", - "type": "POPULAR", - "buckets": [ - { - "title": "no", - "__typename": "ScalarBucket", - "id": "no", - "count": 21 - }, - { - "title": "yes", - "__typename": "ScalarBucket", - "id": "yes", - "count": 4 - } - ] - }, - { - "attribute": "color", - "title": "Color", - "type": "POPULAR", - "buckets": [ - { - "title": "Blue", - "__typename": "ScalarBucket", - "id": "Blue", - "count": 14 - }, - { - "title": "Black", - "__typename": "ScalarBucket", - "id": "Black", - "count": 12 - }, - { - "title": "Orange", - "__typename": "ScalarBucket", - "id": "Orange", - "count": 9 - }, - { - "title": "Green", - "__typename": "ScalarBucket", - "id": "Green", - "count": 8 - }, - { - "title": "Purple", - "__typename": "ScalarBucket", - "id": "Purple", - "count": 8 - }, - { - "title": "Gray", - "__typename": "ScalarBucket", - "id": "Gray", - "count": 8 - }, - { - "title": "Red", - "__typename": "ScalarBucket", - "id": "Red", - "count": 7 - }, - { - "title": "White", - "__typename": "ScalarBucket", - "id": "White", - "count": 5 - } - ] - }, - { - "attribute": "eco_collection", - "title": "Eco Collection", - "type": "POPULAR", - "buckets": [ - { - "title": "no", - "__typename": "ScalarBucket", - "id": "no", - "count": 18 - }, - { - "title": "yes", - "__typename": "ScalarBucket", - "id": "yes", - "count": 7 - } - ] - }, - { - "attribute": "climate", - "title": "Climate", - "type": "POPULAR", - "buckets": [ - { - "title": "Indoor", - "__typename": "ScalarBucket", - "id": "Indoor", - "count": 20 - }, - { - "title": "Hot", - "__typename": "ScalarBucket", - "id": "Hot", - "count": 16 - }, - { - "title": "Mild", - "__typename": "ScalarBucket", - "id": "Mild", - "count": 17 - }, - { - "title": "Warm", - "__typename": "ScalarBucket", - "id": "Warm", - "count": 15 - }, - { - "title": "All-Weather", - "__typename": "ScalarBucket", - "id": "All-Weather", - "count": 10 - }, - { - "title": "Spring", - "__typename": "ScalarBucket", - "id": "Spring", - "count": 7 - }, - { - "title": "Cool", - "__typename": "ScalarBucket", - "id": "Cool", - "count": 3 - } - ] - }, - { - "attribute": "size", - "title": "Size", - "type": "POPULAR", - "buckets": [ - { - "title": "28", - "__typename": "ScalarBucket", - "id": "28", - "count": 25 - }, - { - "title": "29", - "__typename": "ScalarBucket", - "id": "29", - "count": 25 - }, - { - "title": "30", - "__typename": "ScalarBucket", - "id": "30", - "count": 7 - }, - { - "title": "31", - "__typename": "ScalarBucket", - "id": "31", - "count": 7 - }, - { - "title": "32", - "__typename": "ScalarBucket", - "id": "32", - "count": 7 - } - ] - }, - { - "attribute": "activity", - "title": "Activity", - "type": "POPULAR", - "buckets": [] - }, - { - "attribute": "custom_price", - "title": "Custom Price", - "type": "POPULAR", - "buckets": [] - } - ], - "items": [ - { - "product": { - "name": "Sahara Leggings", - "sku": "WP05" - } - }, - { - "product": { - "name": "Cora Parachute Pant", - "sku": "WP04" - } - }, - { - "product": { - "name": "Deirdre Relaxed-Fit Capri", - "sku": "WP12" - } - }, - { - "product": { - "name": "Gwen Drawstring Bike Short", - "sku": "WSH03" - } - }, - { - "product": { - "name": "Ina Compression Short", - "sku": "WSH11" - } - }, - { - "product": { - "name": "Diana Tights", - "sku": "WP06" - } - }, - { - "product": { - "name": "Erika Running Short", - "sku": "WSH12" - } - }, - { - "product": { - "name": "Artemis Running Short", - "sku": "WSH04" - } - }, - { - "product": { - "name": "Sybil Running Short", - "sku": "WSH08" - } - } - ], - "suggestions": [] - } -} -``` - -
- -### Catalog Service - -In the following example, the query returns information on the same products as the Live Search [`productSearch` items list](#items-list) example. However, it has been constructed to return item information inside the Catalog Service `productView` object instead of the core `product` object. Note that the pricing information varies, depending on the product type. For the sake of brevity, facet information is not shown. +The following example uses the `ProductView` object to return item information. Note that the pricing information varies, depending on the product type. For the sake of brevity, facet information is not shown. **Request:** @@ -1361,9 +952,25 @@ Field | Data Type | Description `items` | [[ProductSearchItem]](#productsearchitem-data-type) | An array of products returned by the query `page_info` | [SearchResultPageInfo](#searchresultpageinfo-data-type) | Contains information for rendering pages of search results `related_terms` | [String] | Reserved for future use -`suggestions` | [String] | An array of product URL keys that are similar to the search query. A maximum of five items are returned +`suggestions` | [String] | An array of product URL keys that are similar to the search query. A maximum of five items are returned. See **Logic used for `suggestions`** to learn more. `total_count` | Int | The total number of items returned +**Logic used for `suggestions`** + +- Data from name and category path fields are used. +- Name: `Supernova Sport Pant` will be stored in three phrases: + - `Supernova Sport Pant` + - `Sport Pant` + - `Pant` +- Category path: tokenized by /, so "products/electronics/mobiles-and-accessories" will be stored as: + - `products` + - `electronics` + - `mobiles-and-accessories` + +When a search is made, the "suggestion" field is searched using a "prefix" based search and the matching phrases are returned. + +**Example** - If "sport" is searched, then "sport pant" will be one suggestion. + #### Aggregation data type Field | Data Type | Description @@ -1432,7 +1039,9 @@ Field | Data Type | Description ### Live Search fields -Live Search returns product information using the [ProductInterface!](https://developer.adobe.com/commerce/webapi/graphql/schema/products/interfaces/attributes/). + + +By default, Live Search uses the `ProductInterface` to return product information. This interface is **deprecated**. Use the `ProductView` object, originally defined in Catalog Service, for better performance and future compatibility. ### Catalog Service fields diff --git a/src/pages/graphql/schema/orders/queries/guest-order-by-token.md b/src/pages/graphql/schema/orders/queries/guest-order-by-token.md index 0d9400806..e3787a5a5 100644 --- a/src/pages/graphql/schema/orders/queries/guest-order-by-token.md +++ b/src/pages/graphql/schema/orders/queries/guest-order-by-token.md @@ -13,7 +13,7 @@ You can retrieve the token from the `CustomerOrder` object on the [`placeOrder` ## Reference -The `guestOrderByToken` reference provides detailed information about the types and fields defined in this query. +The [`guestOrderByToken`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#query-guestOrderByToken) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/orders/queries/guest-order.md b/src/pages/graphql/schema/orders/queries/guest-order.md index 809242017..b2e5000f4 100644 --- a/src/pages/graphql/schema/orders/queries/guest-order.md +++ b/src/pages/graphql/schema/orders/queries/guest-order.md @@ -4,15 +4,15 @@ title: guestOrder query # guestOrder query -Use the `guestOrder` query to retrieve details about an order placed by a guest or customer who is not logged in. To retrieve this information, the guest must supply the order number, email, and postal code used to create the order. +Use the `guestOrder` query to retrieve details about an order placed by a guest or customer who is not logged in. To retrieve this information, the guest must supply the order number, email, and last name that was used to create the order. ## Syntax -`{guestOrder(input: OrderInformationInput!) {CustomerOrder!}}` +`{guestOrder(input: GuestOrderInformationInput!) {CustomerOrder!}}` ## Reference -The `guestOrder` reference provides detailed information about the types and fields defined in this query. +The [`guestOrder`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#query-guestOrder) reference provides detailed information about the types and fields defined in this query. ## Example usage @@ -24,7 +24,7 @@ The `guestOrder` reference provides detailed information about the types and fie input: { number: "000000001", email: "test@example.com", - postcode: "12345-6789" + lastname: "User" } ) { status diff --git a/src/pages/graphql/schema/uploads/index.md b/src/pages/graphql/schema/uploads/index.md new file mode 100644 index 000000000..6827548fe --- /dev/null +++ b/src/pages/graphql/schema/uploads/index.md @@ -0,0 +1,79 @@ +--- +title: Upload files to Amazon S3 +description: Learn how to manage file and image uploads using GraphQL mutations. +edition: saas +keywords: + - REST + - Integration +--- + +# Upload files to Amazon S3 + +Adobe Commerce as a Cloud Service (SaaS) supports file uploads through GraphQL mutations. This feature allows you to upload files such as images, documents, and other media to the server. [Sharing objects with presigned URLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ShareObjectPreSignedURL.html) describes how presigned URLs work. + +Uploading files is a multi-step process, as shown in the following diagram: + +![Upload files](../../../_images/upload-file.png) + +1. **Inititiate the upload**: The shopper clicks an **Upload File** button on the storefront. The Javascript code on the page uses the [`initiateUpload` mutation](./mutations/initiate-upload.md) to start the upload process. The mutation specifies the file name provided by the shopper. Commerce uses the AWS SDK to generate the URL to which the file will be uploaded. + +1. **Receive the response**: The response from the `initiateUpload` mutation includes a presigned URL, a unique key for the file, and an expiration time for the URL. The client code extracts these values from the response. + +1. **Upload the file**: The client code uses the presigned URL to upload the file directly to a temporary location in the Amazon S3 bucket. This is done using a standard HTTP PUT request. + + The following curl command demonstrates how to upload a file using the presigned URL: + + ```bash + curl --fail --show-error --silent -X PUT --data-binary @./cat.jpg 'https://.s3..amazonaws.com/?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=&X-Amz-Date=&X-Amz-SignedHeaders=host&X-Amz-Expires=&X-Amz-Signature=...' + ``` + +1. **Finalize the upload**: After the file is successfully uploaded to S3, the client code calls the [`finishUpload` mutation](./mutations/finish-upload.md) to complete the upload process. The mutation includes the unique key received from the `initiateUpload` response. + +1. **Perform validation**: Commerce uses a HEAD request on S3 Temporary to validate the key and size. + +1. **Move the file**: Commerce performs a `CopyObject` operation to move the file from the temporary location to a permanent location in the S3 bucket. + +1. **Receive the final response**: The response from the `finishUpload` mutation includes the unique key for the uploaded file. The client code extracts this key from the response. + +1. **Create or update the entity**: After `finishUpload` succeeds, the client creates or updates the entity (such as a customer) using the returned hashed key as the attribute value, not a URL or full S3 path. + +1. **Receive the create/update response**: The response from the create or update mutation includes the details of the created or updated entity. + +## Add the uploaded file to an entity + +Your Adobe Commerce instance must define a customer custom attribute that has an input type of `file` or `image`. Navigate to **Stores** > **Attributes** > **Customer** in the Admin and click **Add Attribute**. Your custom attribute must have the following properties: + +* **Attribute Code**: A unique identifier for the attribute, such as `profile_picture`. + +* **Input Type**: Set to **File (attachment)** or **Image file**. + +* **Maximum File Size**: The default file size limit on S3 is 16 MB (16777216 bytes). + +Once the custom attribute is created, you can use the key returned by the `finishUpload` mutation to set the value of the attribute when creating or updating a customer. For example, if the custom attribute code is `profile_picture`, you would include it in the input of the `createCustomerV2` mutation as follows: + +```graphql +mutation { + createCustomerV2( + input: { + email: "john.doe@example.com" + firstname: "John" + lastname: "Doe" + password: "wzB43LF4svFd" + custom_attributes: [ + { + attribute_code: "profile-picture" + value: "cat_106d42b2ee34de81db31d958.jpg" + } + ] + } + ) { + customer { + email + firstname + lastname + } + } + } +``` + +[Attribute interfaces and implementations](../attributes/interfaces/index.md) provides an example of how to retrieve a file uploaded to Amazon S3. diff --git a/src/pages/graphql/schema/uploads/mutations/finish-upload.md b/src/pages/graphql/schema/uploads/mutations/finish-upload.md new file mode 100644 index 000000000..c6bd7d26d --- /dev/null +++ b/src/pages/graphql/schema/uploads/mutations/finish-upload.md @@ -0,0 +1,103 @@ +--- +title: finishUpload mutation +edition: saas +keywords: + - REST + - Integration +--- + +# finishUpload mutation + +The `finishUpload` mutation completes the file upload process initiated by the [`initiateUpload` mutation](initiate-upload.md). The `finishUpload` mutation requires the unique key generated during the initiation step as an input parameter. This key identifies the file that was uploaded to the Amazon S3 bucket. + +When you call this mutation, Commerce verifies that the file associated with the provided key has been successfully uploaded to the S3 bucket. If the upload is confirmed, Commerce finalizes the upload process and makes the file available for use within the system. The response from the `finishUpload` mutation includes the unique key for the uploaded file. Use this key to reference the file in subsequent operations, such as associating it with a customer file or image attribute. + +## Syntax + +```graphql +mutation { + finishUpload(input: finishUploadInput!): finishUploadOutput +} +``` + +## Reference + +The [`finishUpload`](https://developer.adobe.com/commerce/webapi/graphql-api/saas/index.html#mutation-finishUpload) reference provides detailed information about the types and fields defined in this mutation. + +## Example usage + +The following examples show how to finalize an upload for different types of files. + +### Finalize an upload for a customer attribute file + +The following mutation finalize an upload for a file with a key value of `cat_106d42b2ee34de81db31d958.jpg`. + +**Request:** + +```graphql +mutation Finish($input: finishUploadInput!) { + finishUpload(input: $input) { + success + key + message + } +} +``` + +The `$input` variable contains: + +```json +{ + "input": { + "key": "cat_106d42b2ee34de81db31d958.jpg", + "media_resource_type": "CUSTOMER_ATTRIBUTE_FILE" + } +} +``` + +**Response:** + +```json +{ + "data": { + "finishUpload": { + "success": true, + "key": "cat_106d42b2ee34de81db31d958.jpg", + "message": "Upload completed successfully." + } + } +} +``` + +### Finalize an upload for a negotiable quote attachment + +The following mutation finalizes an upload for a file with a key value of `test-document1_32cb1fe50dab390be841461e.txt`. + +**Request:** + +```graphql +mutation { + finishUpload(input: { + key: "test-document1_32cb1fe50dab390be841461e.txt", + media_resource_type: "NEGOTIABLE_QUOTE_ATTACHMENT" + }) { + success + key + message + } +} +``` + +**Response:** + +```json +{ + "data": { + "finishUploadOutput": { + "success": true, + "key": "test-document1_32cb1fe50dab390be841461e.txt", + "message": "File upload confirmed successfully." + } + } +} +``` diff --git a/src/pages/graphql/schema/uploads/mutations/initiate-upload.md b/src/pages/graphql/schema/uploads/mutations/initiate-upload.md new file mode 100644 index 000000000..cc08e33d5 --- /dev/null +++ b/src/pages/graphql/schema/uploads/mutations/initiate-upload.md @@ -0,0 +1,115 @@ +--- +title: initiateUpload mutation +edition: saas +keywords: + - REST + - Integration +--- + +# initiateUpload mutation + +The `initiateUpload` mutation starts the file upload process by generating a presigned URL for uploading a file to an Amazon S3 bucket. This mutation requires the file name (`key`) and media resource type (`media_resource_type`) as input parameters. The `key` value cannot contain slashes. The following media resource types are supported: + +* `CUSTOMER_ATTRIBUTE_ADDRESS_FILE` +* `CUSTOMER_ATTRIBUTE_ADDRESS_IMAGE` +* `CUSTOMER_ATTRIBUTE_FILE` +* `CUSTOMER_ATTRIBUTE_IMAGE` +* `NEGOTIABLE_QUOTE_ATTACHMENT` + +When you call this mutation, Commerce uses the AWS SDK to create a presigned URL that allows the client to upload the file directly to a temporary location in the S3 bucket. The presigned URL is valid for a limited time, specified by the `expires_at` field in the response. + +The response includes the presigned URL, a unique key for the file, and an expiration time for the URL. The `key` is a hashed value that uniquely identifies the file in the S3 bucket. The client uses the presigned URL to upload the file using a standard HTTP PUT request. + +Use the `upload_url` from the response to PUT the file directly to S3. See [Upload files to Amazon S3](../index.md) for an example curl. + +After the file is successfully uploaded, use the [`finishUpload` mutation](finish-upload.md) to complete the upload process. + +## Syntax + +```graphql +mutation { + initiateUpload(input: initiateUploadInput!): initiateUploadOutput +} +``` + +## Reference + +The [`initiateUpload`](https://developer.adobe.com/commerce/webapi/graphql-api/saas/index.html#mutation-initiateUpload) reference provides detailed information about the types and fields defined in this mutation. + +## Example usage + +The following examples show how to initiate an upload different types of files. + +### Initiate an upload for a customer attribute file + +The following mutation initiates an upload for a file named `example.png`. + +**Request:** + +```graphql +mutation Initiate($input: initiateUploadInput!) { + initiateUpload(input: $input) { + upload_url + key + expires_at + } +} +``` + +The `$input` variable contains: + +```json +{ + "input": { + "key": "example.png", + "media_resource_type": "CUSTOMER_ATTRIBUTE_FILE" + } +} +``` + +**Response:** + +```json +{ + "data": { + "initiateUploadOutput": { + "upload_url": "https://.s3..amazonaws.com/?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...", + "key": "customer/attribute/", + "expires_at": "2024-09-30T12:34:56Z" + } + } +} +``` + +### Initiate an upload for a negotiable quote attachment + +The following mutation initiates an upload for a file named `test-document1.txt`. + +**Request:** + +```graphql +mutation { + initiateUpload(input: { + key: "test-document1.txt", + media_resource_type: NEGOTIABLE_QUOTE_ATTACHMENT + }) { + upload_url + key + expires_at + } +} +``` + +**Response:** + +```json +{ + "data": { + "initiateUpload": { + "upload_url": "http://s3mock:9000/bucket1-presigned/tenant1/test-document1_32cb1fe50dab390be841461e.txt?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20250909%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250909T160343Z&X-Amz-SignedHeaders=host&X-Amz-Expires=6600&X-Amz-Signature=5bc33cbdb2c93680a64dd9ef49d62ef34250faaafae1c6b0c17ac493f65b112d", + "key": "test-document1_32cb1fe50dab390be841461e.txt", + "expires_at": "1757440423" + } + } +} +``` diff --git a/src/pages/graphql/usage/protected-mutations.md b/src/pages/graphql/usage/protected-mutations.md index 034990a7d..4e39a8ba8 100644 --- a/src/pages/graphql/usage/protected-mutations.md +++ b/src/pages/graphql/usage/protected-mutations.md @@ -44,7 +44,7 @@ The following table lists the forms and mutations that can be configured to requ Field name | Mutation --- | --- -Enable for Customer Login | `generateCustomerToken` +Enable for Customer Login | `generateCustomerToken`,
`exchangeOtpForCustomerToken` Enable for Forgot Password | `changeCustomerPassword` Enable for Create New Customer Account | `createCustomer`, `createCustomerV2` Enable for Edit Customer Account | `updateCustomer`, `updateCustomerV2` diff --git a/src/pages/reference/graphql/2.4.9-beta-1/index.md b/src/pages/reference/graphql/2.4.9-beta-1/index.md new file mode 100644 index 000000000..479d98544 --- /dev/null +++ b/src/pages/reference/graphql/2.4.9-beta-1/index.md @@ -0,0 +1,8 @@ +--- +title: GraphQL API reference (2.4.9-beta-1) +description: Review comprehensive reference documentation for older Adobe Commerce GraphQL API schemas. +keywords: + - GraphQL +edition: paas +frameSrc: /graphql-api/2.4.9-beta-1/index.html +--- diff --git a/src/pages/rest/index.md b/src/pages/rest/index.md index 21349092c..1782a4ed4 100644 --- a/src/pages/rest/index.md +++ b/src/pages/rest/index.md @@ -21,7 +21,7 @@ The APIs can be used to perform a wide array of tasks. For example: -[Adobe Commerce on Cloud](https://experienceleague.adobe.com/en/docs/commerce-on-cloud/user-guide/overview?lang=en), Adobe Commerce on-premises, and [Magento Open Source](https://experienceleague.adobe.com/docs/magento-open-source/user-guide/overview/overview.html?lang=en) all use the same REST API framework. The REST API documentation describes the REST APIs that are available in these versions of Adobe Commerce and Magento Open Source. +[Adobe Commerce on Cloud](https://experienceleague.adobe.com/en/docs/commerce-on-cloud/user-guide/overview?lang=en), Adobe Commerce on-premises, and [Magento Open Source](https://experienceleague.adobe.com/en/docs/commerce-admin/start/guide-overview) all use the same REST API framework. The REST API documentation describes the REST APIs that are available in these versions of Adobe Commerce and Magento Open Source. ### Endpoints @@ -53,7 +53,7 @@ The following key differences are important to consider when planning your REST Primarily the Cloud Service REST API differs in that it includes a smaller subset of endpoints. Specifically, the customer and guest REST APIs that are available in Adobe Commerce on Cloud and on-premises deployments are not available in Adobe Commerce as a Cloud Service. However, access to similar functionality remains available with the [GraphQL APIs](../graphql/index.md). -The [API reference](../reference/rest/saas.md) lists the available endpoints. --> +The [API reference](../reference/rest/saas.md) lists the available endpoints. ### Authentication @@ -63,8 +63,27 @@ The authentication system supports both [interactive user-based workflows](./aut ### URL structure -The URL structure for your REST endpoints will be slightly different in Adobe Commerce as a Cloud Service. In addition to your base URL changing, the route no longer contains the string `/rest`, nor does it contain the store view code. The store view code is specified in the `Store` header of the request. +In Adobe Commerce as a Cloud Service, REST endpoint URLs do not include `/rest` or the store view code. The store scope is specified via the `Store` HTTP header. -Cloud Service URLs use the following format: +* Base format: -`https://.api.commerce.adobe.com//` + `https://.api.commerce.adobe.com//` + +* Set the scope with the `Store` header: + + * Predefined values: + + * `Store: all` — Execute in the global scope + * `Store: default` — Target the default store view (or use your specific store view code) + + * You can also pass any specific store view code: `Store: ` + +The following `curl` command shows the request pattern: + +```bash +curl --location 'https://.api.commerce.adobe.com//' \ + --header 'Authorization: Bearer ' \ + --header 'Content-Type: application/json' \ + --header 'Store: >' + .... +``` diff --git a/src/pages/rest/modules/custom-attributes.md b/src/pages/rest/modules/custom-attributes.md index f2e3e2adb..ffb0dc8f3 100644 --- a/src/pages/rest/modules/custom-attributes.md +++ b/src/pages/rest/modules/custom-attributes.md @@ -31,7 +31,7 @@ Adobe Commerce as a Cloud Service does not support REST endpoints that modify th When the quote is converted to an order, the custom attributes are copied to the order. -The following example shows how to set custom attributes on a cart. The `quote` object contains the `custom_attributes` array, which includes the custom attributes to set. +The following example shows how to set custom attributes on a cart when assigning a customer to a cart. The `quote` object contains the `custom_attributes` array, which includes the custom attributes to set. ```curl curl -i -X PUT \ @@ -56,10 +56,33 @@ curl -i -X PUT \ ] } }' \ - 'https:///rest/all/V1/carts/' + 'https:///rest/all/V1/carts/{cartId}' ``` -A quote item with custom attributes can be added/updated using `PUT /V1/carts/{cartId}/items/:itemId`. +The `POST /V1/carts/{cartId}/customAttributes` endpoint allows you to set or update custom attributes on already existing carts. The request body must include the `cart_id` and an array of `custom_attributes`. + +```curl +curl -i -X POST \ + -H "Content-Type:application/json" \ + -H "Authorization:Bearer " \ + -d \ +'{ + "cart_id": "20", + "custom_attributes":[ + { + "attribute_code": "attr_one", + "value": "value_one" + }, + { + "attribute_code": "attr_two", + "value": "value_two" + } + ] +}' \ + 'https:///rest/all/V1/carts/{cartId}/customAttributes' +``` + +A quote item with custom attributes can be added/updated using `PUT /V1/carts/{cartId}/items/{itemId}`. ```curl curl -i -X PUT \ @@ -115,7 +138,7 @@ curl -i -X POST \ ### Creditmemo -You can use the `POST V1/creditmemo` and `PUT V1/creditmemo/:id` endpoints to set custom attributes on a credit memo and its items. +You can use the `POST V1/creditmemo` and `PUT V1/creditmemo/{id}` endpoints to set custom attributes on a credit memo and its items. ```curl curl -i -X POST \ @@ -204,7 +227,7 @@ curl -i -X POST \ ### Order -The following example uses the `POST V1/order` endpoint to set custom attributes on an order. +The following example uses the `POST V1/orders` endpoint to set custom attributes on an order. ```curl curl -i -X POST \ @@ -229,7 +252,7 @@ curl -i -X POST \ 'https:///rest/all/V1/orders' ``` -If an order item has custom attributes, they will be returned as part of the order item object in responses to requests like `GET /V1/order/items/{id}`. +If an order item has custom attributes, they will be returned as part of the order item object in responses to requests like `GET /V1/orders/items/{id}`. ### Negotiable Quote diff --git a/src/pages/rest/modules/import/index.md b/src/pages/rest/modules/import/index.md index e4df0430c..6bfaa0a23 100644 --- a/src/pages/rest/modules/import/index.md +++ b/src/pages/rest/modules/import/index.md @@ -222,7 +222,7 @@ POST /rest//V1/import/json "allowed_error_count": 0, "items": [ { - "sku": "Simple Product 1", + "sku": "Simple-Product-1", "store_view_code": "", "attribute_set_code": "Default", "product_type": "simple", @@ -394,7 +394,7 @@ POST /rest//V1/import/json "configurable_variation_labels": "" }, { - "sku": "Simple Product 2", + "sku": "Simple-Product-2", "_comment": "additional information for Simple Product 2" } ], @@ -485,7 +485,7 @@ For a bundle product: "name": "Stasis Ball", "type": "select", "required": 1, - "sku": "Sprite Statis Ball 55mm", + "sku": "Sprite-Statis-Ball-55mm", "price": 7.99, "default": 0, "default_qty": 1, @@ -496,7 +496,7 @@ For a bundle product: "name": "Stasis Ball", "type": "select", "required": 1, - "sku": "Sprite Statis Ball 65mm", + "sku": "Sprite-Statis-Ball-65mm", "price": 9.99, "default": 0, "default_qty": 1, @@ -507,7 +507,7 @@ For a bundle product: "name": "Yoga Brick", "type": "checkbox", "required": 0, - "sku": "Sprite Foam Yoga Brick", + "sku": "Sprite-Foam-Yoga-Brick", "price": 25, "default": 0, "default_qty": 1, @@ -668,7 +668,7 @@ The Import JSON API does not create attributes automatically. You need to create "allowed_error_count": 10, "items": [ { - "sku": "Simple Product 1", + "sku": "Simple-Product-1", "tier_price_website": "All Websites [USD]", "tier_price_customer_group": "ALL GROUPS", "tier_price_qty": 1, @@ -676,7 +676,7 @@ The Import JSON API does not create attributes automatically. You need to create "tier_price_value_type": "Fixed" }, { - "sku": "Simple Product 1", + "sku": "Simple-Product-1", "tier_price_website": "base", "tier_price_customer_group": "NOT LOGGED IN", "tier_price_qty": 2, @@ -684,7 +684,7 @@ The Import JSON API does not create attributes automatically. You need to create "tier_price_value_type": "Discount" }, { - "sku": "Simple Product 1", + "sku": "Simple-Product-1", "tier_price_website": "french", "tier_price_customer_group": "General", "tier_price_qty": 5, diff --git a/src/pages/rest/modules/index.md b/src/pages/rest/modules/index.md index 26ac82b85..c6900ac97 100644 --- a/src/pages/rest/modules/index.md +++ b/src/pages/rest/modules/index.md @@ -13,3 +13,4 @@ Review the following modules to learn more about the REST API: - [Custom attributes module](./custom-attributes.md/) - [ImportCsvApi module](./import/) - [Sales module](./sales/) +- [S3 Uploads module](./s3-uploads/) diff --git a/src/pages/rest/modules/s3-uploads/index.md b/src/pages/rest/modules/s3-uploads/index.md new file mode 100644 index 000000000..bb3ad1441 --- /dev/null +++ b/src/pages/rest/modules/s3-uploads/index.md @@ -0,0 +1,112 @@ +--- +title: Upload files to Amazon S3 +description: Learn how to manage file and image uploads using REST. +edition: saas +keywords: + - REST + - Integration +--- + +# Upload files to Amazon S3 + +Adobe Commerce as a Cloud Service (SaaS) supports file uploads through REST endpoints. This feature allows you to upload images to Amazon Simple Storage Service (S3). [Sharing objects with presigned URLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ShareObjectPreSignedURL.html) describes how presigned URLs work. + +Uploading files is a multi-step process, as shown in the following diagram: + +![Upload files](../../../_images/upload-file.png) + +1. **Initiate the upload**: The shopper clicks an **Upload File** button on the storefront. The JavaScript code on the page uses the `POST V1/media/initiate-upload` endpoint to start the upload process. The call specifies the file name provided by the shopper. Commerce uses the AWS SDK to generate the URL to which the file will be uploaded. + +1. **Receive the response**: The response from the `initiate-upload` call includes a presigned URL, a unique key for the file, and an expiration time for the URL. The client code extracts these values from the response. + +1. **Upload the file**: The client code uses the presigned URL to upload the file directly to an Amazon S3 bucket. This is done using a standard HTTP PUT request. The file is uploaded to a temporary location in the S3 bucket. [](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) + +1. **Finalize the upload**: After the file is successfully uploaded to S3, the client code calls the `POST V1/media/finish-upload` endpoint to complete the upload process. The mutation includes the unique key received from the `initiate-upload` response. + +1. **Perform validation**: Commerce uses a HEAD request on S3 Temporary to validate the key and size. + +1. **Move the file**: Commerce performs a `CopyObject` operation to move the file from the temporary location to a permanent location in the S3 bucket. + +1. **Receive the final response**: The response from the `POST V1/media/finish-upload` endpoint includes the unique key for the uploaded file. The client code extracts this key from the response. + +1. **Create or update the entity**: After `POST V1/media/finish-upload` succeeds, the client creates or updates the entity (such as a category image) using the returned hashed key as the attribute value, not a URL or full S3 path. + +1. **Receive the create/update response**: The response from the create or update call includes the details of the created or updated entity. + +## Initiate the upload + +Use the `POST V1/media/initiate-upload` endpoint to start the file upload process by generating a presigned URL for uploading a file to an Amazon S3 bucket. This endpoint requires the file name (`key`) and media resource type (`media_resource_type`) as input parameters. The `key` value cannot contain slashes. The following media resource type are supported: + +* `CATEGORY_IMAGE` +* `CUSTOMER_ATTRIBUTE_ADDRESS_FILE` +* `CUSTOMER_ATTRIBUTE_ADDRESS_IMAGE` +* `CUSTOMER_ATTRIBUTE_FILE` +* `CUSTOMER_ATTRIBUTE_IMAGE` +* `NEGOTIABLE_QUOTE_ATTACHMENT` + +When you call this endpoint, Commerce uses the AWS SDK to create a presigned URL that allows the client to upload the file directly to a temporary location in the S3 bucket. The presigned URL is valid for a limited time, specified by the `expires_at` field in the response. + +The call requires an IMS access token. + +```bash +curl --request POST \ + --url https://.commerce.adobe.com//V1/media/initiate-upload \ + --header 'Authorization: Bearer ' \ + --header 'Content-Type: application/json' \ + --data '{ + "key": "1.png", + "media_resource_type": "CATEGORY_IMAGE" +}' +``` + +## Upload the file to S3 + +The following curl command demonstrates how to upload a file using the presigned URL returned by the `POST V1/media/initiate-upload` call: + +```bash + curl --fail --show-error --silent -X PUT --data-binary @./cat.jpg 'https://.s3..amazonaws.com/?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=&X-Amz-Date=&X-Amz-SignedHeaders=host&X-Amz-Expires=&X-Amz-Signature=...' +``` + +## Finish the upload + +Use the `POST V1/media/finish-upload` endpoint to complete the upload process after the file is successfully uploaded to S3. This endpoint includes the unique key received from the `initiate-upload` response. + +When you call this endpoint, Commerce verifies that the file associated with the provided key has been successfully uploaded to the S3 bucket. If the upload is confirmed, Commerce finalizes the upload process and makes the file available for use within the system. The response from the `finish-upload` endpoint includes the unique key for the uploaded file. This key can be used to reference the file in subsequent operations, such as associating it with a category image attribute. + +```bash +curl --request POST \ + --url https://server.commerce.adobe.com//V1/media/finish-upload \ + --header 'Authorization: Bearer ' \ + --header 'Content-Type: application/json' \ + --data '{ + "key": "", + "media_resource_type": "CATEGORY_IMAGE" + } +``` + +## Add the uploaded file to an entity + +Your Adobe Commerce instance must define the target attribute. For REST (CATEGORY_IMAGE), assign the returned key to the category image attribute when creating the category. + +Example: + +```json +{ + "category": { + "parent_id": "2", + "name": "One", + "is_active": true, + "include_in_menu": true, + "custom_attributes": [ + { + "attribute_code": "image", + "value": "1_7aa0b2d63f6d3dbf0290bb31.png" + }, + { + "attribute_code": "description", + "value": "

test description one<\/p>" + } + ] + } +} +``` diff --git a/src/pages/rest/tutorials/bulk-configurable-product/index.md b/src/pages/rest/tutorials/bulk-configurable-product/index.md index 5bcfaaea3..3317ffcbd 100644 --- a/src/pages/rest/tutorials/bulk-configurable-product/index.md +++ b/src/pages/rest/tutorials/bulk-configurable-product/index.md @@ -26,6 +26,6 @@ A system integrator can use Adobe Commerce REST bulk APIs to perform actions on ### Other resources -* [REST Tutorials](/rest/tutorials/index/) provides additional information about completing any Commerce REST tutorial. +* [REST Tutorials](../index.md) provides additional information about completing any Commerce REST tutorial. * [Asynchronous web endpoints](/rest/use-rest/asynchronous-web-endpoints/) provides information about how to use the Commerce Asynchronous API * [Bulk endpoints](/rest/use-rest/bulk-endpoints/) provides information about how to use the Commerce Bulk API diff --git a/src/pages/rest/tutorials/configurable-product/index.md b/src/pages/rest/tutorials/configurable-product/index.md index 4b2052cdf..c3abf87fb 100644 --- a/src/pages/rest/tutorials/configurable-product/index.md +++ b/src/pages/rest/tutorials/configurable-product/index.md @@ -25,4 +25,4 @@ This **5-step tutorial** generally takes **45 minutes**. ### Other resources -* [REST Tutorials](/rest/tutorials/index/) provides additional information about completing any Commerce REST tutorial. +* [REST Tutorials](../index.md) provides additional information about completing any Commerce REST tutorial. diff --git a/src/pages/rest/tutorials/grouped-product/index.md b/src/pages/rest/tutorials/grouped-product/index.md index e55a54b87..cb8ddba66 100644 --- a/src/pages/rest/tutorials/grouped-product/index.md +++ b/src/pages/rest/tutorials/grouped-product/index.md @@ -21,7 +21,7 @@ This tutorial describes how you can use the Adobe Commerce REST API to create an ### Other resources -* [REST Tutorials](/rest/tutorials/index/) provides additional information about completing any Commerce REST tutorial. +* [REST Tutorials](../index.md) provides additional information about completing any Commerce REST tutorial. ## 1. Create an empty grouped product diff --git a/src/pages/rest/tutorials/orders/index.md b/src/pages/rest/tutorials/orders/index.md index 63bcb0d56..4f6fb7bd5 100644 --- a/src/pages/rest/tutorials/orders/index.md +++ b/src/pages/rest/tutorials/orders/index.md @@ -33,4 +33,4 @@ Complete the following prerequisites: ### Other resources -* [REST Tutorials](/rest/tutorials/index/) provides additional information about completing any Commerce REST tutorial. +* [REST Tutorials](../index.md) provides additional information about completing any Commerce REST tutorial. diff --git a/src/pages/rest/use-rest/bulk-endpoints.md b/src/pages/rest/use-rest/bulk-endpoints.md index b2d397c8d..68f3e4a71 100644 --- a/src/pages/rest/use-rest/bulk-endpoints.md +++ b/src/pages/rest/use-rest/bulk-endpoints.md @@ -160,7 +160,7 @@ DELETE /async/bulk/V1/cmsPage/byPageId ## Store scopes - + You can specify a store code (which is labeled in the Admin as store view code) in the route of an asynchronous endpoint so that it operates on a specific store, as shown below: @@ -180,7 +180,7 @@ PUT /all/async/bulk/V1/products/bySku ## Fallback and creating/updating objects when setting store scopes - + When you create or update an object, such as a product, you can specify the store code in the request. If you do not specify a store code, Commerce uses the default store scope. The following rules apply when you create or update an object, such as a product. diff --git a/static/graphql-api/2.4.9-beta-1/index.html b/static/graphql-api/2.4.9-beta-1/index.html new file mode 100644 index 000000000..c87093e08 --- /dev/null +++ b/static/graphql-api/2.4.9-beta-1/index.html @@ -0,0 +1,81609 @@ + + + + + + GraphQL API + + + + +

+ +
+
+ +
+
+

Adobe Commerce GraphQL API (2.4.9-beta-1)

+
+
+
+

The Adobe Commerce GraphQL API allows you to quickly and efficiently transfer information between your Commerce store and your storefront. The schema documented here is autogenerated from an instance of Adobe Commerce with B2B. You can find examples of each query and mutation in the main GraphQL documentation.

+
+
+
+
API Endpoints
+ 
https://<your store>/graphql
+
+
+
Version
+

2.4.9-beta-1

+
+
+
+
+

Queries

+
+

+ attributesForm +

+
+
+
+
Description
+

Retrieve EAV attributes associated to a frontend form. Use countries query provided by DirectoryGraphQl module to retrieve region_id and country_id attribute options.

+
+
+
+
+
+
+
Response
+

Returns an AttributesFormOutput! +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ formCode - String! + Form code.
+
+
+
+

Example

+
+
Query
+ 
query attributesForm($formCode: String!) {
+  attributesForm(formCode: $formCode) {
+    errors {
+      ...AttributeMetadataErrorFragment
+    }
+    items {
+      ...CustomAttributeMetadataInterfaceFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"formCode": "abc123"}
+
+
+
+
Response
+ 
{
+  "data": {
+    "attributesForm": {
+      "errors": [AttributeMetadataError],
+      "items": [CustomAttributeMetadataInterface]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ attributesList +

+
+
+
+
Description
+

Returns a list of attributes metadata for a given entity type.

+
+
+
+
+
+
+
Response
+

Returns an AttributesMetadataOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ entityType - AttributeEntityTypeEnum! + Entity type.
+ filters - AttributeFilterInput + Identifies which filter inputs to search for and return.
+
+
+
+

Example

+
+
Query
+ 
query attributesList(
+  $entityType: AttributeEntityTypeEnum!,
+  $filters: AttributeFilterInput
+) {
+  attributesList(
+    entityType: $entityType,
+    filters: $filters
+  ) {
+    errors {
+      ...AttributeMetadataErrorFragment
+    }
+    items {
+      ...CustomAttributeMetadataInterfaceFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{
+  "entityType": "CATALOG_PRODUCT",
+  "filters": AttributeFilterInput
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "attributesList": {
+      "errors": [AttributeMetadataError],
+      "items": [CustomAttributeMetadataInterface]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ availableStores +

+
+
+
+
Description
+

Get a list of available store views and their config information.

+
+
+
+
+
+
+
Response
+

Returns [StoreConfig] +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ useCurrentGroup - Boolean + Filter store views by the current store group.
+
+
+
+

Example

+
+
Query
+ 
query availableStores($useCurrentGroup: Boolean) {
+  availableStores(useCurrentGroup: $useCurrentGroup) {
+    absolute_footer
+    allow_gift_receipt
+    allow_gift_wrapping_on_order
+    allow_gift_wrapping_on_order_items
+    allow_guests_to_write_product_reviews
+    allow_items
+    allow_order
+    allow_printed_card
+    autocomplete_on_storefront
+    base_currency_code
+    base_link_url
+    base_media_url
+    base_static_url
+    base_url
+    braintree_3dsecure_allowspecific
+    braintree_3dsecure_always_request_3ds
+    braintree_3dsecure_specificcountry
+    braintree_3dsecure_threshold_amount
+    braintree_3dsecure_verify_3dsecure
+    braintree_ach_direct_debit_vault_active
+    braintree_applepay_merchant_name
+    braintree_applepay_vault_active
+    braintree_cc_vault_active
+    braintree_cc_vault_cvv
+    braintree_environment
+    braintree_googlepay_btn_color
+    braintree_googlepay_cctypes
+    braintree_googlepay_merchant_id
+    braintree_googlepay_vault_active
+    braintree_local_payment_allowed_methods
+    braintree_local_payment_fallback_button_text
+    braintree_local_payment_redirect_on_fail
+    braintree_merchant_account_id
+    braintree_paypal_button_location_cart_type_credit_color
+    braintree_paypal_button_location_cart_type_credit_label
+    braintree_paypal_button_location_cart_type_credit_shape
+    braintree_paypal_button_location_cart_type_credit_show
+    braintree_paypal_button_location_cart_type_messaging_layout
+    braintree_paypal_button_location_cart_type_messaging_logo
+    braintree_paypal_button_location_cart_type_messaging_logo_position
+    braintree_paypal_button_location_cart_type_messaging_show
+    braintree_paypal_button_location_cart_type_messaging_text_color
+    braintree_paypal_button_location_cart_type_paylater_color
+    braintree_paypal_button_location_cart_type_paylater_label
+    braintree_paypal_button_location_cart_type_paylater_shape
+    braintree_paypal_button_location_cart_type_paylater_show
+    braintree_paypal_button_location_cart_type_paypal_color
+    braintree_paypal_button_location_cart_type_paypal_label
+    braintree_paypal_button_location_cart_type_paypal_shape
+    braintree_paypal_button_location_cart_type_paypal_show
+    braintree_paypal_button_location_checkout_type_credit_color
+    braintree_paypal_button_location_checkout_type_credit_label
+    braintree_paypal_button_location_checkout_type_credit_shape
+    braintree_paypal_button_location_checkout_type_credit_show
+    braintree_paypal_button_location_checkout_type_messaging_layout
+    braintree_paypal_button_location_checkout_type_messaging_logo
+    braintree_paypal_button_location_checkout_type_messaging_logo_position
+    braintree_paypal_button_location_checkout_type_messaging_show
+    braintree_paypal_button_location_checkout_type_messaging_text_color
+    braintree_paypal_button_location_checkout_type_paylater_color
+    braintree_paypal_button_location_checkout_type_paylater_label
+    braintree_paypal_button_location_checkout_type_paylater_shape
+    braintree_paypal_button_location_checkout_type_paylater_show
+    braintree_paypal_button_location_checkout_type_paypal_color
+    braintree_paypal_button_location_checkout_type_paypal_label
+    braintree_paypal_button_location_checkout_type_paypal_shape
+    braintree_paypal_button_location_checkout_type_paypal_show
+    braintree_paypal_button_location_productpage_type_credit_color
+    braintree_paypal_button_location_productpage_type_credit_label
+    braintree_paypal_button_location_productpage_type_credit_shape
+    braintree_paypal_button_location_productpage_type_credit_show
+    braintree_paypal_button_location_productpage_type_messaging_layout
+    braintree_paypal_button_location_productpage_type_messaging_logo
+    braintree_paypal_button_location_productpage_type_messaging_logo_position
+    braintree_paypal_button_location_productpage_type_messaging_show
+    braintree_paypal_button_location_productpage_type_messaging_text_color
+    braintree_paypal_button_location_productpage_type_paylater_color
+    braintree_paypal_button_location_productpage_type_paylater_label
+    braintree_paypal_button_location_productpage_type_paylater_shape
+    braintree_paypal_button_location_productpage_type_paylater_show
+    braintree_paypal_button_location_productpage_type_paypal_color
+    braintree_paypal_button_location_productpage_type_paypal_label
+    braintree_paypal_button_location_productpage_type_paypal_shape
+    braintree_paypal_button_location_productpage_type_paypal_show
+    braintree_paypal_credit_uk_merchant_name
+    braintree_paypal_display_on_shopping_cart
+    braintree_paypal_merchant_country
+    braintree_paypal_merchant_name_override
+    braintree_paypal_require_billing_address
+    braintree_paypal_send_cart_line_items
+    braintree_paypal_vault_active
+    cart_expires_in_days
+    cart_gift_wrapping
+    cart_merge_preference
+    cart_printed_card
+    cart_summary_display_quantity
+    catalog_default_sort_by
+    category_fixed_product_tax_display_setting
+    category_url_suffix
+    check_money_order_enable_for_specific_countries
+    check_money_order_enabled
+    check_money_order_make_check_payable_to
+    check_money_order_max_order_total
+    check_money_order_min_order_total
+    check_money_order_new_order_status
+    check_money_order_payment_from_specific_countries
+    check_money_order_send_check_to
+    check_money_order_sort_order
+    check_money_order_title
+    cms_home_page
+    cms_no_cookies
+    cms_no_route
+    code
+    configurable_product_image
+    configurable_thumbnail_source
+    contact_enabled
+    copyright
+    countries_with_required_region
+    create_account_confirmation
+    customer_access_token_lifetime
+    default_country
+    default_description
+    default_display_currency_code
+    default_keywords
+    default_title
+    demonotice
+    display_product_prices_in_catalog
+    display_shipping_prices
+    display_state_if_optional
+    enable_multiple_wishlists
+    fixed_product_taxes_apply_tax_to_fpt
+    fixed_product_taxes_display_prices_in_emails
+    fixed_product_taxes_display_prices_in_product_lists
+    fixed_product_taxes_display_prices_in_sales_modules
+    fixed_product_taxes_display_prices_on_product_view_page
+    fixed_product_taxes_enable
+    fixed_product_taxes_include_fpt_in_subtotal
+    front
+    graphql_share_customer_group
+    grid_per_page
+    grid_per_page_values
+    grouped_product_image
+    head_includes
+    head_shortcut_icon
+    header_logo_src
+    id
+    is_checkout_agreements_enabled
+    is_default_store
+    is_default_store_group
+    is_guest_checkout_enabled
+    is_negotiable_quote_active
+    is_one_page_checkout_enabled
+    is_requisition_list_active
+    list_mode
+    list_per_page
+    list_per_page_values
+    locale
+    logo_alt
+    logo_height
+    logo_width
+    magento_reward_general_is_enabled
+    magento_reward_general_is_enabled_on_front
+    magento_reward_general_min_points_balance
+    magento_reward_general_publish_history
+    magento_reward_points_invitation_customer
+    magento_reward_points_invitation_customer_limit
+    magento_reward_points_invitation_order
+    magento_reward_points_invitation_order_limit
+    magento_reward_points_newsletter
+    magento_reward_points_order
+    magento_reward_points_register
+    magento_reward_points_review
+    magento_reward_points_review_limit
+    magento_wishlist_general_is_enabled
+    max_items_in_order_summary
+    maximum_number_of_wishlists
+    minicart_display
+    minicart_max_items
+    minimum_password_length
+    newsletter_enabled
+    no_route
+    optional_zip_countries
+    order_cancellation_enabled
+    order_cancellation_reasons {
+      ...CancellationReasonFragment
+    }
+    orders_invoices_credit_memos_display_full_summary
+    orders_invoices_credit_memos_display_grandtotal
+    orders_invoices_credit_memos_display_price
+    orders_invoices_credit_memos_display_shipping_amount
+    orders_invoices_credit_memos_display_subtotal
+    orders_invoices_credit_memos_display_zero_tax
+    payment_payflowpro_cc_vault_active
+    printed_card_price
+    printed_card_priceV2 {
+      ...MoneyFragment
+    }
+    product_fixed_product_tax_display_setting
+    product_reviews_enabled
+    product_url_suffix
+    quickorder_active
+    required_character_classes_number
+    returns_enabled
+    root_category_id
+    root_category_uid
+    sales_fixed_product_tax_display_setting
+    sales_gift_wrapping
+    sales_printed_card
+    secure_base_link_url
+    secure_base_media_url
+    secure_base_static_url
+    secure_base_url
+    send_friend {
+      ...SendFriendConfigurationFragment
+    }
+    share_active_segments
+    share_applied_cart_rule
+    shopping_cart_display_full_summary
+    shopping_cart_display_grand_total
+    shopping_cart_display_price
+    shopping_cart_display_shipping
+    shopping_cart_display_subtotal
+    shopping_cart_display_tax_gift_wrapping
+    shopping_cart_display_zero_tax
+    show_cms_breadcrumbs
+    store_code
+    store_group_code
+    store_group_name
+    store_name
+    store_sort_order
+    timezone
+    title_prefix
+    title_separator
+    title_suffix
+    use_store_in_url
+    website_code
+    website_id
+    website_name
+    weight_unit
+    welcome
+    zero_subtotal_enable_for_specific_countries
+    zero_subtotal_enabled
+    zero_subtotal_new_order_status
+    zero_subtotal_payment_action
+    zero_subtotal_payment_from_specific_countries
+    zero_subtotal_sort_order
+    zero_subtotal_title
+  }
+}
+
+
+
+
Variables
+ 
{"useCurrentGroup": true}
+
+
+
+
Response
+ 
{
+  "data": {
+    "availableStores": [
+      {
+        "absolute_footer": "xyz789",
+        "allow_gift_receipt": "abc123",
+        "allow_gift_wrapping_on_order": "xyz789",
+        "allow_gift_wrapping_on_order_items": "abc123",
+        "allow_guests_to_write_product_reviews": "xyz789",
+        "allow_items": "xyz789",
+        "allow_order": "abc123",
+        "allow_printed_card": "xyz789",
+        "autocomplete_on_storefront": false,
+        "base_currency_code": "xyz789",
+        "base_link_url": "xyz789",
+        "base_media_url": "abc123",
+        "base_static_url": "abc123",
+        "base_url": "xyz789",
+        "braintree_3dsecure_allowspecific": true,
+        "braintree_3dsecure_always_request_3ds": false,
+        "braintree_3dsecure_specificcountry": "abc123",
+        "braintree_3dsecure_threshold_amount": "xyz789",
+        "braintree_3dsecure_verify_3dsecure": false,
+        "braintree_ach_direct_debit_vault_active": false,
+        "braintree_applepay_merchant_name": "abc123",
+        "braintree_applepay_vault_active": false,
+        "braintree_cc_vault_active": "abc123",
+        "braintree_cc_vault_cvv": false,
+        "braintree_environment": "xyz789",
+        "braintree_googlepay_btn_color": "abc123",
+        "braintree_googlepay_cctypes": "xyz789",
+        "braintree_googlepay_merchant_id": "abc123",
+        "braintree_googlepay_vault_active": true,
+        "braintree_local_payment_allowed_methods": "abc123",
+        "braintree_local_payment_fallback_button_text": "abc123",
+        "braintree_local_payment_redirect_on_fail": "abc123",
+        "braintree_merchant_account_id": "xyz789",
+        "braintree_paypal_button_location_cart_type_credit_color": "xyz789",
+        "braintree_paypal_button_location_cart_type_credit_label": "abc123",
+        "braintree_paypal_button_location_cart_type_credit_shape": "xyz789",
+        "braintree_paypal_button_location_cart_type_credit_show": true,
+        "braintree_paypal_button_location_cart_type_messaging_layout": "xyz789",
+        "braintree_paypal_button_location_cart_type_messaging_logo": "xyz789",
+        "braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123",
+        "braintree_paypal_button_location_cart_type_messaging_show": true,
+        "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123",
+        "braintree_paypal_button_location_cart_type_paylater_color": "abc123",
+        "braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
+        "braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
+        "braintree_paypal_button_location_cart_type_paylater_show": true,
+        "braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
+        "braintree_paypal_button_location_cart_type_paypal_label": "xyz789",
+        "braintree_paypal_button_location_cart_type_paypal_shape": "abc123",
+        "braintree_paypal_button_location_cart_type_paypal_show": false,
+        "braintree_paypal_button_location_checkout_type_credit_color": "xyz789",
+        "braintree_paypal_button_location_checkout_type_credit_label": "abc123",
+        "braintree_paypal_button_location_checkout_type_credit_shape": "abc123",
+        "braintree_paypal_button_location_checkout_type_credit_show": false,
+        "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123",
+        "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789",
+        "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789",
+        "braintree_paypal_button_location_checkout_type_messaging_show": false,
+        "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123",
+        "braintree_paypal_button_location_checkout_type_paylater_color": "xyz789",
+        "braintree_paypal_button_location_checkout_type_paylater_label": "abc123",
+        "braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789",
+        "braintree_paypal_button_location_checkout_type_paylater_show": false,
+        "braintree_paypal_button_location_checkout_type_paypal_color": "abc123",
+        "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789",
+        "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789",
+        "braintree_paypal_button_location_checkout_type_paypal_show": true,
+        "braintree_paypal_button_location_productpage_type_credit_color": "abc123",
+        "braintree_paypal_button_location_productpage_type_credit_label": "xyz789",
+        "braintree_paypal_button_location_productpage_type_credit_shape": "abc123",
+        "braintree_paypal_button_location_productpage_type_credit_show": true,
+        "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789",
+        "braintree_paypal_button_location_productpage_type_messaging_logo": "xyz789",
+        "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789",
+        "braintree_paypal_button_location_productpage_type_messaging_show": false,
+        "braintree_paypal_button_location_productpage_type_messaging_text_color": "xyz789",
+        "braintree_paypal_button_location_productpage_type_paylater_color": "xyz789",
+        "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789",
+        "braintree_paypal_button_location_productpage_type_paylater_shape": "xyz789",
+        "braintree_paypal_button_location_productpage_type_paylater_show": false,
+        "braintree_paypal_button_location_productpage_type_paypal_color": "abc123",
+        "braintree_paypal_button_location_productpage_type_paypal_label": "abc123",
+        "braintree_paypal_button_location_productpage_type_paypal_shape": "abc123",
+        "braintree_paypal_button_location_productpage_type_paypal_show": true,
+        "braintree_paypal_credit_uk_merchant_name": "abc123",
+        "braintree_paypal_display_on_shopping_cart": false,
+        "braintree_paypal_merchant_country": "xyz789",
+        "braintree_paypal_merchant_name_override": "xyz789",
+        "braintree_paypal_require_billing_address": true,
+        "braintree_paypal_send_cart_line_items": false,
+        "braintree_paypal_vault_active": true,
+        "cart_expires_in_days": 987,
+        "cart_gift_wrapping": "abc123",
+        "cart_merge_preference": "xyz789",
+        "cart_printed_card": "abc123",
+        "cart_summary_display_quantity": 987,
+        "catalog_default_sort_by": "abc123",
+        "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
+        "category_url_suffix": "abc123",
+        "check_money_order_enable_for_specific_countries": false,
+        "check_money_order_enabled": true,
+        "check_money_order_make_check_payable_to": "xyz789",
+        "check_money_order_max_order_total": "abc123",
+        "check_money_order_min_order_total": "abc123",
+        "check_money_order_new_order_status": "abc123",
+        "check_money_order_payment_from_specific_countries": "abc123",
+        "check_money_order_send_check_to": "xyz789",
+        "check_money_order_sort_order": 123,
+        "check_money_order_title": "abc123",
+        "cms_home_page": "abc123",
+        "cms_no_cookies": "xyz789",
+        "cms_no_route": "abc123",
+        "code": "abc123",
+        "configurable_product_image": "ITSELF",
+        "configurable_thumbnail_source": "abc123",
+        "contact_enabled": true,
+        "copyright": "abc123",
+        "countries_with_required_region": "xyz789",
+        "create_account_confirmation": false,
+        "customer_access_token_lifetime": 123.45,
+        "default_country": "xyz789",
+        "default_description": "xyz789",
+        "default_display_currency_code": "abc123",
+        "default_keywords": "xyz789",
+        "default_title": "xyz789",
+        "demonotice": 123,
+        "display_product_prices_in_catalog": 987,
+        "display_shipping_prices": 987,
+        "display_state_if_optional": false,
+        "enable_multiple_wishlists": "xyz789",
+        "fixed_product_taxes_apply_tax_to_fpt": true,
+        "fixed_product_taxes_display_prices_in_emails": 987,
+        "fixed_product_taxes_display_prices_in_product_lists": 123,
+        "fixed_product_taxes_display_prices_in_sales_modules": 123,
+        "fixed_product_taxes_display_prices_on_product_view_page": 123,
+        "fixed_product_taxes_enable": true,
+        "fixed_product_taxes_include_fpt_in_subtotal": true,
+        "front": "xyz789",
+        "graphql_share_customer_group": false,
+        "grid_per_page": 987,
+        "grid_per_page_values": "abc123",
+        "grouped_product_image": "ITSELF",
+        "head_includes": "xyz789",
+        "head_shortcut_icon": "abc123",
+        "header_logo_src": "abc123",
+        "id": 987,
+        "is_checkout_agreements_enabled": false,
+        "is_default_store": false,
+        "is_default_store_group": false,
+        "is_guest_checkout_enabled": true,
+        "is_negotiable_quote_active": false,
+        "is_one_page_checkout_enabled": true,
+        "is_requisition_list_active": "xyz789",
+        "list_mode": "abc123",
+        "list_per_page": 987,
+        "list_per_page_values": "abc123",
+        "locale": "abc123",
+        "logo_alt": "xyz789",
+        "logo_height": 123,
+        "logo_width": 123,
+        "magento_reward_general_is_enabled": "abc123",
+        "magento_reward_general_is_enabled_on_front": "xyz789",
+        "magento_reward_general_min_points_balance": "abc123",
+        "magento_reward_general_publish_history": "abc123",
+        "magento_reward_points_invitation_customer": "xyz789",
+        "magento_reward_points_invitation_customer_limit": "abc123",
+        "magento_reward_points_invitation_order": "xyz789",
+        "magento_reward_points_invitation_order_limit": "xyz789",
+        "magento_reward_points_newsletter": "xyz789",
+        "magento_reward_points_order": "xyz789",
+        "magento_reward_points_register": "abc123",
+        "magento_reward_points_review": "xyz789",
+        "magento_reward_points_review_limit": "xyz789",
+        "magento_wishlist_general_is_enabled": "abc123",
+        "max_items_in_order_summary": 987,
+        "maximum_number_of_wishlists": "abc123",
+        "minicart_display": false,
+        "minicart_max_items": 987,
+        "minimum_password_length": "abc123",
+        "newsletter_enabled": false,
+        "no_route": "abc123",
+        "optional_zip_countries": "abc123",
+        "order_cancellation_enabled": false,
+        "order_cancellation_reasons": [
+          CancellationReason
+        ],
+        "orders_invoices_credit_memos_display_full_summary": false,
+        "orders_invoices_credit_memos_display_grandtotal": false,
+        "orders_invoices_credit_memos_display_price": 987,
+        "orders_invoices_credit_memos_display_shipping_amount": 987,
+        "orders_invoices_credit_memos_display_subtotal": 987,
+        "orders_invoices_credit_memos_display_zero_tax": false,
+        "payment_payflowpro_cc_vault_active": "abc123",
+        "printed_card_price": "xyz789",
+        "printed_card_priceV2": Money,
+        "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
+        "product_reviews_enabled": "xyz789",
+        "product_url_suffix": "xyz789",
+        "quickorder_active": true,
+        "required_character_classes_number": "xyz789",
+        "returns_enabled": "xyz789",
+        "root_category_id": 987,
+        "root_category_uid": "4",
+        "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
+        "sales_gift_wrapping": "xyz789",
+        "sales_printed_card": "abc123",
+        "secure_base_link_url": "abc123",
+        "secure_base_media_url": "abc123",
+        "secure_base_static_url": "xyz789",
+        "secure_base_url": "abc123",
+        "send_friend": SendFriendConfiguration,
+        "share_active_segments": true,
+        "share_applied_cart_rule": false,
+        "shopping_cart_display_full_summary": false,
+        "shopping_cart_display_grand_total": true,
+        "shopping_cart_display_price": 987,
+        "shopping_cart_display_shipping": 987,
+        "shopping_cart_display_subtotal": 987,
+        "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
+        "shopping_cart_display_zero_tax": false,
+        "show_cms_breadcrumbs": 123,
+        "store_code": 4,
+        "store_group_code": "4",
+        "store_group_name": "xyz789",
+        "store_name": "xyz789",
+        "store_sort_order": 987,
+        "timezone": "abc123",
+        "title_prefix": "xyz789",
+        "title_separator": "xyz789",
+        "title_suffix": "abc123",
+        "use_store_in_url": false,
+        "website_code": "4",
+        "website_id": 987,
+        "website_name": "xyz789",
+        "weight_unit": "xyz789",
+        "welcome": "xyz789",
+        "zero_subtotal_enable_for_specific_countries": true,
+        "zero_subtotal_enabled": true,
+        "zero_subtotal_new_order_status": "xyz789",
+        "zero_subtotal_payment_action": "abc123",
+        "zero_subtotal_payment_from_specific_countries": "xyz789",
+        "zero_subtotal_sort_order": 123,
+        "zero_subtotal_title": "abc123"
+      }
+    ]
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ cart +

+
+
+
+
Description
+

Return information about the specified shopping cart.

+
+
+
+
+
+
+
Response
+

Returns a Cart +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ cart_id - String! + The unique ID of the cart to query.
+
+
+
+

Example

+
+
Query
+ 
query cart($cart_id: String!) {
+  cart(cart_id: $cart_id) {
+    applied_coupon {
+      ...AppliedCouponFragment
+    }
+    applied_coupons {
+      ...AppliedCouponFragment
+    }
+    applied_gift_cards {
+      ...AppliedGiftCardFragment
+    }
+    applied_reward_points {
+      ...RewardPointsAmountFragment
+    }
+    applied_store_credit {
+      ...AppliedStoreCreditFragment
+    }
+    available_gift_wrappings {
+      ...GiftWrappingFragment
+    }
+    available_payment_methods {
+      ...AvailablePaymentMethodFragment
+    }
+    billing_address {
+      ...BillingCartAddressFragment
+    }
+    email
+    gift_message {
+      ...GiftMessageFragment
+    }
+    gift_receipt_included
+    gift_wrapping {
+      ...GiftWrappingFragment
+    }
+    id
+    is_virtual
+    items {
+      ...CartItemInterfaceFragment
+    }
+    itemsV2 {
+      ...CartItemsFragment
+    }
+    prices {
+      ...CartPricesFragment
+    }
+    printed_card_included
+    rules {
+      ...CartRuleStorefrontFragment
+    }
+    selected_payment_method {
+      ...SelectedPaymentMethodFragment
+    }
+    shipping_addresses {
+      ...ShippingCartAddressFragment
+    }
+    total_quantity
+  }
+}
+
+
+
+
Variables
+ 
{"cart_id": "abc123"}
+
+
+
+
Response
+ 
{
+  "data": {
+    "cart": {
+      "applied_coupon": AppliedCoupon,
+      "applied_coupons": [AppliedCoupon],
+      "applied_gift_cards": [AppliedGiftCard],
+      "applied_reward_points": RewardPointsAmount,
+      "applied_store_credit": AppliedStoreCredit,
+      "available_gift_wrappings": [GiftWrapping],
+      "available_payment_methods": [
+        AvailablePaymentMethod
+      ],
+      "billing_address": BillingCartAddress,
+      "email": "abc123",
+      "gift_message": GiftMessage,
+      "gift_receipt_included": true,
+      "gift_wrapping": GiftWrapping,
+      "id": "4",
+      "is_virtual": false,
+      "items": [CartItemInterface],
+      "itemsV2": CartItems,
+      "prices": CartPrices,
+      "printed_card_included": true,
+      "rules": [CartRuleStorefront],
+      "selected_payment_method": SelectedPaymentMethod,
+      "shipping_addresses": [ShippingCartAddress],
+      "total_quantity": 123.45
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ categories +

+
+
+
+
Description
+

Return a list of categories that match the specified filter.

+
+
+
+
+
+
+
Response
+

Returns a CategoryResult +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
+ filters - CategoryFilterInput + Identifies which Category filter inputs to search for and return.
+ pageSize - Int + Specifies the maximum number of results to return at once. The default value is 20. Default = 20
+ currentPage - Int + Specifies which page of results to return. The default value is 1. Default = 1
+
+
+
+

Example

+
+
Query
+ 
query categories(
+  $filters: CategoryFilterInput,
+  $pageSize: Int,
+  $currentPage: Int
+) {
+  categories(
+    filters: $filters,
+    pageSize: $pageSize,
+    currentPage: $currentPage
+  ) {
+    items {
+      ...CategoryTreeFragment
+    }
+    page_info {
+      ...SearchResultPageInfoFragment
+    }
+    total_count
+  }
+}
+
+
+
+
Variables
+ 
{
+  "filters": CategoryFilterInput,
+  "pageSize": 20,
+  "currentPage": 1
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "categories": {
+      "items": [CategoryTree],
+      "page_info": SearchResultPageInfo,
+      "total_count": 987
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ category +

+
+
+
+
Use categories instead.
+
+
+
+
+
+
+
Description
+

Search for categories that match the criteria specified in the search and filter attributes.

+
+
+
+
+
+
+
Response
+

Returns a CategoryTree +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ id - Int + The category ID to use as the root of the search.
+
+
+
+

Example

+
+
Query
+ 
query category($id: Int) {
+  category(id: $id) {
+    automatic_sorting
+    available_sort_by
+    breadcrumbs {
+      ...BreadcrumbFragment
+    }
+    canonical_url
+    children {
+      ...CategoryTreeFragment
+    }
+    children_count
+    cms_block {
+      ...CmsBlockFragment
+    }
+    created_at
+    custom_layout_update_file
+    default_sort_by
+    description
+    display_mode
+    filter_price_range
+    id
+    image
+    include_in_menu
+    is_anchor
+    landing_page
+    level
+    meta_description
+    meta_keywords
+    meta_title
+    name
+    path
+    path_in_store
+    position
+    product_count
+    products {
+      ...CategoryProductsFragment
+    }
+    redirect_code
+    relative_url
+    staged
+    type
+    uid
+    updated_at
+    url_key
+    url_path
+    url_suffix
+  }
+}
+
+
+
+
Variables
+ 
{"id": 987}
+
+
+
+
Response
+ 
{
+  "data": {
+    "category": {
+      "automatic_sorting": "xyz789",
+      "available_sort_by": ["abc123"],
+      "breadcrumbs": [Breadcrumb],
+      "canonical_url": "abc123",
+      "children": [CategoryTree],
+      "children_count": "abc123",
+      "cms_block": CmsBlock,
+      "created_at": "abc123",
+      "custom_layout_update_file": "abc123",
+      "default_sort_by": "xyz789",
+      "description": "abc123",
+      "display_mode": "xyz789",
+      "filter_price_range": 987.65,
+      "id": 987,
+      "image": "abc123",
+      "include_in_menu": 123,
+      "is_anchor": 987,
+      "landing_page": 987,
+      "level": 123,
+      "meta_description": "xyz789",
+      "meta_keywords": "xyz789",
+      "meta_title": "xyz789",
+      "name": "abc123",
+      "path": "abc123",
+      "path_in_store": "xyz789",
+      "position": 987,
+      "product_count": 987,
+      "products": CategoryProducts,
+      "redirect_code": 123,
+      "relative_url": "xyz789",
+      "staged": false,
+      "type": "CMS_PAGE",
+      "uid": "4",
+      "updated_at": "xyz789",
+      "url_key": "xyz789",
+      "url_path": "abc123",
+      "url_suffix": "abc123"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ categoryList +

+
+
+
+
Use categories instead.
+
+
+
+
+
+
+
Description
+

Return an array of categories based on the specified filters.

+
+
+
+
+
+
+
Response
+

Returns [CategoryTree] +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
+ filters - CategoryFilterInput + Identifies which Category filter inputs to search for and return.
+ pageSize - Int + Specifies the maximum number of results to return at once. The default value is 20. Default = 20
+ currentPage - Int + Specifies which page of results to return. The default value is 1. Default = 1
+
+
+
+

Example

+
+
Query
+ 
query categoryList(
+  $filters: CategoryFilterInput,
+  $pageSize: Int,
+  $currentPage: Int
+) {
+  categoryList(
+    filters: $filters,
+    pageSize: $pageSize,
+    currentPage: $currentPage
+  ) {
+    automatic_sorting
+    available_sort_by
+    breadcrumbs {
+      ...BreadcrumbFragment
+    }
+    canonical_url
+    children {
+      ...CategoryTreeFragment
+    }
+    children_count
+    cms_block {
+      ...CmsBlockFragment
+    }
+    created_at
+    custom_layout_update_file
+    default_sort_by
+    description
+    display_mode
+    filter_price_range
+    id
+    image
+    include_in_menu
+    is_anchor
+    landing_page
+    level
+    meta_description
+    meta_keywords
+    meta_title
+    name
+    path
+    path_in_store
+    position
+    product_count
+    products {
+      ...CategoryProductsFragment
+    }
+    redirect_code
+    relative_url
+    staged
+    type
+    uid
+    updated_at
+    url_key
+    url_path
+    url_suffix
+  }
+}
+
+
+
+
Variables
+ 
{
+  "filters": CategoryFilterInput,
+  "pageSize": 20,
+  "currentPage": 1
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "categoryList": [
+      {
+        "automatic_sorting": "xyz789",
+        "available_sort_by": ["abc123"],
+        "breadcrumbs": [Breadcrumb],
+        "canonical_url": "abc123",
+        "children": [CategoryTree],
+        "children_count": "xyz789",
+        "cms_block": CmsBlock,
+        "created_at": "abc123",
+        "custom_layout_update_file": "abc123",
+        "default_sort_by": "abc123",
+        "description": "xyz789",
+        "display_mode": "abc123",
+        "filter_price_range": 987.65,
+        "id": 987,
+        "image": "xyz789",
+        "include_in_menu": 987,
+        "is_anchor": 123,
+        "landing_page": 987,
+        "level": 987,
+        "meta_description": "abc123",
+        "meta_keywords": "abc123",
+        "meta_title": "abc123",
+        "name": "abc123",
+        "path": "xyz789",
+        "path_in_store": "xyz789",
+        "position": 123,
+        "product_count": 123,
+        "products": CategoryProducts,
+        "redirect_code": 123,
+        "relative_url": "abc123",
+        "staged": true,
+        "type": "CMS_PAGE",
+        "uid": "4",
+        "updated_at": "xyz789",
+        "url_key": "abc123",
+        "url_path": "abc123",
+        "url_suffix": "abc123"
+      }
+    ]
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ checkoutAgreements +

+
+
+
+
Description
+

Return Terms and Conditions configuration information.

+
+
+
+
+
+
+
Response
+

Returns [CheckoutAgreement] +

+
+
+
+

Example

+
+
Query
+ 
query checkoutAgreements {
+  checkoutAgreements {
+    agreement_id
+    checkbox_text
+    content
+    content_height
+    is_html
+    mode
+    name
+  }
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "checkoutAgreements": [
+      {
+        "agreement_id": 987,
+        "checkbox_text": "xyz789",
+        "content": "abc123",
+        "content_height": "xyz789",
+        "is_html": true,
+        "mode": "AUTO",
+        "name": "xyz789"
+      }
+    ]
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ cmsBlocks +

+
+
+
+
Description
+

Return information about CMS blocks.

+
+
+
+
+
+
+
Response
+

Returns a CmsBlocks +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ identifiers - [String] + An array of CMS block IDs.
+
+
+
+

Example

+
+
Query
+ 
query cmsBlocks($identifiers: [String]) {
+  cmsBlocks(identifiers: $identifiers) {
+    items {
+      ...CmsBlockFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"identifiers": ["xyz789"]}
+
+
+
+
Response
+ 
{"data": {"cmsBlocks": {"items": [CmsBlock]}}}
+
+
+
+
+
+
+
+ Queries +
+

+ cmsPage +

+
+
+
+
Description
+

Return details about a CMS page.

+
+
+
+
+
+
+
Response
+

Returns a CmsPage +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ id - Int + The ID of the CMS page.
+ identifier - String + The identifier of the CMS page.
+
+
+
+

Example

+
+
Query
+ 
query cmsPage(
+  $id: Int,
+  $identifier: String
+) {
+  cmsPage(
+    id: $id,
+    identifier: $identifier
+  ) {
+    content
+    content_heading
+    identifier
+    meta_description
+    meta_keywords
+    meta_title
+    page_layout
+    redirect_code
+    relative_url
+    title
+    type
+    url_key
+  }
+}
+
+
+
+
Variables
+ 
{"id": 123, "identifier": "xyz789"}
+
+
+
+
Response
+ 
{
+  "data": {
+    "cmsPage": {
+      "content": "abc123",
+      "content_heading": "abc123",
+      "identifier": "xyz789",
+      "meta_description": "xyz789",
+      "meta_keywords": "xyz789",
+      "meta_title": "abc123",
+      "page_layout": "xyz789",
+      "redirect_code": 987,
+      "relative_url": "abc123",
+      "title": "abc123",
+      "type": "CMS_PAGE",
+      "url_key": "abc123"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ company +

+
+
+
+
Description
+

Return detailed information about the customer's company within the current company context.

+
+
+
+
+
+
+
Response
+

Returns a Company +

+
+
+
+

Example

+
+
Query
+ 
query company {
+  company {
+    acl_resources {
+      ...CompanyAclResourceFragment
+    }
+    company_admin {
+      ...CustomerFragment
+    }
+    credit {
+      ...CompanyCreditFragment
+    }
+    credit_history {
+      ...CompanyCreditHistoryFragment
+    }
+    email
+    id
+    legal_address {
+      ...CompanyLegalAddressFragment
+    }
+    legal_name
+    name
+    payment_methods
+    reseller_id
+    role {
+      ...CompanyRoleFragment
+    }
+    roles {
+      ...CompanyRolesFragment
+    }
+    sales_representative {
+      ...CompanySalesRepresentativeFragment
+    }
+    structure {
+      ...CompanyStructureFragment
+    }
+    team {
+      ...CompanyTeamFragment
+    }
+    user {
+      ...CustomerFragment
+    }
+    users {
+      ...CompanyUsersFragment
+    }
+    vat_tax_id
+  }
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "company": {
+      "acl_resources": [CompanyAclResource],
+      "company_admin": Customer,
+      "credit": CompanyCredit,
+      "credit_history": CompanyCreditHistory,
+      "email": "xyz789",
+      "id": "4",
+      "legal_address": CompanyLegalAddress,
+      "legal_name": "xyz789",
+      "name": "abc123",
+      "payment_methods": ["xyz789"],
+      "reseller_id": "abc123",
+      "role": CompanyRole,
+      "roles": CompanyRoles,
+      "sales_representative": CompanySalesRepresentative,
+      "structure": CompanyStructure,
+      "team": CompanyTeam,
+      "user": Customer,
+      "users": CompanyUsers,
+      "vat_tax_id": "abc123"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ compareList +

+
+
+
+
Description
+

Return products that have been added to the specified compare list.

+
+
+
+
+
+
+
Response
+

Returns a CompareList +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ uid - ID! + The unique ID of the compare list to be queried.
+
+
+
+

Example

+
+
Query
+ 
query compareList($uid: ID!) {
+  compareList(uid: $uid) {
+    attributes {
+      ...ComparableAttributeFragment
+    }
+    item_count
+    items {
+      ...ComparableItemFragment
+    }
+    uid
+  }
+}
+
+
+
+
Variables
+ 
{"uid": 4}
+
+
+
+
Response
+ 
{
+  "data": {
+    "compareList": {
+      "attributes": [ComparableAttribute],
+      "item_count": 987,
+      "items": [ComparableItem],
+      "uid": "4"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ countries +

+
+
+
+
Description
+

The countries query provides information for all countries.

+
+
+
+
+
+
+
Response
+

Returns [Country] +

+
+
+
+

Example

+
+
Query
+ 
query countries {
+  countries {
+    available_regions {
+      ...RegionFragment
+    }
+    full_name_english
+    full_name_locale
+    id
+    three_letter_abbreviation
+    two_letter_abbreviation
+  }
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "countries": [
+      {
+        "available_regions": [Region],
+        "full_name_english": "xyz789",
+        "full_name_locale": "xyz789",
+        "id": "abc123",
+        "three_letter_abbreviation": "abc123",
+        "two_letter_abbreviation": "xyz789"
+      }
+    ]
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ country +

+
+
+
+
Description
+

The countries query provides information for a single country.

+
+
+
+
+
+
+
Response
+

Returns a Country +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ id - String + +
+
+
+
+

Example

+
+
Query
+ 
query country($id: String) {
+  country(id: $id) {
+    available_regions {
+      ...RegionFragment
+    }
+    full_name_english
+    full_name_locale
+    id
+    three_letter_abbreviation
+    two_letter_abbreviation
+  }
+}
+
+
+
+
Variables
+ 
{"id": "xyz789"}
+
+
+
+
Response
+ 
{
+  "data": {
+    "country": {
+      "available_regions": [Region],
+      "full_name_english": "abc123",
+      "full_name_locale": "abc123",
+      "id": "xyz789",
+      "three_letter_abbreviation": "xyz789",
+      "two_letter_abbreviation": "xyz789"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ currency +

+
+
+
+
Description
+

Return information about the store's currency.

+
+
+
+
+
+
+
Response
+

Returns a Currency +

+
+
+
+

Example

+
+
Query
+ 
query currency {
+  currency {
+    available_currency_codes
+    base_currency_code
+    base_currency_symbol
+    default_display_currecy_code
+    default_display_currecy_symbol
+    default_display_currency_code
+    default_display_currency_symbol
+    exchange_rates {
+      ...ExchangeRateFragment
+    }
+  }
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "currency": {
+      "available_currency_codes": [
+        "xyz789"
+      ],
+      "base_currency_code": "xyz789",
+      "base_currency_symbol": "xyz789",
+      "default_display_currecy_code": "xyz789",
+      "default_display_currecy_symbol": "xyz789",
+      "default_display_currency_code": "xyz789",
+      "default_display_currency_symbol": "abc123",
+      "exchange_rates": [ExchangeRate]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ customAttributeMetadata +

+
+
+
+
Use customAttributeMetadataV2 query instead.
+
+
+
+
+
+
+
Description
+

Return the attribute type, given an attribute code and entity type.

+
+
+
+
+
+
+
Response
+

Returns a CustomAttributeMetadata +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ attributes - [AttributeInput!]! + An input object that specifies the attribute code and entity type to search.
+
+
+
+

Example

+
+
Query
+ 
query customAttributeMetadata($attributes: [AttributeInput!]!) {
+  customAttributeMetadata(attributes: $attributes) {
+    items {
+      ...AttributeFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"attributes": [AttributeInput]}
+
+
+
+
Response
+ 
{
+  "data": {
+    "customAttributeMetadata": {"items": [Attribute]}
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ customAttributeMetadataV2 +

+
+
+
+
Description
+

Retrieve EAV attributes metadata.

+
+
+
+
+
+
+
Response
+

Returns an AttributesMetadataOutput! +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ attributes - [AttributeInput!] + +
+
+
+
+

Example

+
+
Query
+ 
query customAttributeMetadataV2($attributes: [AttributeInput!]) {
+  customAttributeMetadataV2(attributes: $attributes) {
+    errors {
+      ...AttributeMetadataErrorFragment
+    }
+    items {
+      ...CustomAttributeMetadataInterfaceFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"attributes": [AttributeInput]}
+
+
+
+
Response
+ 
{
+  "data": {
+    "customAttributeMetadataV2": {
+      "errors": [AttributeMetadataError],
+      "items": [CustomAttributeMetadataInterface]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ customer +

+
+
+
+
Description
+

Return detailed information about a customer account.

+
+
+
+
+
+
+
Response
+

Returns a Customer +

+
+
+
+

Example

+
+
Query
+ 
query customer {
+  customer {
+    addresses {
+      ...CustomerAddressFragment
+    }
+    addressesV2 {
+      ...CustomerAddressesFragment
+    }
+    allow_remote_shopping_assistance
+    companies {
+      ...UserCompaniesOutputFragment
+    }
+    compare_list {
+      ...CompareListFragment
+    }
+    confirmation_status
+    created_at
+    custom_attributes {
+      ...AttributeValueInterfaceFragment
+    }
+    date_of_birth
+    default_billing
+    default_shipping
+    dob
+    email
+    firstname
+    gender
+    gift_registries {
+      ...GiftRegistryFragment
+    }
+    gift_registry {
+      ...GiftRegistryFragment
+    }
+    group {
+      ...CustomerGroupStorefrontFragment
+    }
+    group_id
+    id
+    is_subscribed
+    job_title
+    lastname
+    middlename
+    orders {
+      ...CustomerOrdersFragment
+    }
+    prefix
+    purchase_order {
+      ...PurchaseOrderFragment
+    }
+    purchase_order_approval_rule {
+      ...PurchaseOrderApprovalRuleFragment
+    }
+    purchase_order_approval_rule_metadata {
+      ...PurchaseOrderApprovalRuleMetadataFragment
+    }
+    purchase_order_approval_rules {
+      ...PurchaseOrderApprovalRulesFragment
+    }
+    purchase_orders {
+      ...PurchaseOrdersFragment
+    }
+    purchase_orders_enabled
+    requisition_lists {
+      ...RequisitionListsFragment
+    }
+    return {
+      ...ReturnFragment
+    }
+    returns {
+      ...ReturnsFragment
+    }
+    reviews {
+      ...ProductReviewsFragment
+    }
+    reward_points {
+      ...RewardPointsFragment
+    }
+    role {
+      ...CompanyRoleFragment
+    }
+    segments {
+      ...CustomerSegmentStorefrontFragment
+    }
+    status
+    store_credit {
+      ...CustomerStoreCreditFragment
+    }
+    structure_id
+    suffix
+    taxvat
+    team {
+      ...CompanyTeamFragment
+    }
+    telephone
+    wishlist {
+      ...WishlistFragment
+    }
+    wishlist_v2 {
+      ...WishlistFragment
+    }
+    wishlists {
+      ...WishlistFragment
+    }
+  }
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "customer": {
+      "addresses": [CustomerAddress],
+      "addressesV2": CustomerAddresses,
+      "allow_remote_shopping_assistance": true,
+      "companies": UserCompaniesOutput,
+      "compare_list": CompareList,
+      "confirmation_status": "ACCOUNT_CONFIRMED",
+      "created_at": "xyz789",
+      "custom_attributes": [AttributeValueInterface],
+      "date_of_birth": "abc123",
+      "default_billing": "xyz789",
+      "default_shipping": "xyz789",
+      "dob": "xyz789",
+      "email": "abc123",
+      "firstname": "abc123",
+      "gender": 123,
+      "gift_registries": [GiftRegistry],
+      "gift_registry": GiftRegistry,
+      "group": CustomerGroupStorefront,
+      "group_id": 987,
+      "id": "4",
+      "is_subscribed": false,
+      "job_title": "abc123",
+      "lastname": "abc123",
+      "middlename": "xyz789",
+      "orders": CustomerOrders,
+      "prefix": "abc123",
+      "purchase_order": PurchaseOrder,
+      "purchase_order_approval_rule": PurchaseOrderApprovalRule,
+      "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
+      "purchase_order_approval_rules": PurchaseOrderApprovalRules,
+      "purchase_orders": PurchaseOrders,
+      "purchase_orders_enabled": true,
+      "requisition_lists": RequisitionLists,
+      "return": Return,
+      "returns": Returns,
+      "reviews": ProductReviews,
+      "reward_points": RewardPoints,
+      "role": CompanyRole,
+      "segments": [CustomerSegmentStorefront],
+      "status": "ACTIVE",
+      "store_credit": CustomerStoreCredit,
+      "structure_id": 4,
+      "suffix": "xyz789",
+      "taxvat": "xyz789",
+      "team": CompanyTeam,
+      "telephone": "xyz789",
+      "wishlist": Wishlist,
+      "wishlist_v2": Wishlist,
+      "wishlists": [Wishlist]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ customerCart +

+
+
+
+
Description
+

Return information about the customer's shopping cart.

+
+
+
+
+
+
+
Response
+

Returns a Cart! +

+
+
+
+

Example

+
+
Query
+ 
query customerCart {
+  customerCart {
+    applied_coupon {
+      ...AppliedCouponFragment
+    }
+    applied_coupons {
+      ...AppliedCouponFragment
+    }
+    applied_gift_cards {
+      ...AppliedGiftCardFragment
+    }
+    applied_reward_points {
+      ...RewardPointsAmountFragment
+    }
+    applied_store_credit {
+      ...AppliedStoreCreditFragment
+    }
+    available_gift_wrappings {
+      ...GiftWrappingFragment
+    }
+    available_payment_methods {
+      ...AvailablePaymentMethodFragment
+    }
+    billing_address {
+      ...BillingCartAddressFragment
+    }
+    email
+    gift_message {
+      ...GiftMessageFragment
+    }
+    gift_receipt_included
+    gift_wrapping {
+      ...GiftWrappingFragment
+    }
+    id
+    is_virtual
+    items {
+      ...CartItemInterfaceFragment
+    }
+    itemsV2 {
+      ...CartItemsFragment
+    }
+    prices {
+      ...CartPricesFragment
+    }
+    printed_card_included
+    rules {
+      ...CartRuleStorefrontFragment
+    }
+    selected_payment_method {
+      ...SelectedPaymentMethodFragment
+    }
+    shipping_addresses {
+      ...ShippingCartAddressFragment
+    }
+    total_quantity
+  }
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "customerCart": {
+      "applied_coupon": AppliedCoupon,
+      "applied_coupons": [AppliedCoupon],
+      "applied_gift_cards": [AppliedGiftCard],
+      "applied_reward_points": RewardPointsAmount,
+      "applied_store_credit": AppliedStoreCredit,
+      "available_gift_wrappings": [GiftWrapping],
+      "available_payment_methods": [
+        AvailablePaymentMethod
+      ],
+      "billing_address": BillingCartAddress,
+      "email": "abc123",
+      "gift_message": GiftMessage,
+      "gift_receipt_included": true,
+      "gift_wrapping": GiftWrapping,
+      "id": 4,
+      "is_virtual": false,
+      "items": [CartItemInterface],
+      "itemsV2": CartItems,
+      "prices": CartPrices,
+      "printed_card_included": false,
+      "rules": [CartRuleStorefront],
+      "selected_payment_method": SelectedPaymentMethod,
+      "shipping_addresses": [ShippingCartAddress],
+      "total_quantity": 123.45
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ customerDownloadableProducts +

+
+
+
+
Description
+

Return a list of downloadable products the customer has purchased.

+
+
+
+
+
+
+
Response
+

Returns a CustomerDownloadableProducts +

+
+
+
+

Example

+
+
Query
+ 
query customerDownloadableProducts {
+  customerDownloadableProducts {
+    items {
+      ...CustomerDownloadableProductFragment
+    }
+  }
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "customerDownloadableProducts": {
+      "items": [CustomerDownloadableProduct]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ customerGroup +

+
+
+
+
Description
+

Provides Customer Group assigned to the Customer or Guest.

+
+
+
+
+
+
+
Response
+

Returns a CustomerGroupStorefront! +

+
+
+
+

Example

+
+
Query
+ 
query customerGroup {
+  customerGroup {
+    uid
+  }
+}
+
+
+
+
Response
+ 
{"data": {"customerGroup": {"uid": "4"}}}
+
+
+
+
+
+
+
+ Queries +
+

+ customerOrders +

+
+
+
+
Use the customer query instead.
+
+
+
+
+
+
+
Response
+

Returns a CustomerOrders +

+
+
+
+

Example

+
+
Query
+ 
query customerOrders {
+  customerOrders {
+    date_of_first_order
+    items {
+      ...CustomerOrderFragment
+    }
+    page_info {
+      ...SearchResultPageInfoFragment
+    }
+    total_count
+  }
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "customerOrders": {
+      "date_of_first_order": "xyz789",
+      "items": [CustomerOrder],
+      "page_info": SearchResultPageInfo,
+      "total_count": 123
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ customerPaymentTokens +

+
+
+
+
Description
+

Return a list of customer payment tokens stored in the vault.

+
+
+
+
+
+
+
Response
+

Returns a CustomerPaymentTokens +

+
+
+
+

Example

+
+
Query
+ 
query customerPaymentTokens {
+  customerPaymentTokens {
+    items {
+      ...PaymentTokenFragment
+    }
+  }
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "customerPaymentTokens": {"items": [PaymentToken]}
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ customerSegments +

+
+
+
+
Description
+

Customer segments associated with the current customer or guest/visitor.

+
+
+
+
+
+
+
Response
+

Returns [CustomerSegmentStorefront] +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ cartId - String! + The unique ID of the cart to query.
+
+
+
+

Example

+
+
Query
+ 
query customerSegments($cartId: String!) {
+  customerSegments(cartId: $cartId) {
+    uid
+  }
+}
+
+
+
+
Variables
+ 
{"cartId": "xyz789"}
+
+
+
+
Response
+ 
{
+  "data": {
+    "customerSegments": [{"uid": "4"}]
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ dynamicBlocks +

+
+
+
+
Description
+

Return a list of dynamic blocks filtered by type, location, or UIDs.

+
+
+
+
+
+
+
Response
+

Returns a DynamicBlocks! +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
+ input - DynamicBlocksFilterInput + Defines the filter for returning matching dynamic blocks.
+ pageSize - Int + The maximum number of results to return at once. The default is 20. Default = 20
+ currentPage - Int + The page of results to return. The default is 1. Default = 1
+
+
+
+

Example

+
+
Query
+ 
query dynamicBlocks(
+  $input: DynamicBlocksFilterInput,
+  $pageSize: Int,
+  $currentPage: Int
+) {
+  dynamicBlocks(
+    input: $input,
+    pageSize: $pageSize,
+    currentPage: $currentPage
+  ) {
+    items {
+      ...DynamicBlockFragment
+    }
+    page_info {
+      ...SearchResultPageInfoFragment
+    }
+    total_count
+  }
+}
+
+
+
+
Variables
+ 
{
+  "input": DynamicBlocksFilterInput,
+  "pageSize": 20,
+  "currentPage": 1
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "dynamicBlocks": {
+      "items": [DynamicBlock],
+      "page_info": SearchResultPageInfo,
+      "total_count": 123
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ getHostedProUrl +

+
+
+
+
Description
+

Retrieve the secure PayPal URL for a Payments Pro Hosted Solution transaction.

+
+
+
+
+
+
+
Response
+

Returns a HostedProUrl +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - HostedProUrlInput! + An input object that specifies the cart ID.
+
+
+
+

Example

+
+
Query
+ 
query getHostedProUrl($input: HostedProUrlInput!) {
+  getHostedProUrl(input: $input) {
+    secure_form_url
+  }
+}
+
+
+
+
Variables
+ 
{"input": HostedProUrlInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "getHostedProUrl": {
+      "secure_form_url": "abc123"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ getPayflowLinkToken +

+
+
+
+
Description
+

Retrieve payment credentials for a transaction. Use this query for Payflow Link and Payments Advanced payment methods.

+
+
+
+
+
+
+
Response
+

Returns a PayflowLinkToken +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - PayflowLinkTokenInput! + An input object that defines the requirements to receive a payment token.
+
+
+
+

Example

+
+
Query
+ 
query getPayflowLinkToken($input: PayflowLinkTokenInput!) {
+  getPayflowLinkToken(input: $input) {
+    mode
+    paypal_url
+    secure_token
+    secure_token_id
+  }
+}
+
+
+
+
Variables
+ 
{"input": PayflowLinkTokenInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "getPayflowLinkToken": {
+      "mode": "TEST",
+      "paypal_url": "abc123",
+      "secure_token": "abc123",
+      "secure_token_id": "abc123"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ getPaymentConfig +

+
+
+
+
Description
+

Retrieves the payment configuration for a given location

+
+
+
+
+
+
+
Response
+

Returns a PaymentConfigOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ location - PaymentLocation! + Defines the origin location for that payment request
+
+
+
+

Example

+
+
Query
+ 
query getPaymentConfig($location: PaymentLocation!) {
+  getPaymentConfig(location: $location) {
+    apple_pay {
+      ...ApplePayConfigFragment
+    }
+    fastlane {
+      ...FastlaneConfigFragment
+    }
+    google_pay {
+      ...GooglePayConfigFragment
+    }
+    hosted_fields {
+      ...HostedFieldsConfigFragment
+    }
+    smart_buttons {
+      ...SmartButtonsConfigFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"location": "PRODUCT_DETAIL"}
+
+
+
+
Response
+ 
{
+  "data": {
+    "getPaymentConfig": {
+      "apple_pay": ApplePayConfig,
+      "fastlane": FastlaneConfig,
+      "google_pay": GooglePayConfig,
+      "hosted_fields": HostedFieldsConfig,
+      "smart_buttons": SmartButtonsConfig
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ getPaymentOrder +

+
+
+
+
Description
+

Retrieves the payment details for the order

+
+
+
+
+
+
+
Response
+

Returns a PaymentOrderOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ cartId - String! + The customer cart ID
+ id - String! + PayPal order ID
+
+
+
+

Example

+
+
Query
+ 
query getPaymentOrder(
+  $cartId: String!,
+  $id: String!
+) {
+  getPaymentOrder(
+    cartId: $cartId,
+    id: $id
+  ) {
+    id
+    mp_order_id
+    payment_source_details {
+      ...PaymentSourceDetailsFragment
+    }
+    status
+  }
+}
+
+
+
+
Variables
+ 
{
+  "cartId": "abc123",
+  "id": "abc123"
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "getPaymentOrder": {
+      "id": "xyz789",
+      "mp_order_id": "xyz789",
+      "payment_source_details": PaymentSourceDetails,
+      "status": "abc123"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ getPaymentSDK +

+
+
+
+
Description
+

Gets the payment SDK urls and values

+
+
+
+
+
+
+
Response
+

Returns an GetPaymentSDKOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ location - PaymentLocation! + Defines the origin location for that payment request
+
+
+
+

Example

+
+
Query
+ 
query getPaymentSDK($location: PaymentLocation!) {
+  getPaymentSDK(location: $location) {
+    sdkParams {
+      ...PaymentSDKParamsItemFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"location": "PRODUCT_DETAIL"}
+
+
+
+
Response
+ 
{
+  "data": {
+    "getPaymentSDK": {"sdkParams": [PaymentSDKParamsItem]}
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ getVaultConfig +

+
+
+
+
Description
+

Retrieves the vault configuration

+
+
+
+
+
+
+
Response
+

Returns a VaultConfigOutput +

+
+
+
+

Example

+
+
Query
+ 
query getVaultConfig {
+  getVaultConfig {
+    credit_card {
+      ...VaultCreditCardConfigFragment
+    }
+  }
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "getVaultConfig": {
+      "credit_card": VaultCreditCardConfig
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ giftCardAccount +

+
+
+
+
Description
+

Return details about a specific gift card.

+
+
+
+
+
+
+
Response
+

Returns a GiftCardAccount +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - GiftCardAccountInput! + An input object that specifies the gift card code.
+
+
+
+

Example

+
+
Query
+ 
query giftCardAccount($input: GiftCardAccountInput!) {
+  giftCardAccount(input: $input) {
+    balance {
+      ...MoneyFragment
+    }
+    code
+    expiration_date
+  }
+}
+
+
+
+
Variables
+ 
{"input": GiftCardAccountInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "giftCardAccount": {
+      "balance": Money,
+      "code": "xyz789",
+      "expiration_date": "xyz789"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ giftRegistry +

+
+
+
+
Description
+

Return the specified gift registry. Some details will not be available to guests.

+
+
+
+
+
+
+
Response
+

Returns a GiftRegistry +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ giftRegistryUid - ID! + The unique ID of the registry to search for.
+
+
+
+

Example

+
+
Query
+ 
query giftRegistry($giftRegistryUid: ID!) {
+  giftRegistry(giftRegistryUid: $giftRegistryUid) {
+    created_at
+    dynamic_attributes {
+      ...GiftRegistryDynamicAttributeFragment
+    }
+    event_name
+    items {
+      ...GiftRegistryItemInterfaceFragment
+    }
+    message
+    owner_name
+    privacy_settings
+    registrants {
+      ...GiftRegistryRegistrantFragment
+    }
+    shipping_address {
+      ...CustomerAddressFragment
+    }
+    status
+    type {
+      ...GiftRegistryTypeFragment
+    }
+    uid
+  }
+}
+
+
+
+
Variables
+ 
{"giftRegistryUid": 4}
+
+
+
+
Response
+ 
{
+  "data": {
+    "giftRegistry": {
+      "created_at": "xyz789",
+      "dynamic_attributes": [
+        GiftRegistryDynamicAttribute
+      ],
+      "event_name": "abc123",
+      "items": [GiftRegistryItemInterface],
+      "message": "xyz789",
+      "owner_name": "xyz789",
+      "privacy_settings": "PRIVATE",
+      "registrants": [GiftRegistryRegistrant],
+      "shipping_address": CustomerAddress,
+      "status": "ACTIVE",
+      "type": GiftRegistryType,
+      "uid": "4"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ giftRegistryEmailSearch +

+
+
+
+
Description
+

Search for gift registries by specifying a registrant email address.

+
+
+
+
+
+
+
Response
+

Returns [GiftRegistrySearchResult] +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ email - String! + The registrant's email.
+
+
+
+

Example

+
+
Query
+ 
query giftRegistryEmailSearch($email: String!) {
+  giftRegistryEmailSearch(email: $email) {
+    event_date
+    event_title
+    gift_registry_uid
+    location
+    name
+    type
+  }
+}
+
+
+
+
Variables
+ 
{"email": "xyz789"}
+
+
+
+
Response
+ 
{
+  "data": {
+    "giftRegistryEmailSearch": [
+      {
+        "event_date": "xyz789",
+        "event_title": "abc123",
+        "gift_registry_uid": 4,
+        "location": "abc123",
+        "name": "xyz789",
+        "type": "abc123"
+      }
+    ]
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ giftRegistryIdSearch +

+
+
+
+
Description
+

Search for gift registries by specifying a registry URL key.

+
+
+
+
+
+
+
Response
+

Returns [GiftRegistrySearchResult] +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ giftRegistryUid - ID! + The unique ID of the gift registry.
+
+
+
+

Example

+
+
Query
+ 
query giftRegistryIdSearch($giftRegistryUid: ID!) {
+  giftRegistryIdSearch(giftRegistryUid: $giftRegistryUid) {
+    event_date
+    event_title
+    gift_registry_uid
+    location
+    name
+    type
+  }
+}
+
+
+
+
Variables
+ 
{"giftRegistryUid": "4"}
+
+
+
+
Response
+ 
{
+  "data": {
+    "giftRegistryIdSearch": [
+      {
+        "event_date": "xyz789",
+        "event_title": "abc123",
+        "gift_registry_uid": "4",
+        "location": "xyz789",
+        "name": "abc123",
+        "type": "xyz789"
+      }
+    ]
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ giftRegistryTypeSearch +

+
+
+
+
Description
+

Search for gift registries by specifying the registrant name and registry type ID.

+
+
+
+
+
+
+
Response
+

Returns [GiftRegistrySearchResult] +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
+ firstName - String! + The first name of the registrant.
+ lastName - String! + The last name of the registrant.
+ giftRegistryTypeUid - ID + The type UID of the registry.
+
+
+
+

Example

+
+
Query
+ 
query giftRegistryTypeSearch(
+  $firstName: String!,
+  $lastName: String!,
+  $giftRegistryTypeUid: ID
+) {
+  giftRegistryTypeSearch(
+    firstName: $firstName,
+    lastName: $lastName,
+    giftRegistryTypeUid: $giftRegistryTypeUid
+  ) {
+    event_date
+    event_title
+    gift_registry_uid
+    location
+    name
+    type
+  }
+}
+
+
+
+
Variables
+ 
{
+  "firstName": "xyz789",
+  "lastName": "abc123",
+  "giftRegistryTypeUid": "4"
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "giftRegistryTypeSearch": [
+      {
+        "event_date": "xyz789",
+        "event_title": "xyz789",
+        "gift_registry_uid": "4",
+        "location": "abc123",
+        "name": "abc123",
+        "type": "abc123"
+      }
+    ]
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ giftRegistryTypes +

+
+
+
+
Description
+

Get a list of available gift registry types.

+
+
+
+
+
+
+
Response
+

Returns [GiftRegistryType] +

+
+
+
+

Example

+
+
Query
+ 
query giftRegistryTypes {
+  giftRegistryTypes {
+    dynamic_attributes_metadata {
+      ...GiftRegistryDynamicAttributeMetadataInterfaceFragment
+    }
+    label
+    uid
+  }
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "giftRegistryTypes": [
+      {
+        "dynamic_attributes_metadata": [
+          GiftRegistryDynamicAttributeMetadataInterface
+        ],
+        "label": "xyz789",
+        "uid": "4"
+      }
+    ]
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ guestOrder +

+
+
+
+
Description
+

Retrieve guest order details based on number, email and billing last name.

+
+
+
+
+
+
+
Response
+

Returns a CustomerOrder! +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - GuestOrderInformationInput! + +
+
+
+
+

Example

+
+
Query
+ 
query guestOrder($input: GuestOrderInformationInput!) {
+  guestOrder(input: $input) {
+    applied_coupons {
+      ...AppliedCouponFragment
+    }
+    applied_gift_cards {
+      ...ApplyGiftCardToOrderFragment
+    }
+    available_actions
+    billing_address {
+      ...OrderAddressFragment
+    }
+    carrier
+    comments {
+      ...SalesCommentItemFragment
+    }
+    created_at
+    credit_memos {
+      ...CreditMemoFragment
+    }
+    customer_info {
+      ...OrderCustomerInfoFragment
+    }
+    email
+    gift_message {
+      ...GiftMessageFragment
+    }
+    gift_receipt_included
+    gift_wrapping {
+      ...GiftWrappingFragment
+    }
+    grand_total
+    id
+    increment_id
+    invoices {
+      ...InvoiceFragment
+    }
+    is_virtual
+    items {
+      ...OrderItemInterfaceFragment
+    }
+    items_eligible_for_return {
+      ...OrderItemInterfaceFragment
+    }
+    number
+    order_date
+    order_number
+    order_status_change_date
+    payment_methods {
+      ...OrderPaymentMethodFragment
+    }
+    printed_card_included
+    returns {
+      ...ReturnsFragment
+    }
+    shipments {
+      ...OrderShipmentFragment
+    }
+    shipping_address {
+      ...OrderAddressFragment
+    }
+    shipping_method
+    status
+    token
+    total {
+      ...OrderTotalFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": GuestOrderInformationInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "guestOrder": {
+      "applied_coupons": [AppliedCoupon],
+      "applied_gift_cards": [ApplyGiftCardToOrder],
+      "available_actions": ["REORDER"],
+      "billing_address": OrderAddress,
+      "carrier": "abc123",
+      "comments": [SalesCommentItem],
+      "created_at": "abc123",
+      "credit_memos": [CreditMemo],
+      "customer_info": OrderCustomerInfo,
+      "email": "xyz789",
+      "gift_message": GiftMessage,
+      "gift_receipt_included": false,
+      "gift_wrapping": GiftWrapping,
+      "grand_total": 123.45,
+      "id": "4",
+      "increment_id": "abc123",
+      "invoices": [Invoice],
+      "is_virtual": true,
+      "items": [OrderItemInterface],
+      "items_eligible_for_return": [OrderItemInterface],
+      "number": "xyz789",
+      "order_date": "xyz789",
+      "order_number": "xyz789",
+      "order_status_change_date": "abc123",
+      "payment_methods": [OrderPaymentMethod],
+      "printed_card_included": false,
+      "returns": Returns,
+      "shipments": [OrderShipment],
+      "shipping_address": OrderAddress,
+      "shipping_method": "xyz789",
+      "status": "xyz789",
+      "token": "xyz789",
+      "total": OrderTotal
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ guestOrderByToken +

+
+
+
+
Description
+

Retrieve guest order details based on token.

+
+
+
+
+
+
+
Response
+

Returns a CustomerOrder! +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - OrderTokenInput! + +
+
+
+
+

Example

+
+
Query
+ 
query guestOrderByToken($input: OrderTokenInput!) {
+  guestOrderByToken(input: $input) {
+    applied_coupons {
+      ...AppliedCouponFragment
+    }
+    applied_gift_cards {
+      ...ApplyGiftCardToOrderFragment
+    }
+    available_actions
+    billing_address {
+      ...OrderAddressFragment
+    }
+    carrier
+    comments {
+      ...SalesCommentItemFragment
+    }
+    created_at
+    credit_memos {
+      ...CreditMemoFragment
+    }
+    customer_info {
+      ...OrderCustomerInfoFragment
+    }
+    email
+    gift_message {
+      ...GiftMessageFragment
+    }
+    gift_receipt_included
+    gift_wrapping {
+      ...GiftWrappingFragment
+    }
+    grand_total
+    id
+    increment_id
+    invoices {
+      ...InvoiceFragment
+    }
+    is_virtual
+    items {
+      ...OrderItemInterfaceFragment
+    }
+    items_eligible_for_return {
+      ...OrderItemInterfaceFragment
+    }
+    number
+    order_date
+    order_number
+    order_status_change_date
+    payment_methods {
+      ...OrderPaymentMethodFragment
+    }
+    printed_card_included
+    returns {
+      ...ReturnsFragment
+    }
+    shipments {
+      ...OrderShipmentFragment
+    }
+    shipping_address {
+      ...OrderAddressFragment
+    }
+    shipping_method
+    status
+    token
+    total {
+      ...OrderTotalFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": OrderTokenInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "guestOrderByToken": {
+      "applied_coupons": [AppliedCoupon],
+      "applied_gift_cards": [ApplyGiftCardToOrder],
+      "available_actions": ["REORDER"],
+      "billing_address": OrderAddress,
+      "carrier": "abc123",
+      "comments": [SalesCommentItem],
+      "created_at": "xyz789",
+      "credit_memos": [CreditMemo],
+      "customer_info": OrderCustomerInfo,
+      "email": "abc123",
+      "gift_message": GiftMessage,
+      "gift_receipt_included": true,
+      "gift_wrapping": GiftWrapping,
+      "grand_total": 123.45,
+      "id": 4,
+      "increment_id": "xyz789",
+      "invoices": [Invoice],
+      "is_virtual": true,
+      "items": [OrderItemInterface],
+      "items_eligible_for_return": [OrderItemInterface],
+      "number": "abc123",
+      "order_date": "abc123",
+      "order_number": "xyz789",
+      "order_status_change_date": "xyz789",
+      "payment_methods": [OrderPaymentMethod],
+      "printed_card_included": false,
+      "returns": Returns,
+      "shipments": [OrderShipment],
+      "shipping_address": OrderAddress,
+      "shipping_method": "xyz789",
+      "status": "xyz789",
+      "token": "abc123",
+      "total": OrderTotal
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ isCompanyAdminEmailAvailable +

+
+
+
+
Description
+

Check whether the specified email can be used to register a company admin.

+
+
+
+
+
+
+
Response
+

Returns an IsCompanyAdminEmailAvailableOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ email - String! + +
+
+
+
+

Example

+
+
Query
+ 
query isCompanyAdminEmailAvailable($email: String!) {
+  isCompanyAdminEmailAvailable(email: $email) {
+    is_email_available
+  }
+}
+
+
+
+
Variables
+ 
{"email": "xyz789"}
+
+
+
+
Response
+ 
{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}}
+
+
+
+
+
+
+
+ Queries +
+

+ isCompanyEmailAvailable +

+
+
+
+
Description
+

Check whether the specified email can be used to register a new company.

+
+
+
+
+
+
+
Response
+

Returns an IsCompanyEmailAvailableOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ email - String! + +
+
+
+
+

Example

+
+
Query
+ 
query isCompanyEmailAvailable($email: String!) {
+  isCompanyEmailAvailable(email: $email) {
+    is_email_available
+  }
+}
+
+
+
+
Variables
+ 
{"email": "abc123"}
+
+
+
+
Response
+ 
{"data": {"isCompanyEmailAvailable": {"is_email_available": true}}}
+
+
+
+
+
+
+
+ Queries +
+

+ isCompanyRoleNameAvailable +

+
+
+
+
Description
+

Check whether the specified role name is valid for the company.

+
+
+
+
+
+
+
Response
+

Returns an IsCompanyRoleNameAvailableOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ name - String! + +
+
+
+
+

Example

+
+
Query
+ 
query isCompanyRoleNameAvailable($name: String!) {
+  isCompanyRoleNameAvailable(name: $name) {
+    is_role_name_available
+  }
+}
+
+
+
+
Variables
+ 
{"name": "abc123"}
+
+
+
+
Response
+ 
{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": false}}}
+
+
+
+
+
+
+
+ Queries +
+

+ isCompanyUserEmailAvailable +

+
+
+
+
Description
+

Check whether the specified email can be used to register a company user.

+
+
+
+
+
+
+
Response
+

Returns an IsCompanyUserEmailAvailableOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ email - String! + +
+
+
+
+

Example

+
+
Query
+ 
query isCompanyUserEmailAvailable($email: String!) {
+  isCompanyUserEmailAvailable(email: $email) {
+    is_email_available
+  }
+}
+
+
+
+
Variables
+ 
{"email": "abc123"}
+
+
+
+
Response
+ 
{"data": {"isCompanyUserEmailAvailable": {"is_email_available": false}}}
+
+
+
+
+
+
+
+ Queries +
+

+ isEmailAvailable +

+
+
+
+
Description
+

Check whether the specified email has already been used to create a customer account.

+
+
+
+
+
+
+
Response
+

Returns an IsEmailAvailableOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ email - String! + The email address to check.
+
+
+
+

Example

+
+
Query
+ 
query isEmailAvailable($email: String!) {
+  isEmailAvailable(email: $email) {
+    is_email_available
+  }
+}
+
+
+
+
Variables
+ 
{"email": "xyz789"}
+
+
+
+
Response
+ 
{"data": {"isEmailAvailable": {"is_email_available": true}}}
+
+
+
+
+
+
+
+ Queries +
+

+ negotiableQuote +

+
+
+
+
Description
+

Retrieve the specified negotiable quote.

+
+
+
+
+
+
+
Response
+

Returns a NegotiableQuote +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ uid - ID! + +
+
+
+
+

Example

+
+
Query
+ 
query negotiableQuote($uid: ID!) {
+  negotiableQuote(uid: $uid) {
+    available_payment_methods {
+      ...AvailablePaymentMethodFragment
+    }
+    billing_address {
+      ...NegotiableQuoteBillingAddressFragment
+    }
+    buyer {
+      ...NegotiableQuoteUserFragment
+    }
+    comments {
+      ...NegotiableQuoteCommentFragment
+    }
+    created_at
+    email
+    history {
+      ...NegotiableQuoteHistoryEntryFragment
+    }
+    is_virtual
+    items {
+      ...CartItemInterfaceFragment
+    }
+    name
+    prices {
+      ...CartPricesFragment
+    }
+    selected_payment_method {
+      ...SelectedPaymentMethodFragment
+    }
+    shipping_addresses {
+      ...NegotiableQuoteShippingAddressFragment
+    }
+    status
+    total_quantity
+    uid
+    updated_at
+  }
+}
+
+
+
+
Variables
+ 
{"uid": 4}
+
+
+
+
Response
+ 
{
+  "data": {
+    "negotiableQuote": {
+      "available_payment_methods": [
+        AvailablePaymentMethod
+      ],
+      "billing_address": NegotiableQuoteBillingAddress,
+      "buyer": NegotiableQuoteUser,
+      "comments": [NegotiableQuoteComment],
+      "created_at": "xyz789",
+      "email": "xyz789",
+      "history": [NegotiableQuoteHistoryEntry],
+      "is_virtual": false,
+      "items": [CartItemInterface],
+      "name": "abc123",
+      "prices": CartPrices,
+      "selected_payment_method": SelectedPaymentMethod,
+      "shipping_addresses": [
+        NegotiableQuoteShippingAddress
+      ],
+      "status": "SUBMITTED",
+      "total_quantity": 123.45,
+      "uid": 4,
+      "updated_at": "xyz789"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ negotiableQuoteTemplate +

+
+
+
+
Description
+

Retrieve the specified negotiable quote template.

+
+
+
+
+
+
+
Response
+

Returns a NegotiableQuoteTemplate +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ templateId - ID! + +
+
+
+
+

Example

+
+
Query
+ 
query negotiableQuoteTemplate($templateId: ID!) {
+  negotiableQuoteTemplate(templateId: $templateId) {
+    buyer {
+      ...NegotiableQuoteUserFragment
+    }
+    comments {
+      ...NegotiableQuoteCommentFragment
+    }
+    expiration_date
+    history {
+      ...NegotiableQuoteHistoryEntryFragment
+    }
+    is_min_max_qty_used
+    is_virtual
+    items {
+      ...CartItemInterfaceFragment
+    }
+    max_order_commitment
+    min_order_commitment
+    name
+    notifications {
+      ...QuoteTemplateNotificationMessageFragment
+    }
+    prices {
+      ...CartPricesFragment
+    }
+    reference_document_links {
+      ...NegotiableQuoteReferenceDocumentLinkFragment
+    }
+    shipping_addresses {
+      ...NegotiableQuoteShippingAddressFragment
+    }
+    status
+    template_id
+    total_quantity
+  }
+}
+
+
+
+
Variables
+ 
{"templateId": 4}
+
+
+
+
Response
+ 
{
+  "data": {
+    "negotiableQuoteTemplate": {
+      "buyer": NegotiableQuoteUser,
+      "comments": [NegotiableQuoteComment],
+      "expiration_date": "abc123",
+      "history": [NegotiableQuoteHistoryEntry],
+      "is_min_max_qty_used": false,
+      "is_virtual": true,
+      "items": [CartItemInterface],
+      "max_order_commitment": 123,
+      "min_order_commitment": 123,
+      "name": "xyz789",
+      "notifications": [QuoteTemplateNotificationMessage],
+      "prices": CartPrices,
+      "reference_document_links": [
+        NegotiableQuoteReferenceDocumentLink
+      ],
+      "shipping_addresses": [
+        NegotiableQuoteShippingAddress
+      ],
+      "status": "xyz789",
+      "template_id": 4,
+      "total_quantity": 987.65
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ negotiableQuoteTemplates +

+
+
+
+
Description
+

Return a list of negotiable quote templates that can be viewed by the logged-in customer.

+
+
+
+
+
+
+
Response
+

Returns a NegotiableQuoteTemplatesOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
+ filter - NegotiableQuoteTemplateFilterInput + The filter to use to determine which negotiable quote templates to return.
+ pageSize - Int + The maximum number of results to return at once. The default value is 20. Default = 20
+ currentPage - Int + The page of results to return. The default value is 1. Default = 1
+ sort - NegotiableQuoteTemplateSortInput + The field to use for sorting results.
+
+
+
+

Example

+
+
Query
+ 
query negotiableQuoteTemplates(
+  $filter: NegotiableQuoteTemplateFilterInput,
+  $pageSize: Int,
+  $currentPage: Int,
+  $sort: NegotiableQuoteTemplateSortInput
+) {
+  negotiableQuoteTemplates(
+    filter: $filter,
+    pageSize: $pageSize,
+    currentPage: $currentPage,
+    sort: $sort
+  ) {
+    items {
+      ...NegotiableQuoteTemplateGridItemFragment
+    }
+    page_info {
+      ...SearchResultPageInfoFragment
+    }
+    sort_fields {
+      ...SortFieldsFragment
+    }
+    total_count
+  }
+}
+
+
+
+
Variables
+ 
{
+  "filter": NegotiableQuoteTemplateFilterInput,
+  "pageSize": 20,
+  "currentPage": 1,
+  "sort": NegotiableQuoteTemplateSortInput
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "negotiableQuoteTemplates": {
+      "items": [NegotiableQuoteTemplateGridItem],
+      "page_info": SearchResultPageInfo,
+      "sort_fields": SortFields,
+      "total_count": 123
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ negotiableQuotes +

+
+
+
+
Description
+

Return a list of negotiable quotes that can be viewed by the logged-in customer.

+
+
+
+
+
+
+
Response
+

Returns a NegotiableQuotesOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
+ filter - NegotiableQuoteFilterInput + The filter to use to determine which negotiable quotes to return.
+ pageSize - Int + The maximum number of results to return at once. The default value is 20. Default = 20
+ currentPage - Int + The page of results to return. The default value is 1. Default = 1
+ sort - NegotiableQuoteSortInput + The field to use for sorting results.
+
+
+
+

Example

+
+
Query
+ 
query negotiableQuotes(
+  $filter: NegotiableQuoteFilterInput,
+  $pageSize: Int,
+  $currentPage: Int,
+  $sort: NegotiableQuoteSortInput
+) {
+  negotiableQuotes(
+    filter: $filter,
+    pageSize: $pageSize,
+    currentPage: $currentPage,
+    sort: $sort
+  ) {
+    items {
+      ...NegotiableQuoteFragment
+    }
+    page_info {
+      ...SearchResultPageInfoFragment
+    }
+    sort_fields {
+      ...SortFieldsFragment
+    }
+    total_count
+  }
+}
+
+
+
+
Variables
+ 
{
+  "filter": NegotiableQuoteFilterInput,
+  "pageSize": 20,
+  "currentPage": 1,
+  "sort": NegotiableQuoteSortInput
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "negotiableQuotes": {
+      "items": [NegotiableQuote],
+      "page_info": SearchResultPageInfo,
+      "sort_fields": SortFields,
+      "total_count": 987
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ pickupLocations +

+
+
+
+
Description
+

The pickup locations query searches for locations that match the search request requirements.

+
+
+
+
+
+
+
Response
+

Returns a PickupLocations +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
+ area - AreaInput + Perform search by location using radius and search term.
+ filters - PickupLocationFilterInput + Apply filters by attributes.
+ sort - PickupLocationSortInput + Specifies which attribute to sort on, and whether to return the results in ascending or descending order.
+ pageSize - Int + The maximum number of pickup locations to return at once. The attribute is optional. Default = 20
+ currentPage - Int + Specifies which page of results to return. The default value is 1. Default = 1
+ productsInfo - [ProductInfoInput] + Information about products which should be delivered.
+
+
+
+

Example

+
+
Query
+ 
query pickupLocations(
+  $area: AreaInput,
+  $filters: PickupLocationFilterInput,
+  $sort: PickupLocationSortInput,
+  $pageSize: Int,
+  $currentPage: Int,
+  $productsInfo: [ProductInfoInput]
+) {
+  pickupLocations(
+    area: $area,
+    filters: $filters,
+    sort: $sort,
+    pageSize: $pageSize,
+    currentPage: $currentPage,
+    productsInfo: $productsInfo
+  ) {
+    items {
+      ...PickupLocationFragment
+    }
+    page_info {
+      ...SearchResultPageInfoFragment
+    }
+    total_count
+  }
+}
+
+
+
+
Variables
+ 
{
+  "area": AreaInput,
+  "filters": PickupLocationFilterInput,
+  "sort": PickupLocationSortInput,
+  "pageSize": 20,
+  "currentPage": 1,
+  "productsInfo": [ProductInfoInput]
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "pickupLocations": {
+      "items": [PickupLocation],
+      "page_info": SearchResultPageInfo,
+      "total_count": 987
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ productReviewRatingsMetadata +

+
+
+
+
Description
+

Return the active ratings attributes and the values each rating can have.

+
+
+
+
+
+
+
Response
+

Returns a ProductReviewRatingsMetadata! +

+
+
+
+

Example

+
+
Query
+ 
query productReviewRatingsMetadata {
+  productReviewRatingsMetadata {
+    items {
+      ...ProductReviewRatingMetadataFragment
+    }
+  }
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "productReviewRatingsMetadata": {
+      "items": [ProductReviewRatingMetadata]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ products +

+
+
+
+
Description
+

Search for products that match the criteria specified in the search and filter attributes.

+
+
+
+
+
+
+
Response
+

Returns a Products +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
+ search - String + One or more keywords to use in a full-text search.
+ filter - ProductAttributeFilterInput + The product attributes to search for and return.
+ pageSize - Int + The maximum number of results to return at once. The default value is 20. Default = 20
+ currentPage - Int + The page of results to return. The default value is 1. Default = 1
+ sort - ProductAttributeSortInput + Specifies which attributes to sort on, and whether to return the results in ascending or descending order.
+
+
+
+

Example

+
+
Query
+ 
query products(
+  $search: String,
+  $filter: ProductAttributeFilterInput,
+  $pageSize: Int,
+  $currentPage: Int,
+  $sort: ProductAttributeSortInput
+) {
+  products(
+    search: $search,
+    filter: $filter,
+    pageSize: $pageSize,
+    currentPage: $currentPage,
+    sort: $sort
+  ) {
+    aggregations {
+      ...AggregationFragment
+    }
+    filters {
+      ...LayerFilterFragment
+    }
+    items {
+      ...ProductInterfaceFragment
+    }
+    page_info {
+      ...SearchResultPageInfoFragment
+    }
+    sort_fields {
+      ...SortFieldsFragment
+    }
+    suggestions {
+      ...SearchSuggestionFragment
+    }
+    total_count
+  }
+}
+
+
+
+
Variables
+ 
{
+  "search": "xyz789",
+  "filter": ProductAttributeFilterInput,
+  "pageSize": 20,
+  "currentPage": 1,
+  "sort": ProductAttributeSortInput
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "products": {
+      "aggregations": [Aggregation],
+      "filters": [LayerFilter],
+      "items": [ProductInterface],
+      "page_info": SearchResultPageInfo,
+      "sort_fields": SortFields,
+      "suggestions": [SearchSuggestion],
+      "total_count": 987
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ recaptchaFormConfig +

+
+
+
+
Response
+

Returns a ReCaptchaConfigOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ formType - ReCaptchaFormEnum! + +
+
+
+
+

Example

+
+
Query
+ 
query recaptchaFormConfig($formType: ReCaptchaFormEnum!) {
+  recaptchaFormConfig(formType: $formType) {
+    configurations {
+      ...ReCaptchaConfigurationFragment
+    }
+    is_enabled
+  }
+}
+
+
+
+
Variables
+ 
{"formType": "PLACE_ORDER"}
+
+
+
+
Response
+ 
{
+  "data": {
+    "recaptchaFormConfig": {
+      "configurations": ReCaptchaConfiguration,
+      "is_enabled": false
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ recaptchaV3Config +

+
+
+
+
Description
+

Returns details about Google reCAPTCHA V3-Invisible configuration.

+
+
+
+
+
+
+
Response
+

Returns a ReCaptchaConfigurationV3 +

+
+
+
+

Example

+
+
Query
+ 
query recaptchaV3Config {
+  recaptchaV3Config {
+    badge_position
+    failure_message
+    forms
+    is_enabled
+    language_code
+    minimum_score
+    theme
+    website_key
+  }
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "recaptchaV3Config": {
+      "badge_position": "xyz789",
+      "failure_message": "xyz789",
+      "forms": ["PLACE_ORDER"],
+      "is_enabled": false,
+      "language_code": "abc123",
+      "minimum_score": 123.45,
+      "theme": "abc123",
+      "website_key": "abc123"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ route +

+
+
+
+
Description
+

Return the full details for a specified product, category, or CMS page.

+
+
+
+
+
+
+
Response
+

Returns a RoutableInterface +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ url - String! + A url_key appended by the `url_suffix, if one exists.
+
+
+
+

Example

+
+
Query
+ 
query route($url: String!) {
+  route(url: $url) {
+    redirect_code
+    relative_url
+    type
+  }
+}
+
+
+
+
Variables
+ 
{"url": "xyz789"}
+
+
+
+
Response
+ 
{
+  "data": {
+    "route": {
+      "redirect_code": 123,
+      "relative_url": "xyz789",
+      "type": "CMS_PAGE"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ storeConfig +

+
+
+
+
Description
+

Return details about the store's configuration.

+
+
+
+
+
+
+
Response
+

Returns a StoreConfig +

+
+
+
+

Example

+
+
Query
+ 
query storeConfig {
+  storeConfig {
+    absolute_footer
+    allow_gift_receipt
+    allow_gift_wrapping_on_order
+    allow_gift_wrapping_on_order_items
+    allow_guests_to_write_product_reviews
+    allow_items
+    allow_order
+    allow_printed_card
+    autocomplete_on_storefront
+    base_currency_code
+    base_link_url
+    base_media_url
+    base_static_url
+    base_url
+    braintree_3dsecure_allowspecific
+    braintree_3dsecure_always_request_3ds
+    braintree_3dsecure_specificcountry
+    braintree_3dsecure_threshold_amount
+    braintree_3dsecure_verify_3dsecure
+    braintree_ach_direct_debit_vault_active
+    braintree_applepay_merchant_name
+    braintree_applepay_vault_active
+    braintree_cc_vault_active
+    braintree_cc_vault_cvv
+    braintree_environment
+    braintree_googlepay_btn_color
+    braintree_googlepay_cctypes
+    braintree_googlepay_merchant_id
+    braintree_googlepay_vault_active
+    braintree_local_payment_allowed_methods
+    braintree_local_payment_fallback_button_text
+    braintree_local_payment_redirect_on_fail
+    braintree_merchant_account_id
+    braintree_paypal_button_location_cart_type_credit_color
+    braintree_paypal_button_location_cart_type_credit_label
+    braintree_paypal_button_location_cart_type_credit_shape
+    braintree_paypal_button_location_cart_type_credit_show
+    braintree_paypal_button_location_cart_type_messaging_layout
+    braintree_paypal_button_location_cart_type_messaging_logo
+    braintree_paypal_button_location_cart_type_messaging_logo_position
+    braintree_paypal_button_location_cart_type_messaging_show
+    braintree_paypal_button_location_cart_type_messaging_text_color
+    braintree_paypal_button_location_cart_type_paylater_color
+    braintree_paypal_button_location_cart_type_paylater_label
+    braintree_paypal_button_location_cart_type_paylater_shape
+    braintree_paypal_button_location_cart_type_paylater_show
+    braintree_paypal_button_location_cart_type_paypal_color
+    braintree_paypal_button_location_cart_type_paypal_label
+    braintree_paypal_button_location_cart_type_paypal_shape
+    braintree_paypal_button_location_cart_type_paypal_show
+    braintree_paypal_button_location_checkout_type_credit_color
+    braintree_paypal_button_location_checkout_type_credit_label
+    braintree_paypal_button_location_checkout_type_credit_shape
+    braintree_paypal_button_location_checkout_type_credit_show
+    braintree_paypal_button_location_checkout_type_messaging_layout
+    braintree_paypal_button_location_checkout_type_messaging_logo
+    braintree_paypal_button_location_checkout_type_messaging_logo_position
+    braintree_paypal_button_location_checkout_type_messaging_show
+    braintree_paypal_button_location_checkout_type_messaging_text_color
+    braintree_paypal_button_location_checkout_type_paylater_color
+    braintree_paypal_button_location_checkout_type_paylater_label
+    braintree_paypal_button_location_checkout_type_paylater_shape
+    braintree_paypal_button_location_checkout_type_paylater_show
+    braintree_paypal_button_location_checkout_type_paypal_color
+    braintree_paypal_button_location_checkout_type_paypal_label
+    braintree_paypal_button_location_checkout_type_paypal_shape
+    braintree_paypal_button_location_checkout_type_paypal_show
+    braintree_paypal_button_location_productpage_type_credit_color
+    braintree_paypal_button_location_productpage_type_credit_label
+    braintree_paypal_button_location_productpage_type_credit_shape
+    braintree_paypal_button_location_productpage_type_credit_show
+    braintree_paypal_button_location_productpage_type_messaging_layout
+    braintree_paypal_button_location_productpage_type_messaging_logo
+    braintree_paypal_button_location_productpage_type_messaging_logo_position
+    braintree_paypal_button_location_productpage_type_messaging_show
+    braintree_paypal_button_location_productpage_type_messaging_text_color
+    braintree_paypal_button_location_productpage_type_paylater_color
+    braintree_paypal_button_location_productpage_type_paylater_label
+    braintree_paypal_button_location_productpage_type_paylater_shape
+    braintree_paypal_button_location_productpage_type_paylater_show
+    braintree_paypal_button_location_productpage_type_paypal_color
+    braintree_paypal_button_location_productpage_type_paypal_label
+    braintree_paypal_button_location_productpage_type_paypal_shape
+    braintree_paypal_button_location_productpage_type_paypal_show
+    braintree_paypal_credit_uk_merchant_name
+    braintree_paypal_display_on_shopping_cart
+    braintree_paypal_merchant_country
+    braintree_paypal_merchant_name_override
+    braintree_paypal_require_billing_address
+    braintree_paypal_send_cart_line_items
+    braintree_paypal_vault_active
+    cart_expires_in_days
+    cart_gift_wrapping
+    cart_merge_preference
+    cart_printed_card
+    cart_summary_display_quantity
+    catalog_default_sort_by
+    category_fixed_product_tax_display_setting
+    category_url_suffix
+    check_money_order_enable_for_specific_countries
+    check_money_order_enabled
+    check_money_order_make_check_payable_to
+    check_money_order_max_order_total
+    check_money_order_min_order_total
+    check_money_order_new_order_status
+    check_money_order_payment_from_specific_countries
+    check_money_order_send_check_to
+    check_money_order_sort_order
+    check_money_order_title
+    cms_home_page
+    cms_no_cookies
+    cms_no_route
+    code
+    configurable_product_image
+    configurable_thumbnail_source
+    contact_enabled
+    copyright
+    countries_with_required_region
+    create_account_confirmation
+    customer_access_token_lifetime
+    default_country
+    default_description
+    default_display_currency_code
+    default_keywords
+    default_title
+    demonotice
+    display_product_prices_in_catalog
+    display_shipping_prices
+    display_state_if_optional
+    enable_multiple_wishlists
+    fixed_product_taxes_apply_tax_to_fpt
+    fixed_product_taxes_display_prices_in_emails
+    fixed_product_taxes_display_prices_in_product_lists
+    fixed_product_taxes_display_prices_in_sales_modules
+    fixed_product_taxes_display_prices_on_product_view_page
+    fixed_product_taxes_enable
+    fixed_product_taxes_include_fpt_in_subtotal
+    front
+    graphql_share_customer_group
+    grid_per_page
+    grid_per_page_values
+    grouped_product_image
+    head_includes
+    head_shortcut_icon
+    header_logo_src
+    id
+    is_checkout_agreements_enabled
+    is_default_store
+    is_default_store_group
+    is_guest_checkout_enabled
+    is_negotiable_quote_active
+    is_one_page_checkout_enabled
+    is_requisition_list_active
+    list_mode
+    list_per_page
+    list_per_page_values
+    locale
+    logo_alt
+    logo_height
+    logo_width
+    magento_reward_general_is_enabled
+    magento_reward_general_is_enabled_on_front
+    magento_reward_general_min_points_balance
+    magento_reward_general_publish_history
+    magento_reward_points_invitation_customer
+    magento_reward_points_invitation_customer_limit
+    magento_reward_points_invitation_order
+    magento_reward_points_invitation_order_limit
+    magento_reward_points_newsletter
+    magento_reward_points_order
+    magento_reward_points_register
+    magento_reward_points_review
+    magento_reward_points_review_limit
+    magento_wishlist_general_is_enabled
+    max_items_in_order_summary
+    maximum_number_of_wishlists
+    minicart_display
+    minicart_max_items
+    minimum_password_length
+    newsletter_enabled
+    no_route
+    optional_zip_countries
+    order_cancellation_enabled
+    order_cancellation_reasons {
+      ...CancellationReasonFragment
+    }
+    orders_invoices_credit_memos_display_full_summary
+    orders_invoices_credit_memos_display_grandtotal
+    orders_invoices_credit_memos_display_price
+    orders_invoices_credit_memos_display_shipping_amount
+    orders_invoices_credit_memos_display_subtotal
+    orders_invoices_credit_memos_display_zero_tax
+    payment_payflowpro_cc_vault_active
+    printed_card_price
+    printed_card_priceV2 {
+      ...MoneyFragment
+    }
+    product_fixed_product_tax_display_setting
+    product_reviews_enabled
+    product_url_suffix
+    quickorder_active
+    required_character_classes_number
+    returns_enabled
+    root_category_id
+    root_category_uid
+    sales_fixed_product_tax_display_setting
+    sales_gift_wrapping
+    sales_printed_card
+    secure_base_link_url
+    secure_base_media_url
+    secure_base_static_url
+    secure_base_url
+    send_friend {
+      ...SendFriendConfigurationFragment
+    }
+    share_active_segments
+    share_applied_cart_rule
+    shopping_cart_display_full_summary
+    shopping_cart_display_grand_total
+    shopping_cart_display_price
+    shopping_cart_display_shipping
+    shopping_cart_display_subtotal
+    shopping_cart_display_tax_gift_wrapping
+    shopping_cart_display_zero_tax
+    show_cms_breadcrumbs
+    store_code
+    store_group_code
+    store_group_name
+    store_name
+    store_sort_order
+    timezone
+    title_prefix
+    title_separator
+    title_suffix
+    use_store_in_url
+    website_code
+    website_id
+    website_name
+    weight_unit
+    welcome
+    zero_subtotal_enable_for_specific_countries
+    zero_subtotal_enabled
+    zero_subtotal_new_order_status
+    zero_subtotal_payment_action
+    zero_subtotal_payment_from_specific_countries
+    zero_subtotal_sort_order
+    zero_subtotal_title
+  }
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "storeConfig": {
+      "absolute_footer": "xyz789",
+      "allow_gift_receipt": "xyz789",
+      "allow_gift_wrapping_on_order": "abc123",
+      "allow_gift_wrapping_on_order_items": "abc123",
+      "allow_guests_to_write_product_reviews": "abc123",
+      "allow_items": "xyz789",
+      "allow_order": "abc123",
+      "allow_printed_card": "abc123",
+      "autocomplete_on_storefront": true,
+      "base_currency_code": "abc123",
+      "base_link_url": "abc123",
+      "base_media_url": "xyz789",
+      "base_static_url": "xyz789",
+      "base_url": "abc123",
+      "braintree_3dsecure_allowspecific": false,
+      "braintree_3dsecure_always_request_3ds": false,
+      "braintree_3dsecure_specificcountry": "xyz789",
+      "braintree_3dsecure_threshold_amount": "abc123",
+      "braintree_3dsecure_verify_3dsecure": true,
+      "braintree_ach_direct_debit_vault_active": false,
+      "braintree_applepay_merchant_name": "abc123",
+      "braintree_applepay_vault_active": false,
+      "braintree_cc_vault_active": "abc123",
+      "braintree_cc_vault_cvv": false,
+      "braintree_environment": "xyz789",
+      "braintree_googlepay_btn_color": "abc123",
+      "braintree_googlepay_cctypes": "abc123",
+      "braintree_googlepay_merchant_id": "abc123",
+      "braintree_googlepay_vault_active": true,
+      "braintree_local_payment_allowed_methods": "xyz789",
+      "braintree_local_payment_fallback_button_text": "xyz789",
+      "braintree_local_payment_redirect_on_fail": "xyz789",
+      "braintree_merchant_account_id": "abc123",
+      "braintree_paypal_button_location_cart_type_credit_color": "xyz789",
+      "braintree_paypal_button_location_cart_type_credit_label": "abc123",
+      "braintree_paypal_button_location_cart_type_credit_shape": "xyz789",
+      "braintree_paypal_button_location_cart_type_credit_show": true,
+      "braintree_paypal_button_location_cart_type_messaging_layout": "abc123",
+      "braintree_paypal_button_location_cart_type_messaging_logo": "xyz789",
+      "braintree_paypal_button_location_cart_type_messaging_logo_position": "xyz789",
+      "braintree_paypal_button_location_cart_type_messaging_show": false,
+      "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123",
+      "braintree_paypal_button_location_cart_type_paylater_color": "xyz789",
+      "braintree_paypal_button_location_cart_type_paylater_label": "abc123",
+      "braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
+      "braintree_paypal_button_location_cart_type_paylater_show": true,
+      "braintree_paypal_button_location_cart_type_paypal_color": "abc123",
+      "braintree_paypal_button_location_cart_type_paypal_label": "xyz789",
+      "braintree_paypal_button_location_cart_type_paypal_shape": "xyz789",
+      "braintree_paypal_button_location_cart_type_paypal_show": true,
+      "braintree_paypal_button_location_checkout_type_credit_color": "xyz789",
+      "braintree_paypal_button_location_checkout_type_credit_label": "abc123",
+      "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789",
+      "braintree_paypal_button_location_checkout_type_credit_show": false,
+      "braintree_paypal_button_location_checkout_type_messaging_layout": "abc123",
+      "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789",
+      "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789",
+      "braintree_paypal_button_location_checkout_type_messaging_show": true,
+      "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123",
+      "braintree_paypal_button_location_checkout_type_paylater_color": "abc123",
+      "braintree_paypal_button_location_checkout_type_paylater_label": "abc123",
+      "braintree_paypal_button_location_checkout_type_paylater_shape": "abc123",
+      "braintree_paypal_button_location_checkout_type_paylater_show": true,
+      "braintree_paypal_button_location_checkout_type_paypal_color": "abc123",
+      "braintree_paypal_button_location_checkout_type_paypal_label": "abc123",
+      "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789",
+      "braintree_paypal_button_location_checkout_type_paypal_show": true,
+      "braintree_paypal_button_location_productpage_type_credit_color": "abc123",
+      "braintree_paypal_button_location_productpage_type_credit_label": "abc123",
+      "braintree_paypal_button_location_productpage_type_credit_shape": "abc123",
+      "braintree_paypal_button_location_productpage_type_credit_show": true,
+      "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789",
+      "braintree_paypal_button_location_productpage_type_messaging_logo": "abc123",
+      "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789",
+      "braintree_paypal_button_location_productpage_type_messaging_show": true,
+      "braintree_paypal_button_location_productpage_type_messaging_text_color": "abc123",
+      "braintree_paypal_button_location_productpage_type_paylater_color": "abc123",
+      "braintree_paypal_button_location_productpage_type_paylater_label": "abc123",
+      "braintree_paypal_button_location_productpage_type_paylater_shape": "abc123",
+      "braintree_paypal_button_location_productpage_type_paylater_show": false,
+      "braintree_paypal_button_location_productpage_type_paypal_color": "xyz789",
+      "braintree_paypal_button_location_productpage_type_paypal_label": "xyz789",
+      "braintree_paypal_button_location_productpage_type_paypal_shape": "xyz789",
+      "braintree_paypal_button_location_productpage_type_paypal_show": true,
+      "braintree_paypal_credit_uk_merchant_name": "abc123",
+      "braintree_paypal_display_on_shopping_cart": true,
+      "braintree_paypal_merchant_country": "abc123",
+      "braintree_paypal_merchant_name_override": "xyz789",
+      "braintree_paypal_require_billing_address": true,
+      "braintree_paypal_send_cart_line_items": true,
+      "braintree_paypal_vault_active": true,
+      "cart_expires_in_days": 987,
+      "cart_gift_wrapping": "abc123",
+      "cart_merge_preference": "xyz789",
+      "cart_printed_card": "abc123",
+      "cart_summary_display_quantity": 987,
+      "catalog_default_sort_by": "abc123",
+      "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
+      "category_url_suffix": "xyz789",
+      "check_money_order_enable_for_specific_countries": true,
+      "check_money_order_enabled": false,
+      "check_money_order_make_check_payable_to": "abc123",
+      "check_money_order_max_order_total": "abc123",
+      "check_money_order_min_order_total": "xyz789",
+      "check_money_order_new_order_status": "xyz789",
+      "check_money_order_payment_from_specific_countries": "abc123",
+      "check_money_order_send_check_to": "xyz789",
+      "check_money_order_sort_order": 987,
+      "check_money_order_title": "xyz789",
+      "cms_home_page": "xyz789",
+      "cms_no_cookies": "abc123",
+      "cms_no_route": "abc123",
+      "code": "xyz789",
+      "configurable_product_image": "ITSELF",
+      "configurable_thumbnail_source": "xyz789",
+      "contact_enabled": false,
+      "copyright": "abc123",
+      "countries_with_required_region": "abc123",
+      "create_account_confirmation": true,
+      "customer_access_token_lifetime": 987.65,
+      "default_country": "xyz789",
+      "default_description": "xyz789",
+      "default_display_currency_code": "abc123",
+      "default_keywords": "xyz789",
+      "default_title": "xyz789",
+      "demonotice": 123,
+      "display_product_prices_in_catalog": 987,
+      "display_shipping_prices": 987,
+      "display_state_if_optional": false,
+      "enable_multiple_wishlists": "abc123",
+      "fixed_product_taxes_apply_tax_to_fpt": false,
+      "fixed_product_taxes_display_prices_in_emails": 987,
+      "fixed_product_taxes_display_prices_in_product_lists": 987,
+      "fixed_product_taxes_display_prices_in_sales_modules": 987,
+      "fixed_product_taxes_display_prices_on_product_view_page": 123,
+      "fixed_product_taxes_enable": false,
+      "fixed_product_taxes_include_fpt_in_subtotal": true,
+      "front": "abc123",
+      "graphql_share_customer_group": false,
+      "grid_per_page": 123,
+      "grid_per_page_values": "abc123",
+      "grouped_product_image": "ITSELF",
+      "head_includes": "abc123",
+      "head_shortcut_icon": "abc123",
+      "header_logo_src": "xyz789",
+      "id": 987,
+      "is_checkout_agreements_enabled": false,
+      "is_default_store": false,
+      "is_default_store_group": true,
+      "is_guest_checkout_enabled": true,
+      "is_negotiable_quote_active": false,
+      "is_one_page_checkout_enabled": true,
+      "is_requisition_list_active": "xyz789",
+      "list_mode": "abc123",
+      "list_per_page": 987,
+      "list_per_page_values": "abc123",
+      "locale": "xyz789",
+      "logo_alt": "abc123",
+      "logo_height": 987,
+      "logo_width": 123,
+      "magento_reward_general_is_enabled": "xyz789",
+      "magento_reward_general_is_enabled_on_front": "xyz789",
+      "magento_reward_general_min_points_balance": "xyz789",
+      "magento_reward_general_publish_history": "xyz789",
+      "magento_reward_points_invitation_customer": "abc123",
+      "magento_reward_points_invitation_customer_limit": "abc123",
+      "magento_reward_points_invitation_order": "xyz789",
+      "magento_reward_points_invitation_order_limit": "abc123",
+      "magento_reward_points_newsletter": "xyz789",
+      "magento_reward_points_order": "abc123",
+      "magento_reward_points_register": "abc123",
+      "magento_reward_points_review": "xyz789",
+      "magento_reward_points_review_limit": "abc123",
+      "magento_wishlist_general_is_enabled": "abc123",
+      "max_items_in_order_summary": 123,
+      "maximum_number_of_wishlists": "xyz789",
+      "minicart_display": true,
+      "minicart_max_items": 123,
+      "minimum_password_length": "xyz789",
+      "newsletter_enabled": false,
+      "no_route": "abc123",
+      "optional_zip_countries": "abc123",
+      "order_cancellation_enabled": true,
+      "order_cancellation_reasons": [CancellationReason],
+      "orders_invoices_credit_memos_display_full_summary": false,
+      "orders_invoices_credit_memos_display_grandtotal": true,
+      "orders_invoices_credit_memos_display_price": 123,
+      "orders_invoices_credit_memos_display_shipping_amount": 987,
+      "orders_invoices_credit_memos_display_subtotal": 123,
+      "orders_invoices_credit_memos_display_zero_tax": true,
+      "payment_payflowpro_cc_vault_active": "abc123",
+      "printed_card_price": "xyz789",
+      "printed_card_priceV2": Money,
+      "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
+      "product_reviews_enabled": "xyz789",
+      "product_url_suffix": "abc123",
+      "quickorder_active": true,
+      "required_character_classes_number": "xyz789",
+      "returns_enabled": "xyz789",
+      "root_category_id": 123,
+      "root_category_uid": 4,
+      "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
+      "sales_gift_wrapping": "xyz789",
+      "sales_printed_card": "abc123",
+      "secure_base_link_url": "xyz789",
+      "secure_base_media_url": "xyz789",
+      "secure_base_static_url": "abc123",
+      "secure_base_url": "abc123",
+      "send_friend": SendFriendConfiguration,
+      "share_active_segments": true,
+      "share_applied_cart_rule": true,
+      "shopping_cart_display_full_summary": false,
+      "shopping_cart_display_grand_total": true,
+      "shopping_cart_display_price": 123,
+      "shopping_cart_display_shipping": 987,
+      "shopping_cart_display_subtotal": 987,
+      "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
+      "shopping_cart_display_zero_tax": true,
+      "show_cms_breadcrumbs": 987,
+      "store_code": 4,
+      "store_group_code": "4",
+      "store_group_name": "abc123",
+      "store_name": "abc123",
+      "store_sort_order": 123,
+      "timezone": "abc123",
+      "title_prefix": "xyz789",
+      "title_separator": "abc123",
+      "title_suffix": "xyz789",
+      "use_store_in_url": false,
+      "website_code": 4,
+      "website_id": 123,
+      "website_name": "xyz789",
+      "weight_unit": "abc123",
+      "welcome": "abc123",
+      "zero_subtotal_enable_for_specific_countries": true,
+      "zero_subtotal_enabled": true,
+      "zero_subtotal_new_order_status": "abc123",
+      "zero_subtotal_payment_action": "xyz789",
+      "zero_subtotal_payment_from_specific_countries": "xyz789",
+      "zero_subtotal_sort_order": 987,
+      "zero_subtotal_title": "abc123"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ urlResolver +

+
+
+
+
Use the route query instead.
+
+
+
+
+
+
+
Description
+

Return the relative URL for a specified product, category or CMS page.

+
+
+
+
+
+
+
Response
+

Returns an EntityUrl +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ url - String! + A url_key appended by the `url_suffix, if one exists.
+
+
+
+

Example

+
+
Query
+ 
query urlResolver($url: String!) {
+  urlResolver(url: $url) {
+    canonical_url
+    entity_uid
+    id
+    redirectCode
+    relative_url
+    type
+  }
+}
+
+
+
+
Variables
+ 
{"url": "xyz789"}
+
+
+
+
Response
+ 
{
+  "data": {
+    "urlResolver": {
+      "canonical_url": "abc123",
+      "entity_uid": "4",
+      "id": 123,
+      "redirectCode": 123,
+      "relative_url": "abc123",
+      "type": "CMS_PAGE"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Queries +
+

+ wishlist +

+
+
+
+
Moved under Customer.wishlist.
+
+
+
+
+
+
+
Description
+

Return the contents of a customer's wish list.

+
+
+
+
+
+
+
Response
+

Returns a WishlistOutput +

+
+
+
+

Example

+
+
Query
+ 
query wishlist {
+  wishlist {
+    items {
+      ...WishlistItemFragment
+    }
+    items_count
+    name
+    sharing_code
+    updated_at
+  }
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "wishlist": {
+      "items": [WishlistItem],
+      "items_count": 987,
+      "name": "abc123",
+      "sharing_code": "abc123",
+      "updated_at": "xyz789"
+    }
+  }
+}
+
+
+
+
+
+

Mutations

+
+

+ acceptCompanyInvitation +

+
+
+
+
Description
+

Accept invitation to the company.

+
+
+
+
+
+
+
Response
+

Returns a CompanyInvitationOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CompanyInvitationInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation acceptCompanyInvitation($input: CompanyInvitationInput!) {
+  acceptCompanyInvitation(input: $input) {
+    success
+  }
+}
+
+
+
+
Variables
+ 
{"input": CompanyInvitationInput}
+
+
+
+
Response
+ 
{"data": {"acceptCompanyInvitation": {"success": true}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ acceptNegotiableQuoteTemplate +

+
+
+
+
Description
+

Update an existing negotiable quote template.

+
+
+
+
+
+
+
Response
+

Returns a NegotiableQuoteTemplate +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - AcceptNegotiableQuoteTemplateInput! + An input object that contains the data to update a negotiable quote template.
+
+
+
+

Example

+
+
Query
+ 
mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInput!) {
+  acceptNegotiableQuoteTemplate(input: $input) {
+    buyer {
+      ...NegotiableQuoteUserFragment
+    }
+    comments {
+      ...NegotiableQuoteCommentFragment
+    }
+    expiration_date
+    history {
+      ...NegotiableQuoteHistoryEntryFragment
+    }
+    is_min_max_qty_used
+    is_virtual
+    items {
+      ...CartItemInterfaceFragment
+    }
+    max_order_commitment
+    min_order_commitment
+    name
+    notifications {
+      ...QuoteTemplateNotificationMessageFragment
+    }
+    prices {
+      ...CartPricesFragment
+    }
+    reference_document_links {
+      ...NegotiableQuoteReferenceDocumentLinkFragment
+    }
+    shipping_addresses {
+      ...NegotiableQuoteShippingAddressFragment
+    }
+    status
+    template_id
+    total_quantity
+  }
+}
+
+
+
+
Variables
+ 
{"input": AcceptNegotiableQuoteTemplateInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "acceptNegotiableQuoteTemplate": {
+      "buyer": NegotiableQuoteUser,
+      "comments": [NegotiableQuoteComment],
+      "expiration_date": "abc123",
+      "history": [NegotiableQuoteHistoryEntry],
+      "is_min_max_qty_used": true,
+      "is_virtual": true,
+      "items": [CartItemInterface],
+      "max_order_commitment": 123,
+      "min_order_commitment": 987,
+      "name": "xyz789",
+      "notifications": [QuoteTemplateNotificationMessage],
+      "prices": CartPrices,
+      "reference_document_links": [
+        NegotiableQuoteReferenceDocumentLink
+      ],
+      "shipping_addresses": [
+        NegotiableQuoteShippingAddress
+      ],
+      "status": "xyz789",
+      "template_id": "4",
+      "total_quantity": 123.45
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ addBundleProductsToCart +

+
+
+
+
Description
+

Add one or more bundle products to the specified cart. We recommend using addProductsToCart instead.

+
+
+
+
+
+
+
Response
+

Returns an AddBundleProductsToCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - AddBundleProductsToCartInput + An input object that defines which bundle products to add to the cart.
+
+
+
+

Example

+
+
Query
+ 
mutation addBundleProductsToCart($input: AddBundleProductsToCartInput) {
+  addBundleProductsToCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": AddBundleProductsToCartInput}
+
+
+
+
Response
+ 
{"data": {"addBundleProductsToCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ addConfigurableProductsToCart +

+
+
+
+
Description
+

Add one or more configurable products to the specified cart. We recommend using addProductsToCart instead.

+
+
+
+
+
+
+
Response
+

Returns an AddConfigurableProductsToCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - AddConfigurableProductsToCartInput + An input object that defines which configurable products to add to the cart.
+
+
+
+

Example

+
+
Query
+ 
mutation addConfigurableProductsToCart($input: AddConfigurableProductsToCartInput) {
+  addConfigurableProductsToCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": AddConfigurableProductsToCartInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "addConfigurableProductsToCart": {"cart": Cart}
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ addDownloadableProductsToCart +

+
+
+
+
Description
+

Add one or more downloadable products to the specified cart. We recommend using addProductsToCart instead.

+
+
+
+
+
+
+
Response
+

Returns an AddDownloadableProductsToCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - AddDownloadableProductsToCartInput + An input object that defines which downloadable products to add to the cart.
+
+
+
+

Example

+
+
Query
+ 
mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInput) {
+  addDownloadableProductsToCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": AddDownloadableProductsToCartInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "addDownloadableProductsToCart": {"cart": Cart}
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ addGiftRegistryRegistrants +

+
+
+
+
Description
+

Add registrants to the specified gift registry.

+
+
+
+
+
+
+
Response
+

Returns an AddGiftRegistryRegistrantsOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ giftRegistryUid - ID! + The unique ID of the gift registry.
+ registrants - [AddGiftRegistryRegistrantInput!]! + An array registrants to add.
+
+
+
+

Example

+
+
Query
+ 
mutation addGiftRegistryRegistrants(
+  $giftRegistryUid: ID!,
+  $registrants: [AddGiftRegistryRegistrantInput!]!
+) {
+  addGiftRegistryRegistrants(
+    giftRegistryUid: $giftRegistryUid,
+    registrants: $registrants
+  ) {
+    gift_registry {
+      ...GiftRegistryFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{
+  "giftRegistryUid": 4,
+  "registrants": [AddGiftRegistryRegistrantInput]
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "addGiftRegistryRegistrants": {
+      "gift_registry": GiftRegistry
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ addProductsToCart +

+
+
+
+
Description
+

Add any type of product to the cart.

+
+
+
+
+
+
+
Response
+

Returns an AddProductsToCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ cartId - String! + The cart ID of the shopper.
+ cartItems - [CartItemInput!]! + An array that defines the products to add to the cart.
+
+
+
+

Example

+
+
Query
+ 
mutation addProductsToCart(
+  $cartId: String!,
+  $cartItems: [CartItemInput!]!
+) {
+  addProductsToCart(
+    cartId: $cartId,
+    cartItems: $cartItems
+  ) {
+    cart {
+      ...CartFragment
+    }
+    user_errors {
+      ...ErrorFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{
+  "cartId": "xyz789",
+  "cartItems": [CartItemInput]
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "addProductsToCart": {
+      "cart": Cart,
+      "user_errors": [Error]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ addProductsToCompareList +

+
+
+
+
Description
+

Add products to the specified compare list.

+
+
+
+
+
+
+
Response
+

Returns a CompareList +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - AddProductsToCompareListInput + An input object that defines which products to add to an existing compare list.
+
+
+
+

Example

+
+
Query
+ 
mutation addProductsToCompareList($input: AddProductsToCompareListInput) {
+  addProductsToCompareList(input: $input) {
+    attributes {
+      ...ComparableAttributeFragment
+    }
+    item_count
+    items {
+      ...ComparableItemFragment
+    }
+    uid
+  }
+}
+
+
+
+
Variables
+ 
{"input": AddProductsToCompareListInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "addProductsToCompareList": {
+      "attributes": [ComparableAttribute],
+      "item_count": 987,
+      "items": [ComparableItem],
+      "uid": 4
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ addProductsToNewCart +

+
+
+
+
Description
+

Creates a new cart and add any type of product to it

+
+
+
+
+
+
+
Response
+

Returns an AddProductsToNewCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ cartItems - [CartItemInput!]! + An array that defines the products to add to the new cart
+
+
+
+

Example

+
+
Query
+ 
mutation addProductsToNewCart($cartItems: [CartItemInput!]!) {
+  addProductsToNewCart(cartItems: $cartItems) {
+    cart {
+      ...CartFragment
+    }
+    user_errors {
+      ...CartUserInputErrorFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"cartItems": [CartItemInput]}
+
+
+
+
Response
+ 
{
+  "data": {
+    "addProductsToNewCart": {
+      "cart": Cart,
+      "user_errors": [CartUserInputError]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ addProductsToRequisitionList +

+
+
+
+
Description
+

Add items to the specified requisition list.

+
+
+
+
+
+
+
Response
+

Returns an AddProductsToRequisitionListOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ requisitionListUid - ID! + The unique ID of the requisition list.
+ requisitionListItems - [RequisitionListItemsInput!]! + An array of products to be added to the requisition list.
+
+
+
+

Example

+
+
Query
+ 
mutation addProductsToRequisitionList(
+  $requisitionListUid: ID!,
+  $requisitionListItems: [RequisitionListItemsInput!]!
+) {
+  addProductsToRequisitionList(
+    requisitionListUid: $requisitionListUid,
+    requisitionListItems: $requisitionListItems
+  ) {
+    requisition_list {
+      ...RequisitionListFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{
+  "requisitionListUid": "4",
+  "requisitionListItems": [RequisitionListItemsInput]
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "addProductsToRequisitionList": {
+      "requisition_list": RequisitionList
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ addProductsToWishlist +

+
+
+
+
Description
+

Add one or more products to the specified wish list. This mutation supports all product types.

+
+
+
+
+
+
+
Response
+

Returns an AddProductsToWishlistOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ wishlistId - ID! + The ID of a wish list.
+ wishlistItems - [WishlistItemInput!]! + An array of products to add to the wish list.
+
+
+
+

Example

+
+
Query
+ 
mutation addProductsToWishlist(
+  $wishlistId: ID!,
+  $wishlistItems: [WishlistItemInput!]!
+) {
+  addProductsToWishlist(
+    wishlistId: $wishlistId,
+    wishlistItems: $wishlistItems
+  ) {
+    user_errors {
+      ...WishListUserInputErrorFragment
+    }
+    wishlist {
+      ...WishlistFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"wishlistId": 4, "wishlistItems": [WishlistItemInput]}
+
+
+
+
Response
+ 
{
+  "data": {
+    "addProductsToWishlist": {
+      "user_errors": [WishListUserInputError],
+      "wishlist": Wishlist
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ addPurchaseOrderComment +

+
+
+
+
Description
+

Add a comment to an existing purchase order.

+
+
+
+
+
+
+
Response
+

Returns an AddPurchaseOrderCommentOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - AddPurchaseOrderCommentInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) {
+  addPurchaseOrderComment(input: $input) {
+    comment {
+      ...PurchaseOrderCommentFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": AddPurchaseOrderCommentInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "addPurchaseOrderComment": {
+      "comment": PurchaseOrderComment
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ addPurchaseOrderItemsToCart +

+
+
+
+
Description
+

Add purchase order items to the shopping cart.

+
+
+
+
+
+
+
Response
+

Returns an AddProductsToCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - AddPurchaseOrderItemsToCartInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) {
+  addPurchaseOrderItemsToCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+    user_errors {
+      ...ErrorFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": AddPurchaseOrderItemsToCartInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "addPurchaseOrderItemsToCart": {
+      "cart": Cart,
+      "user_errors": [Error]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ addRequisitionListItemsToCart +

+
+
+
+
Description
+

Add items in the requisition list to the customer's cart.

+
+
+
+
+
+
+
Response
+

Returns an AddRequisitionListItemsToCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ requisitionListUid - ID! + The unique ID of the requisition list.
+ requisitionListItemUids - [ID!] + An array of UIDs presenting products to be added to the cart. If no UIDs are specified, all items in the requisition list will be added to the cart.
+
+
+
+

Example

+
+
Query
+ 
mutation addRequisitionListItemsToCart(
+  $requisitionListUid: ID!,
+  $requisitionListItemUids: [ID!]
+) {
+  addRequisitionListItemsToCart(
+    requisitionListUid: $requisitionListUid,
+    requisitionListItemUids: $requisitionListItemUids
+  ) {
+    add_requisition_list_items_to_cart_user_errors {
+      ...AddRequisitionListItemToCartUserErrorFragment
+    }
+    cart {
+      ...CartFragment
+    }
+    status
+  }
+}
+
+
+
+
Variables
+ 
{"requisitionListUid": 4, "requisitionListItemUids": [4]}
+
+
+
+
Response
+ 
{
+  "data": {
+    "addRequisitionListItemsToCart": {
+      "add_requisition_list_items_to_cart_user_errors": [
+        AddRequisitionListItemToCartUserError
+      ],
+      "cart": Cart,
+      "status": false
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ addReturnComment +

+
+
+
+
Description
+

Add a comment to an existing return.

+
+
+
+
+
+
+
Response
+

Returns an AddReturnCommentOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - AddReturnCommentInput! + An input object that defines a return comment.
+
+
+
+

Example

+
+
Query
+ 
mutation addReturnComment($input: AddReturnCommentInput!) {
+  addReturnComment(input: $input) {
+    return {
+      ...ReturnFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": AddReturnCommentInput}
+
+
+
+
Response
+ 
{"data": {"addReturnComment": {"return": Return}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ addReturnTracking +

+
+
+
+
Description
+

Add tracking information to the return.

+
+
+
+
+
+
+
Response
+

Returns an AddReturnTrackingOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - AddReturnTrackingInput! + An input object that defines tracking information.
+
+
+
+

Example

+
+
Query
+ 
mutation addReturnTracking($input: AddReturnTrackingInput!) {
+  addReturnTracking(input: $input) {
+    return {
+      ...ReturnFragment
+    }
+    return_shipping_tracking {
+      ...ReturnShippingTrackingFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": AddReturnTrackingInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "addReturnTracking": {
+      "return": Return,
+      "return_shipping_tracking": ReturnShippingTracking
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ addSimpleProductsToCart +

+
+
+
+
Description
+

Add one or more simple products to the specified cart. We recommend using addProductsToCart instead.

+
+
+
+
+
+
+
Response
+

Returns an AddSimpleProductsToCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - AddSimpleProductsToCartInput + An input object that defines which simple products to add to the cart.
+
+
+
+

Example

+
+
Query
+ 
mutation addSimpleProductsToCart($input: AddSimpleProductsToCartInput) {
+  addSimpleProductsToCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": AddSimpleProductsToCartInput}
+
+
+
+
Response
+ 
{"data": {"addSimpleProductsToCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ addVirtualProductsToCart +

+
+
+
+
Description
+

Add one or more virtual products to the specified cart. We recommend using addProductsToCart instead.

+
+
+
+
+
+
+
Response
+

Returns an AddVirtualProductsToCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - AddVirtualProductsToCartInput + An input object that defines which virtual products to add to the cart.
+
+
+
+

Example

+
+
Query
+ 
mutation addVirtualProductsToCart($input: AddVirtualProductsToCartInput) {
+  addVirtualProductsToCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": AddVirtualProductsToCartInput}
+
+
+
+
Response
+ 
{"data": {"addVirtualProductsToCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ addWishlistItemsToCart +

+
+
+
+
Description
+

Add items in the specified wishlist to the customer's cart.

+
+
+
+
+
+
+
Response
+

Returns an AddWishlistItemsToCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ wishlistId - ID! + The unique ID of the wish list
+ wishlistItemIds - [ID!] + An array of IDs representing products to be added to the cart. If no IDs are specified, all items in the wishlist will be added to the cart
+
+
+
+

Example

+
+
Query
+ 
mutation addWishlistItemsToCart(
+  $wishlistId: ID!,
+  $wishlistItemIds: [ID!]
+) {
+  addWishlistItemsToCart(
+    wishlistId: $wishlistId,
+    wishlistItemIds: $wishlistItemIds
+  ) {
+    add_wishlist_items_to_cart_user_errors {
+      ...WishlistCartUserInputErrorFragment
+    }
+    status
+    wishlist {
+      ...WishlistFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{
+  "wishlistId": "4",
+  "wishlistItemIds": ["4"]
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "addWishlistItemsToCart": {
+      "add_wishlist_items_to_cart_user_errors": [
+        WishlistCartUserInputError
+      ],
+      "status": false,
+      "wishlist": Wishlist
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ applyCouponToCart +

+
+
+
+
Description
+

Apply a pre-defined coupon code to the specified cart.

+
+
+
+
+
+
+
Response
+

Returns an ApplyCouponToCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - ApplyCouponToCartInput + An input object that defines the coupon code to apply to the cart.
+
+
+
+

Example

+
+
Query
+ 
mutation applyCouponToCart($input: ApplyCouponToCartInput) {
+  applyCouponToCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": ApplyCouponToCartInput}
+
+
+
+
Response
+ 
{"data": {"applyCouponToCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ applyCouponsToCart +

+
+
+
+
Description
+

Apply a pre-defined coupon code to the specified cart.

+
+
+
+
+
+
+
Response
+

Returns an ApplyCouponToCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - ApplyCouponsToCartInput + An input object that defines the coupon code to apply to the cart.
+
+
+
+

Example

+
+
Query
+ 
mutation applyCouponsToCart($input: ApplyCouponsToCartInput) {
+  applyCouponsToCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": ApplyCouponsToCartInput}
+
+
+
+
Response
+ 
{"data": {"applyCouponsToCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ applyGiftCardToCart +

+
+
+
+
Description
+

Apply a pre-defined gift card code to the specified cart.

+
+
+
+
+
+
+
Response
+

Returns an ApplyGiftCardToCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - ApplyGiftCardToCartInput + An input object that specifies the gift card code and cart.
+
+
+
+

Example

+
+
Query
+ 
mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) {
+  applyGiftCardToCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": ApplyGiftCardToCartInput}
+
+
+
+
Response
+ 
{"data": {"applyGiftCardToCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ applyRewardPointsToCart +

+
+
+
+
Description
+

Apply all available points, up to the cart total. Partial redemption is not available.

+
+
+
+
+
+
+
Response
+

Returns an ApplyRewardPointsToCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ cartId - ID! + +
+
+
+
+

Example

+
+
Query
+ 
mutation applyRewardPointsToCart($cartId: ID!) {
+  applyRewardPointsToCart(cartId: $cartId) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"cartId": 4}
+
+
+
+
Response
+ 
{"data": {"applyRewardPointsToCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ applyStoreCreditToCart +

+
+
+
+
Description
+

Apply store credit to the specified cart.

+
+
+
+
+
+
+
Response
+

Returns an ApplyStoreCreditToCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - ApplyStoreCreditToCartInput! + An input object that specifies the cart ID.
+
+
+
+

Example

+
+
Query
+ 
mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) {
+  applyStoreCreditToCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": ApplyStoreCreditToCartInput}
+
+
+
+
Response
+ 
{"data": {"applyStoreCreditToCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ approvePurchaseOrders +

+
+
+
+
Description
+

Approve purchase orders.

+
+
+
+
+
+
+
Response
+

Returns a PurchaseOrdersActionOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - PurchaseOrdersActionInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation approvePurchaseOrders($input: PurchaseOrdersActionInput!) {
+  approvePurchaseOrders(input: $input) {
+    errors {
+      ...PurchaseOrderActionErrorFragment
+    }
+    purchase_orders {
+      ...PurchaseOrderFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": PurchaseOrdersActionInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "approvePurchaseOrders": {
+      "errors": [PurchaseOrderActionError],
+      "purchase_orders": [PurchaseOrder]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ assignCompareListToCustomer +

+
+
+
+
Description
+

Assign the specified compare list to the logged in customer.

+
+
+
+
+
+
+
Response
+

Returns an AssignCompareListToCustomerOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ uid - ID! + The unique ID of the compare list to be assigned.
+
+
+
+

Example

+
+
Query
+ 
mutation assignCompareListToCustomer($uid: ID!) {
+  assignCompareListToCustomer(uid: $uid) {
+    compare_list {
+      ...CompareListFragment
+    }
+    result
+  }
+}
+
+
+
+
Variables
+ 
{"uid": 4}
+
+
+
+
Response
+ 
{
+  "data": {
+    "assignCompareListToCustomer": {
+      "compare_list": CompareList,
+      "result": true
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ assignCustomerToGuestCart +

+
+
+
+
Description
+

Assign a logged-in customer to the specified guest shopping cart.

+
+
+
+
+
+
+
Response
+

Returns a Cart! +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ cart_id - String! + +
+
+
+
+

Example

+
+
Query
+ 
mutation assignCustomerToGuestCart($cart_id: String!) {
+  assignCustomerToGuestCart(cart_id: $cart_id) {
+    applied_coupon {
+      ...AppliedCouponFragment
+    }
+    applied_coupons {
+      ...AppliedCouponFragment
+    }
+    applied_gift_cards {
+      ...AppliedGiftCardFragment
+    }
+    applied_reward_points {
+      ...RewardPointsAmountFragment
+    }
+    applied_store_credit {
+      ...AppliedStoreCreditFragment
+    }
+    available_gift_wrappings {
+      ...GiftWrappingFragment
+    }
+    available_payment_methods {
+      ...AvailablePaymentMethodFragment
+    }
+    billing_address {
+      ...BillingCartAddressFragment
+    }
+    email
+    gift_message {
+      ...GiftMessageFragment
+    }
+    gift_receipt_included
+    gift_wrapping {
+      ...GiftWrappingFragment
+    }
+    id
+    is_virtual
+    items {
+      ...CartItemInterfaceFragment
+    }
+    itemsV2 {
+      ...CartItemsFragment
+    }
+    prices {
+      ...CartPricesFragment
+    }
+    printed_card_included
+    rules {
+      ...CartRuleStorefrontFragment
+    }
+    selected_payment_method {
+      ...SelectedPaymentMethodFragment
+    }
+    shipping_addresses {
+      ...ShippingCartAddressFragment
+    }
+    total_quantity
+  }
+}
+
+
+
+
Variables
+ 
{"cart_id": "abc123"}
+
+
+
+
Response
+ 
{
+  "data": {
+    "assignCustomerToGuestCart": {
+      "applied_coupon": AppliedCoupon,
+      "applied_coupons": [AppliedCoupon],
+      "applied_gift_cards": [AppliedGiftCard],
+      "applied_reward_points": RewardPointsAmount,
+      "applied_store_credit": AppliedStoreCredit,
+      "available_gift_wrappings": [GiftWrapping],
+      "available_payment_methods": [
+        AvailablePaymentMethod
+      ],
+      "billing_address": BillingCartAddress,
+      "email": "abc123",
+      "gift_message": GiftMessage,
+      "gift_receipt_included": true,
+      "gift_wrapping": GiftWrapping,
+      "id": 4,
+      "is_virtual": true,
+      "items": [CartItemInterface],
+      "itemsV2": CartItems,
+      "prices": CartPrices,
+      "printed_card_included": true,
+      "rules": [CartRuleStorefront],
+      "selected_payment_method": SelectedPaymentMethod,
+      "shipping_addresses": [ShippingCartAddress],
+      "total_quantity": 123.45
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ cancelNegotiableQuoteTemplate +

+
+
+
+
Description
+

Cancel a negotiable quote template

+
+
+
+
+
+
+
Response
+

Returns a NegotiableQuoteTemplate +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CancelNegotiableQuoteTemplateInput! + An input object that cancels a negotiable quote template.
+
+
+
+

Example

+
+
Query
+ 
mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInput!) {
+  cancelNegotiableQuoteTemplate(input: $input) {
+    buyer {
+      ...NegotiableQuoteUserFragment
+    }
+    comments {
+      ...NegotiableQuoteCommentFragment
+    }
+    expiration_date
+    history {
+      ...NegotiableQuoteHistoryEntryFragment
+    }
+    is_min_max_qty_used
+    is_virtual
+    items {
+      ...CartItemInterfaceFragment
+    }
+    max_order_commitment
+    min_order_commitment
+    name
+    notifications {
+      ...QuoteTemplateNotificationMessageFragment
+    }
+    prices {
+      ...CartPricesFragment
+    }
+    reference_document_links {
+      ...NegotiableQuoteReferenceDocumentLinkFragment
+    }
+    shipping_addresses {
+      ...NegotiableQuoteShippingAddressFragment
+    }
+    status
+    template_id
+    total_quantity
+  }
+}
+
+
+
+
Variables
+ 
{"input": CancelNegotiableQuoteTemplateInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "cancelNegotiableQuoteTemplate": {
+      "buyer": NegotiableQuoteUser,
+      "comments": [NegotiableQuoteComment],
+      "expiration_date": "xyz789",
+      "history": [NegotiableQuoteHistoryEntry],
+      "is_min_max_qty_used": false,
+      "is_virtual": false,
+      "items": [CartItemInterface],
+      "max_order_commitment": 987,
+      "min_order_commitment": 987,
+      "name": "xyz789",
+      "notifications": [QuoteTemplateNotificationMessage],
+      "prices": CartPrices,
+      "reference_document_links": [
+        NegotiableQuoteReferenceDocumentLink
+      ],
+      "shipping_addresses": [
+        NegotiableQuoteShippingAddress
+      ],
+      "status": "xyz789",
+      "template_id": 4,
+      "total_quantity": 987.65
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ cancelOrder +

+
+
+
+
Description
+

Cancel the specified customer order.

+
+
+
+
+
+
+
Response
+

Returns a CancelOrderOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CancelOrderInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation cancelOrder($input: CancelOrderInput!) {
+  cancelOrder(input: $input) {
+    error
+    errorV2 {
+      ...CancelOrderErrorFragment
+    }
+    order {
+      ...CustomerOrderFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": CancelOrderInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "cancelOrder": {
+      "error": "xyz789",
+      "errorV2": CancelOrderError,
+      "order": CustomerOrder
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ cancelPurchaseOrders +

+
+
+
+
Description
+

Cancel purchase orders.

+
+
+
+
+
+
+
Response
+

Returns a PurchaseOrdersActionOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - PurchaseOrdersActionInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation cancelPurchaseOrders($input: PurchaseOrdersActionInput!) {
+  cancelPurchaseOrders(input: $input) {
+    errors {
+      ...PurchaseOrderActionErrorFragment
+    }
+    purchase_orders {
+      ...PurchaseOrderFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": PurchaseOrdersActionInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "cancelPurchaseOrders": {
+      "errors": [PurchaseOrderActionError],
+      "purchase_orders": [PurchaseOrder]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ changeCustomerPassword +

+
+
+
+
Description
+

Change the password for the logged-in customer.

+
+
+
+
+
+
+
Response
+

Returns a Customer +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ currentPassword - String! + The customer's original password.
+ newPassword - String! + The customer's updated password.
+
+
+
+

Example

+
+
Query
+ 
mutation changeCustomerPassword(
+  $currentPassword: String!,
+  $newPassword: String!
+) {
+  changeCustomerPassword(
+    currentPassword: $currentPassword,
+    newPassword: $newPassword
+  ) {
+    addresses {
+      ...CustomerAddressFragment
+    }
+    addressesV2 {
+      ...CustomerAddressesFragment
+    }
+    allow_remote_shopping_assistance
+    companies {
+      ...UserCompaniesOutputFragment
+    }
+    compare_list {
+      ...CompareListFragment
+    }
+    confirmation_status
+    created_at
+    custom_attributes {
+      ...AttributeValueInterfaceFragment
+    }
+    date_of_birth
+    default_billing
+    default_shipping
+    dob
+    email
+    firstname
+    gender
+    gift_registries {
+      ...GiftRegistryFragment
+    }
+    gift_registry {
+      ...GiftRegistryFragment
+    }
+    group {
+      ...CustomerGroupStorefrontFragment
+    }
+    group_id
+    id
+    is_subscribed
+    job_title
+    lastname
+    middlename
+    orders {
+      ...CustomerOrdersFragment
+    }
+    prefix
+    purchase_order {
+      ...PurchaseOrderFragment
+    }
+    purchase_order_approval_rule {
+      ...PurchaseOrderApprovalRuleFragment
+    }
+    purchase_order_approval_rule_metadata {
+      ...PurchaseOrderApprovalRuleMetadataFragment
+    }
+    purchase_order_approval_rules {
+      ...PurchaseOrderApprovalRulesFragment
+    }
+    purchase_orders {
+      ...PurchaseOrdersFragment
+    }
+    purchase_orders_enabled
+    requisition_lists {
+      ...RequisitionListsFragment
+    }
+    return {
+      ...ReturnFragment
+    }
+    returns {
+      ...ReturnsFragment
+    }
+    reviews {
+      ...ProductReviewsFragment
+    }
+    reward_points {
+      ...RewardPointsFragment
+    }
+    role {
+      ...CompanyRoleFragment
+    }
+    segments {
+      ...CustomerSegmentStorefrontFragment
+    }
+    status
+    store_credit {
+      ...CustomerStoreCreditFragment
+    }
+    structure_id
+    suffix
+    taxvat
+    team {
+      ...CompanyTeamFragment
+    }
+    telephone
+    wishlist {
+      ...WishlistFragment
+    }
+    wishlist_v2 {
+      ...WishlistFragment
+    }
+    wishlists {
+      ...WishlistFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{
+  "currentPassword": "xyz789",
+  "newPassword": "xyz789"
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "changeCustomerPassword": {
+      "addresses": [CustomerAddress],
+      "addressesV2": CustomerAddresses,
+      "allow_remote_shopping_assistance": false,
+      "companies": UserCompaniesOutput,
+      "compare_list": CompareList,
+      "confirmation_status": "ACCOUNT_CONFIRMED",
+      "created_at": "xyz789",
+      "custom_attributes": [AttributeValueInterface],
+      "date_of_birth": "xyz789",
+      "default_billing": "abc123",
+      "default_shipping": "xyz789",
+      "dob": "abc123",
+      "email": "abc123",
+      "firstname": "abc123",
+      "gender": 123,
+      "gift_registries": [GiftRegistry],
+      "gift_registry": GiftRegistry,
+      "group": CustomerGroupStorefront,
+      "group_id": 987,
+      "id": "4",
+      "is_subscribed": true,
+      "job_title": "abc123",
+      "lastname": "xyz789",
+      "middlename": "xyz789",
+      "orders": CustomerOrders,
+      "prefix": "abc123",
+      "purchase_order": PurchaseOrder,
+      "purchase_order_approval_rule": PurchaseOrderApprovalRule,
+      "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
+      "purchase_order_approval_rules": PurchaseOrderApprovalRules,
+      "purchase_orders": PurchaseOrders,
+      "purchase_orders_enabled": false,
+      "requisition_lists": RequisitionLists,
+      "return": Return,
+      "returns": Returns,
+      "reviews": ProductReviews,
+      "reward_points": RewardPoints,
+      "role": CompanyRole,
+      "segments": [CustomerSegmentStorefront],
+      "status": "ACTIVE",
+      "store_credit": CustomerStoreCredit,
+      "structure_id": 4,
+      "suffix": "xyz789",
+      "taxvat": "abc123",
+      "team": CompanyTeam,
+      "telephone": "abc123",
+      "wishlist": Wishlist,
+      "wishlist_v2": Wishlist,
+      "wishlists": [Wishlist]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ clearCart +

+
+
+
+
Description
+

Remove all items from the specified cart.

+
+
+
+
+
+
+
Response
+

Returns a ClearCartOutput! +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - ClearCartInput! + An input object that defines cart ID of the shopper.
+
+
+
+

Example

+
+
Query
+ 
mutation clearCart($input: ClearCartInput!) {
+  clearCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+    errors {
+      ...ClearCartErrorFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": ClearCartInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "clearCart": {
+      "cart": Cart,
+      "errors": [ClearCartError]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ clearCustomerCart +

+
+
+
+
Description
+

Remove all items from the specified cart.

+
+
+
+
+
+
+
Response
+

Returns a ClearCustomerCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ cartUid - String! + The masked ID of the cart.
+
+
+
+

Example

+
+
Query
+ 
mutation clearCustomerCart($cartUid: String!) {
+  clearCustomerCart(cartUid: $cartUid) {
+    cart {
+      ...CartFragment
+    }
+    status
+  }
+}
+
+
+
+
Variables
+ 
{"cartUid": "xyz789"}
+
+
+
+
Response
+ 
{
+  "data": {
+    "clearCustomerCart": {"cart": Cart, "status": false}
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ clearWishlist +

+
+
+
+
Description
+

Remove all the products from the specified wish list.

+
+
+
+
+
+
+
Response
+

Returns a RemoveProductsFromWishlistOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ wishlistId - ID! + The ID of a wish list.
+
+
+
+

Example

+
+
Query
+ 
mutation clearWishlist($wishlistId: ID!) {
+  clearWishlist(wishlistId: $wishlistId) {
+    user_errors {
+      ...WishListUserInputErrorFragment
+    }
+    wishlist {
+      ...WishlistFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"wishlistId": 4}
+
+
+
+
Response
+ 
{
+  "data": {
+    "clearWishlist": {
+      "user_errors": [WishListUserInputError],
+      "wishlist": Wishlist
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ closeNegotiableQuotes +

+
+
+
+
Description
+

Mark a negotiable quote as closed. The negotiable quote is still visible on the storefront.

+
+
+
+
+
+
+
Response
+

Returns a CloseNegotiableQuotesOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CloseNegotiableQuotesInput! + An input object that closes a negotiable quote.
+
+
+
+

Example

+
+
Query
+ 
mutation closeNegotiableQuotes($input: CloseNegotiableQuotesInput!) {
+  closeNegotiableQuotes(input: $input) {
+    closed_quotes {
+      ...NegotiableQuoteFragment
+    }
+    negotiable_quotes {
+      ...NegotiableQuotesOutputFragment
+    }
+    operation_results {
+      ... on NegotiableQuoteUidOperationSuccess {
+        ...NegotiableQuoteUidOperationSuccessFragment
+      }
+      ... on CloseNegotiableQuoteOperationFailure {
+        ...CloseNegotiableQuoteOperationFailureFragment
+      }
+    }
+    result_status
+  }
+}
+
+
+
+
Variables
+ 
{"input": CloseNegotiableQuotesInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "closeNegotiableQuotes": {
+      "closed_quotes": [NegotiableQuote],
+      "negotiable_quotes": NegotiableQuotesOutput,
+      "operation_results": [
+        NegotiableQuoteUidOperationSuccess
+      ],
+      "result_status": "SUCCESS"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ completeOrder +

+
+
+
+
Description
+

Synchronizes order details and place the order

+
+
+
+
+
+
+
Response
+

Returns a PlaceOrderOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CompleteOrderInput + Describes the variables needed to complete or place the order
+
+
+
+

Example

+
+
Query
+ 
mutation completeOrder($input: CompleteOrderInput) {
+  completeOrder(input: $input) {
+    errors {
+      ...PlaceOrderErrorFragment
+    }
+    order {
+      ...OrderFragment
+    }
+    orderV2 {
+      ...CustomerOrderFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": CompleteOrderInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "completeOrder": {
+      "errors": [PlaceOrderError],
+      "order": Order,
+      "orderV2": CustomerOrder
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ confirmCancelOrder +

+
+
+
+
Description
+

Cancel the specified guest customer order.

+
+
+
+
+
+
+
Response
+

Returns a CancelOrderOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - ConfirmCancelOrderInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) {
+  confirmCancelOrder(input: $input) {
+    error
+    errorV2 {
+      ...CancelOrderErrorFragment
+    }
+    order {
+      ...CustomerOrderFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": ConfirmCancelOrderInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "confirmCancelOrder": {
+      "error": "abc123",
+      "errorV2": CancelOrderError,
+      "order": CustomerOrder
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ confirmEmail +

+
+
+
+
Description
+

Confirms the email address for a customer.

+
+
+
+
+
+
+
Response
+

Returns a CustomerOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - ConfirmEmailInput! + An input object to identify the customer to confirm the email.
+
+
+
+

Example

+
+
Query
+ 
mutation confirmEmail($input: ConfirmEmailInput!) {
+  confirmEmail(input: $input) {
+    customer {
+      ...CustomerFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": ConfirmEmailInput}
+
+
+
+
Response
+ 
{"data": {"confirmEmail": {"customer": Customer}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ confirmReturn +

+
+
+
+
Description
+

Confirm the return.

+
+
+
+
+
+
+
Response
+

Returns a RequestReturnOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - ConfirmReturnInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation confirmReturn($input: ConfirmReturnInput!) {
+  confirmReturn(input: $input) {
+    return {
+      ...ReturnFragment
+    }
+    returns {
+      ...ReturnsFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": ConfirmReturnInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "confirmReturn": {
+      "return": Return,
+      "returns": Returns
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ contactUs +

+
+
+
+
Description
+

Send a 'Contact Us' email to the merchant.

+
+
+
+
+
+
+
Response
+

Returns a ContactUsOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - ContactUsInput! + An input object that defines shopper information.
+
+
+
+

Example

+
+
Query
+ 
mutation contactUs($input: ContactUsInput!) {
+  contactUs(input: $input) {
+    status
+  }
+}
+
+
+
+
Variables
+ 
{"input": ContactUsInput}
+
+
+
+
Response
+ 
{"data": {"contactUs": {"status": false}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ copyItemsBetweenRequisitionLists +

+
+
+
+
Description
+

Copy items from one requisition list to another.

+
+
+
+
+
+
+
Response
+

Returns a CopyItemsFromRequisitionListsOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
+ sourceRequisitionListUid - ID! + The unique ID of the source requisition list.
+ destinationRequisitionListUid - ID + The unique ID of the destination requisition list. If null, a new requisition list will be created.
+ requisitionListItem - CopyItemsBetweenRequisitionListsInput + The list of products to copy.
+
+
+
+

Example

+
+
Query
+ 
mutation copyItemsBetweenRequisitionLists(
+  $sourceRequisitionListUid: ID!,
+  $destinationRequisitionListUid: ID,
+  $requisitionListItem: CopyItemsBetweenRequisitionListsInput
+) {
+  copyItemsBetweenRequisitionLists(
+    sourceRequisitionListUid: $sourceRequisitionListUid,
+    destinationRequisitionListUid: $destinationRequisitionListUid,
+    requisitionListItem: $requisitionListItem
+  ) {
+    requisition_list {
+      ...RequisitionListFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{
+  "sourceRequisitionListUid": 4,
+  "destinationRequisitionListUid": "4",
+  "requisitionListItem": CopyItemsBetweenRequisitionListsInput
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "copyItemsBetweenRequisitionLists": {
+      "requisition_list": RequisitionList
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ copyProductsBetweenWishlists +

+
+
+
+
Description
+

Copy products from one wish list to another. The original wish list is unchanged.

+
+
+
+
+
+
+
Response
+

Returns a CopyProductsBetweenWishlistsOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
+ sourceWishlistUid - ID! + The ID of the original wish list.
+ destinationWishlistUid - ID! + The ID of the target wish list.
+ wishlistItems - [WishlistItemCopyInput!]! + An array of items to copy.
+
+
+
+

Example

+
+
Query
+ 
mutation copyProductsBetweenWishlists(
+  $sourceWishlistUid: ID!,
+  $destinationWishlistUid: ID!,
+  $wishlistItems: [WishlistItemCopyInput!]!
+) {
+  copyProductsBetweenWishlists(
+    sourceWishlistUid: $sourceWishlistUid,
+    destinationWishlistUid: $destinationWishlistUid,
+    wishlistItems: $wishlistItems
+  ) {
+    destination_wishlist {
+      ...WishlistFragment
+    }
+    source_wishlist {
+      ...WishlistFragment
+    }
+    user_errors {
+      ...WishListUserInputErrorFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{
+  "sourceWishlistUid": "4",
+  "destinationWishlistUid": 4,
+  "wishlistItems": [WishlistItemCopyInput]
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "copyProductsBetweenWishlists": {
+      "destination_wishlist": Wishlist,
+      "source_wishlist": Wishlist,
+      "user_errors": [WishListUserInputError]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ createBraintreeClientToken +

+
+
+
+
Description
+

Creates Client Token for Braintree Javascript SDK initialization.

+
+
+
+
+
+
+
Response
+

Returns a String! +

+
+
+
+

Example

+
+
Query
+ 
mutation createBraintreeClientToken {
+  createBraintreeClientToken
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "createBraintreeClientToken": "abc123"
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ createBraintreePayPalClientToken +

+
+
+
+
Description
+

Creates Client Token for Braintree PayPal Javascript SDK initialization.

+
+
+
+
+
+
+
Response
+

Returns a String! +

+
+
+
+

Example

+
+
Query
+ 
mutation createBraintreePayPalClientToken {
+  createBraintreePayPalClientToken
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "createBraintreePayPalClientToken": "abc123"
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ createBraintreePayPalVaultClientToken +

+
+
+
+
Description
+

Creates Client Token for Braintree PayPal Vault Javascript SDK initialization.

+
+
+
+
+
+
+
Response
+

Returns a String! +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - BraintreeVaultInput + +
+
+
+
+

Example

+
+
Query
+ 
mutation createBraintreePayPalVaultClientToken($input: BraintreeVaultInput) {
+  createBraintreePayPalVaultClientToken(input: $input)
+}
+
+
+
+
Variables
+ 
{"input": BraintreeVaultInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "createBraintreePayPalVaultClientToken": "abc123"
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ createCompany +

+
+
+
+
Description
+

Create a company at the request of either a customer or a guest.

+
+
+
+
+
+
+
Response
+

Returns a CreateCompanyOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CompanyCreateInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation createCompany($input: CompanyCreateInput!) {
+  createCompany(input: $input) {
+    company {
+      ...CompanyFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": CompanyCreateInput}
+
+
+
+
Response
+ 
{"data": {"createCompany": {"company": Company}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ createCompanyRole +

+
+
+
+
Description
+

Create a new company role.

+
+
+
+
+
+
+
Response
+

Returns a CreateCompanyRoleOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CompanyRoleCreateInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation createCompanyRole($input: CompanyRoleCreateInput!) {
+  createCompanyRole(input: $input) {
+    role {
+      ...CompanyRoleFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": CompanyRoleCreateInput}
+
+
+
+
Response
+ 
{"data": {"createCompanyRole": {"role": CompanyRole}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ createCompanyTeam +

+
+
+
+
Description
+

Create a new team for the customer's company within the current company context.

+
+
+
+
+
+
+
Response
+

Returns a CreateCompanyTeamOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CompanyTeamCreateInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation createCompanyTeam($input: CompanyTeamCreateInput!) {
+  createCompanyTeam(input: $input) {
+    team {
+      ...CompanyTeamFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": CompanyTeamCreateInput}
+
+
+
+
Response
+ 
{"data": {"createCompanyTeam": {"team": CompanyTeam}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ createCompanyUser +

+
+
+
+
Description
+

Create a new company user at the request of an existing customer.

+
+
+
+
+
+
+
Response
+

Returns a CreateCompanyUserOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CompanyUserCreateInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation createCompanyUser($input: CompanyUserCreateInput!) {
+  createCompanyUser(input: $input) {
+    user {
+      ...CustomerFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": CompanyUserCreateInput}
+
+
+
+
Response
+ 
{"data": {"createCompanyUser": {"user": Customer}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ createCompareList +

+
+
+
+
Description
+

Create a new compare list. The compare list is saved for logged in customers.

+
+
+
+
+
+
+
Response
+

Returns a CompareList +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CreateCompareListInput + +
+
+
+
+

Example

+
+
Query
+ 
mutation createCompareList($input: CreateCompareListInput) {
+  createCompareList(input: $input) {
+    attributes {
+      ...ComparableAttributeFragment
+    }
+    item_count
+    items {
+      ...ComparableItemFragment
+    }
+    uid
+  }
+}
+
+
+
+
Variables
+ 
{"input": CreateCompareListInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "createCompareList": {
+      "attributes": [ComparableAttribute],
+      "item_count": 987,
+      "items": [ComparableItem],
+      "uid": 4
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ createCustomer +

+
+
+
+
Use createCustomerV2 instead.
+
+
+
+
+
+
+
Response
+

Returns a CustomerOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CustomerInput! + An input object that defines the customer to be created.
+
+
+
+

Example

+
+
Query
+ 
mutation createCustomer($input: CustomerInput!) {
+  createCustomer(input: $input) {
+    customer {
+      ...CustomerFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": CustomerInput}
+
+
+
+
Response
+ 
{"data": {"createCustomer": {"customer": Customer}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ createCustomerAddress +

+
+
+
+
Description
+

Create a billing or shipping address for a customer or guest.

+
+
+
+
+
+
+
Response
+

Returns a CustomerAddress +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CustomerAddressInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation createCustomerAddress($input: CustomerAddressInput!) {
+  createCustomerAddress(input: $input) {
+    city
+    company
+    country_code
+    country_id
+    custom_attributes {
+      ...CustomerAddressAttributeFragment
+    }
+    custom_attributesV2 {
+      ...AttributeValueInterfaceFragment
+    }
+    customer_id
+    default_billing
+    default_shipping
+    extension_attributes {
+      ...CustomerAddressAttributeFragment
+    }
+    fax
+    firstname
+    id
+    lastname
+    middlename
+    postcode
+    prefix
+    region {
+      ...CustomerAddressRegionFragment
+    }
+    region_id
+    street
+    suffix
+    telephone
+    uid
+    vat_id
+  }
+}
+
+
+
+
Variables
+ 
{"input": CustomerAddressInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "createCustomerAddress": {
+      "city": "abc123",
+      "company": "xyz789",
+      "country_code": "AF",
+      "country_id": "abc123",
+      "custom_attributes": [CustomerAddressAttribute],
+      "custom_attributesV2": [AttributeValueInterface],
+      "customer_id": 987,
+      "default_billing": true,
+      "default_shipping": false,
+      "extension_attributes": [CustomerAddressAttribute],
+      "fax": "abc123",
+      "firstname": "abc123",
+      "id": 987,
+      "lastname": "abc123",
+      "middlename": "xyz789",
+      "postcode": "abc123",
+      "prefix": "xyz789",
+      "region": CustomerAddressRegion,
+      "region_id": 987,
+      "street": ["abc123"],
+      "suffix": "xyz789",
+      "telephone": "abc123",
+      "uid": 4,
+      "vat_id": "xyz789"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ createCustomerV2 +

+
+
+
+
Description
+

Create a customer account.

+
+
+
+
+
+
+
Response
+

Returns a CustomerOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CustomerCreateInput! + An input object that defines the customer to be created.
+
+
+
+

Example

+
+
Query
+ 
mutation createCustomerV2($input: CustomerCreateInput!) {
+  createCustomerV2(input: $input) {
+    customer {
+      ...CustomerFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": CustomerCreateInput}
+
+
+
+
Response
+ 
{"data": {"createCustomerV2": {"customer": Customer}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ createEmptyCart +

+
+
+
+
Use Mutation.createGuestCart or Query.customerCart for logged in customer
+
+
+
+
+
+
+
Description
+

Create an empty shopping cart for a guest or logged in user

+
+
+
+
+
+
+
Response
+

Returns a String +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - createEmptyCartInput + An optional input object that assigns the specified ID to the cart.
+
+
+
+

Example

+
+
Query
+ 
mutation createEmptyCart($input: createEmptyCartInput) {
+  createEmptyCart(input: $input)
+}
+
+
+
+
Variables
+ 
{"input": createEmptyCartInput}
+
+
+
+
Response
+ 
{"data": {"createEmptyCart": "abc123"}}
+
+
+
+
+
+
+
+ Mutations +
+

+ createGiftRegistry +

+
+
+
+
Description
+

Create a gift registry on behalf of the customer.

+
+
+
+
+
+
+
Response
+

Returns a CreateGiftRegistryOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ giftRegistry - CreateGiftRegistryInput! + An input object that defines a new gift registry.
+
+
+
+

Example

+
+
Query
+ 
mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) {
+  createGiftRegistry(giftRegistry: $giftRegistry) {
+    gift_registry {
+      ...GiftRegistryFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"giftRegistry": CreateGiftRegistryInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "createGiftRegistry": {"gift_registry": GiftRegistry}
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ createGuestCart +

+
+
+
+
Description
+

Create a new shopping cart

+
+
+
+
+
+
+
Response
+

Returns a CreateGuestCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CreateGuestCartInput + +
+
+
+
+

Example

+
+
Query
+ 
mutation createGuestCart($input: CreateGuestCartInput) {
+  createGuestCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": CreateGuestCartInput}
+
+
+
+
Response
+ 
{"data": {"createGuestCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ createPayflowProToken +

+
+
+
+
Description
+

Initiate a transaction and receive a token. Use this mutation for Payflow Pro and Payments Pro payment methods

+
+
+
+
+
+
+
Response
+

Returns a CreatePayflowProTokenOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - PayflowProTokenInput! + An input object that defines the requirements to fetch payment token information.
+
+
+
+

Example

+
+
Query
+ 
mutation createPayflowProToken($input: PayflowProTokenInput!) {
+  createPayflowProToken(input: $input) {
+    response_message
+    result
+    result_code
+    secure_token
+    secure_token_id
+  }
+}
+
+
+
+
Variables
+ 
{"input": PayflowProTokenInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "createPayflowProToken": {
+      "response_message": "xyz789",
+      "result": 987,
+      "result_code": 123,
+      "secure_token": "abc123",
+      "secure_token_id": "xyz789"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ createPaymentOrder +

+
+
+
+
Description
+

Creates a payment order for further payment processing

+
+
+
+
+
+
+
Response
+

Returns a CreatePaymentOrderOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CreatePaymentOrderInput! + Contains payment order details that are used while processing the payment order
+
+
+
+

Example

+
+
Query
+ 
mutation createPaymentOrder($input: CreatePaymentOrderInput!) {
+  createPaymentOrder(input: $input) {
+    amount
+    currency_code
+    id
+    mp_order_id
+    status
+  }
+}
+
+
+
+
Variables
+ 
{"input": CreatePaymentOrderInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "createPaymentOrder": {
+      "amount": 123.45,
+      "currency_code": "abc123",
+      "id": "xyz789",
+      "mp_order_id": "abc123",
+      "status": "xyz789"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ createPaypalExpressToken +

+
+
+
+
Description
+

Initiate an Express Checkout transaction and receive a token. Use this mutation for Express Checkout and Payments Standard payment methods.

+
+
+
+
+
+
+
Response
+

Returns a PaypalExpressTokenOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - PaypalExpressTokenInput! + An input object that defines the requirements to receive a payment token.
+
+
+
+

Example

+
+
Query
+ 
mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) {
+  createPaypalExpressToken(input: $input) {
+    paypal_urls {
+      ...PaypalExpressUrlListFragment
+    }
+    token
+  }
+}
+
+
+
+
Variables
+ 
{"input": PaypalExpressTokenInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "createPaypalExpressToken": {
+      "paypal_urls": PaypalExpressUrlList,
+      "token": "xyz789"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ createProductReview +

+
+
+
+
Description
+

Create a product review for the specified product.

+
+
+
+
+
+
+
Response
+

Returns a CreateProductReviewOutput! +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CreateProductReviewInput! + An input object that contains the details necessary to create a product review.
+
+
+
+

Example

+
+
Query
+ 
mutation createProductReview($input: CreateProductReviewInput!) {
+  createProductReview(input: $input) {
+    review {
+      ...ProductReviewFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": CreateProductReviewInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "createProductReview": {"review": ProductReview}
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ createPurchaseOrderApprovalRule +

+
+
+
+
Description
+

Create a purchase order approval rule.

+
+
+
+
+
+
+
Response
+

Returns a PurchaseOrderApprovalRule +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - PurchaseOrderApprovalRuleInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput!) {
+  createPurchaseOrderApprovalRule(input: $input) {
+    applies_to_roles {
+      ...CompanyRoleFragment
+    }
+    approver_roles {
+      ...CompanyRoleFragment
+    }
+    condition {
+      ...PurchaseOrderApprovalRuleConditionInterfaceFragment
+    }
+    created_at
+    created_by
+    description
+    name
+    status
+    uid
+    updated_at
+  }
+}
+
+
+
+
Variables
+ 
{"input": PurchaseOrderApprovalRuleInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "createPurchaseOrderApprovalRule": {
+      "applies_to_roles": [CompanyRole],
+      "approver_roles": [CompanyRole],
+      "condition": PurchaseOrderApprovalRuleConditionInterface,
+      "created_at": "xyz789",
+      "created_by": "abc123",
+      "description": "xyz789",
+      "name": "abc123",
+      "status": "ENABLED",
+      "uid": 4,
+      "updated_at": "abc123"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ createRequisitionList +

+
+
+
+
Description
+

Create an empty requisition list.

+
+
+
+
+
+
+
Response
+

Returns a CreateRequisitionListOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CreateRequisitionListInput + +
+
+
+
+

Example

+
+
Query
+ 
mutation createRequisitionList($input: CreateRequisitionListInput) {
+  createRequisitionList(input: $input) {
+    requisition_list {
+      ...RequisitionListFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": CreateRequisitionListInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "createRequisitionList": {
+      "requisition_list": RequisitionList
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ createVaultCardPaymentToken +

+
+
+
+
Description
+

Creates a vault payment token

+
+
+
+
+
+
+
Response
+

Returns a CreateVaultCardPaymentTokenOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CreateVaultCardPaymentTokenInput! + Describe the variables needed to create a vault card payment token
+
+
+
+

Example

+
+
Query
+ 
mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) {
+  createVaultCardPaymentToken(input: $input) {
+    payment_source {
+      ...PaymentSourceOutputFragment
+    }
+    vault_token_id
+  }
+}
+
+
+
+
Variables
+ 
{"input": CreateVaultCardPaymentTokenInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "createVaultCardPaymentToken": {
+      "payment_source": PaymentSourceOutput,
+      "vault_token_id": "xyz789"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ createVaultCardSetupToken +

+
+
+
+
Description
+

Creates a vault card setup token

+
+
+
+
+
+
+
Response
+

Returns a CreateVaultCardSetupTokenOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CreateVaultCardSetupTokenInput! + Describe the variables needed to create a vault card setup token
+
+
+
+

Example

+
+
Query
+ 
mutation createVaultCardSetupToken($input: CreateVaultCardSetupTokenInput!) {
+  createVaultCardSetupToken(input: $input) {
+    setup_token
+  }
+}
+
+
+
+
Variables
+ 
{"input": CreateVaultCardSetupTokenInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "createVaultCardSetupToken": {
+      "setup_token": "xyz789"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ createWishlist +

+
+
+
+
Description
+

Create a new wish list.

+
+
+
+
+
+
+
Response
+

Returns a CreateWishlistOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CreateWishlistInput! + An input object that defines a new wish list.
+
+
+
+

Example

+
+
Query
+ 
mutation createWishlist($input: CreateWishlistInput!) {
+  createWishlist(input: $input) {
+    wishlist {
+      ...WishlistFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": CreateWishlistInput}
+
+
+
+
Response
+ 
{"data": {"createWishlist": {"wishlist": Wishlist}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ deleteCompanyRole +

+
+
+
+
Description
+

Delete the specified company role.

+
+
+
+
+
+
+
Response
+

Returns a DeleteCompanyRoleOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ id - ID! + +
+
+
+
+

Example

+
+
Query
+ 
mutation deleteCompanyRole($id: ID!) {
+  deleteCompanyRole(id: $id) {
+    success
+  }
+}
+
+
+
+
Variables
+ 
{"id": "4"}
+
+
+
+
Response
+ 
{"data": {"deleteCompanyRole": {"success": false}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ deleteCompanyTeam +

+
+
+
+
Description
+

Delete the specified company team.

+
+
+
+
+
+
+
Response
+

Returns a DeleteCompanyTeamOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ id - ID! + +
+
+
+
+

Example

+
+
Query
+ 
mutation deleteCompanyTeam($id: ID!) {
+  deleteCompanyTeam(id: $id) {
+    success
+  }
+}
+
+
+
+
Variables
+ 
{"id": 4}
+
+
+
+
Response
+ 
{"data": {"deleteCompanyTeam": {"success": true}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ deleteCompanyUser +

+
+
+
+
Use deleteCompanyUserV2 instead. The current method only deactivates the user account associated with the company.
+
+
+
+
+
+
+
Description
+

Delete the specified company user.

+
+
+
+
+
+
+
Response
+

Returns a DeleteCompanyUserOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ id - ID! + +
+
+
+
+

Example

+
+
Query
+ 
mutation deleteCompanyUser($id: ID!) {
+  deleteCompanyUser(id: $id) {
+    success
+  }
+}
+
+
+
+
Variables
+ 
{"id": "4"}
+
+
+
+
Response
+ 
{"data": {"deleteCompanyUser": {"success": true}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ deleteCompanyUserV2 +

+
+
+
+
Description
+

Delete the specified company user.

+
+
+
+
+
+
+
Response
+

Returns a DeleteCompanyUserOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ id - ID! + +
+
+
+
+

Example

+
+
Query
+ 
mutation deleteCompanyUserV2($id: ID!) {
+  deleteCompanyUserV2(id: $id) {
+    success
+  }
+}
+
+
+
+
Variables
+ 
{"id": "4"}
+
+
+
+
Response
+ 
{"data": {"deleteCompanyUserV2": {"success": false}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ deleteCompareList +

+
+
+
+
Description
+

Delete the specified compare list.

+
+
+
+
+
+
+
Response
+

Returns a DeleteCompareListOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ uid - ID! + The unique ID of the compare list to be deleted.
+
+
+
+

Example

+
+
Query
+ 
mutation deleteCompareList($uid: ID!) {
+  deleteCompareList(uid: $uid) {
+    result
+  }
+}
+
+
+
+
Variables
+ 
{"uid": 4}
+
+
+
+
Response
+ 
{"data": {"deleteCompareList": {"result": false}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ deleteCustomer +

+
+
+
+
Description
+

Delete customer account

+
+
+
+
+
+
+
Response
+

Returns a Boolean +

+
+
+
+

Example

+
+
Query
+ 
mutation deleteCustomer {
+  deleteCustomer
+}
+
+
+
+
Response
+ 
{"data": {"deleteCustomer": false}}
+
+
+
+
+
+
+
+ Mutations +
+

+ deleteCustomerAddress +

+
+
+
+
Use deleteCustomerAddressV2 instead.
+
+
+
+
+
+
+
Description
+

Delete the billing or shipping address of a customer.

+
+
+
+
+
+
+
Response
+

Returns a Boolean +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ id - Int! + The ID of the customer address to be deleted.
+
+
+
+

Example

+
+
Query
+ 
mutation deleteCustomerAddress($id: Int!) {
+  deleteCustomerAddress(id: $id)
+}
+
+
+
+
Variables
+ 
{"id": 123}
+
+
+
+
Response
+ 
{"data": {"deleteCustomerAddress": true}}
+
+
+
+
+
+
+
+ Mutations +
+

+ deleteCustomerAddressV2 +

+
+
+
+
Description
+

Delete the billing or shipping address of a customer.

+
+
+
+
+
+
+
Response
+

Returns a Boolean +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ uid - ID! + The unique ID of the customer address to be deleted.
+
+
+
+

Example

+
+
Query
+ 
mutation deleteCustomerAddressV2($uid: ID!) {
+  deleteCustomerAddressV2(uid: $uid)
+}
+
+
+
+
Variables
+ 
{"uid": 4}
+
+
+
+
Response
+ 
{"data": {"deleteCustomerAddressV2": true}}
+
+
+
+
+
+
+
+ Mutations +
+

+ deleteNegotiableQuoteTemplate +

+
+
+
+
Description
+

Delete a negotiable quote template

+
+
+
+
+
+
+
Response
+

Returns a Boolean! +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - DeleteNegotiableQuoteTemplateInput! + An input object that cancels a negotiable quote template.
+
+
+
+

Example

+
+
Query
+ 
mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInput!) {
+  deleteNegotiableQuoteTemplate(input: $input)
+}
+
+
+
+
Variables
+ 
{"input": DeleteNegotiableQuoteTemplateInput}
+
+
+
+
Response
+ 
{"data": {"deleteNegotiableQuoteTemplate": false}}
+
+
+
+
+
+
+
+ Mutations +
+

+ deleteNegotiableQuotes +

+
+
+
+
Description
+

Delete a negotiable quote. The negotiable quote will not be displayed on the storefront.

+
+
+
+
+
+
+
Response
+

Returns a DeleteNegotiableQuotesOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - DeleteNegotiableQuotesInput! + An input object that deletes a negotiable quote.
+
+
+
+

Example

+
+
Query
+ 
mutation deleteNegotiableQuotes($input: DeleteNegotiableQuotesInput!) {
+  deleteNegotiableQuotes(input: $input) {
+    negotiable_quotes {
+      ...NegotiableQuotesOutputFragment
+    }
+    operation_results {
+      ... on NegotiableQuoteUidOperationSuccess {
+        ...NegotiableQuoteUidOperationSuccessFragment
+      }
+      ... on DeleteNegotiableQuoteOperationFailure {
+        ...DeleteNegotiableQuoteOperationFailureFragment
+      }
+    }
+    result_status
+  }
+}
+
+
+
+
Variables
+ 
{"input": DeleteNegotiableQuotesInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "deleteNegotiableQuotes": {
+      "negotiable_quotes": NegotiableQuotesOutput,
+      "operation_results": [
+        NegotiableQuoteUidOperationSuccess
+      ],
+      "result_status": "SUCCESS"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ deletePaymentToken +

+
+
+
+
Description
+

Delete a customer's payment token.

+
+
+
+
+
+
+
Response
+

Returns a DeletePaymentTokenOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ public_hash - String! + The reusable payment token securely stored in the vault.
+
+
+
+

Example

+
+
Query
+ 
mutation deletePaymentToken($public_hash: String!) {
+  deletePaymentToken(public_hash: $public_hash) {
+    customerPaymentTokens {
+      ...CustomerPaymentTokensFragment
+    }
+    result
+  }
+}
+
+
+
+
Variables
+ 
{"public_hash": "xyz789"}
+
+
+
+
Response
+ 
{
+  "data": {
+    "deletePaymentToken": {
+      "customerPaymentTokens": CustomerPaymentTokens,
+      "result": false
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ deletePurchaseOrderApprovalRule +

+
+
+
+
Description
+

Delete existing purchase order approval rules.

+
+
+
+
+
+
+
Response
+

Returns a DeletePurchaseOrderApprovalRuleOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - DeletePurchaseOrderApprovalRuleInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRuleInput!) {
+  deletePurchaseOrderApprovalRule(input: $input) {
+    errors {
+      ...DeletePurchaseOrderApprovalRuleErrorFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": DeletePurchaseOrderApprovalRuleInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "deletePurchaseOrderApprovalRule": {
+      "errors": [DeletePurchaseOrderApprovalRuleError]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ deleteRequisitionList +

+
+
+
+
Description
+

Delete a requisition list.

+
+
+
+
+
+
+
Response
+

Returns a DeleteRequisitionListOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ requisitionListUid - ID! + The unique ID of the requisition list.
+
+
+
+

Example

+
+
Query
+ 
mutation deleteRequisitionList($requisitionListUid: ID!) {
+  deleteRequisitionList(requisitionListUid: $requisitionListUid) {
+    requisition_lists {
+      ...RequisitionListsFragment
+    }
+    status
+  }
+}
+
+
+
+
Variables
+ 
{"requisitionListUid": "4"}
+
+
+
+
Response
+ 
{
+  "data": {
+    "deleteRequisitionList": {
+      "requisition_lists": RequisitionLists,
+      "status": false
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ deleteRequisitionListItems +

+
+
+
+
Description
+

Delete items from a requisition list.

+
+
+
+
+
+
+
Response
+

Returns a DeleteRequisitionListItemsOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ requisitionListUid - ID! + The unique ID of the requisition list.
+ requisitionListItemUids - [ID!]! + An array of UIDs representing products to be removed from the requisition list.
+
+
+
+

Example

+
+
Query
+ 
mutation deleteRequisitionListItems(
+  $requisitionListUid: ID!,
+  $requisitionListItemUids: [ID!]!
+) {
+  deleteRequisitionListItems(
+    requisitionListUid: $requisitionListUid,
+    requisitionListItemUids: $requisitionListItemUids
+  ) {
+    requisition_list {
+      ...RequisitionListFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{
+  "requisitionListUid": "4",
+  "requisitionListItemUids": [4]
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "deleteRequisitionListItems": {
+      "requisition_list": RequisitionList
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ deleteWishlist +

+
+
+
+
Description
+

Delete the specified wish list. You cannot delete the customer's default (first) wish list.

+
+
+
+
+
+
+
Response
+

Returns a DeleteWishlistOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ wishlistId - ID! + The ID of the wish list to delete.
+
+
+
+

Example

+
+
Query
+ 
mutation deleteWishlist($wishlistId: ID!) {
+  deleteWishlist(wishlistId: $wishlistId) {
+    status
+    wishlists {
+      ...WishlistFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"wishlistId": 4}
+
+
+
+
Response
+ 
{
+  "data": {
+    "deleteWishlist": {
+      "status": true,
+      "wishlists": [Wishlist]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ duplicateNegotiableQuote +

+
+
+
+
Description
+

Negotiable Quote resulting from duplication operation.

+
+
+
+
+
+
+
Response
+

Returns a DuplicateNegotiableQuoteOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - DuplicateNegotiableQuoteInput! + An input object that defines ID of the quote to be duplicated.
+
+
+
+

Example

+
+
Query
+ 
mutation duplicateNegotiableQuote($input: DuplicateNegotiableQuoteInput!) {
+  duplicateNegotiableQuote(input: $input) {
+    quote {
+      ...NegotiableQuoteFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": DuplicateNegotiableQuoteInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "duplicateNegotiableQuote": {"quote": NegotiableQuote}
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ estimateShippingMethods +

+
+
+
+
Description
+

Estimate shipping method(s) for cart based on address

+
+
+
+
+
+
+
Response
+

Returns [AvailableShippingMethod] +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - EstimateTotalsInput! + An input object that specifies details for estimation of available shipping methods
+
+
+
+

Example

+
+
Query
+ 
mutation estimateShippingMethods($input: EstimateTotalsInput!) {
+  estimateShippingMethods(input: $input) {
+    amount {
+      ...MoneyFragment
+    }
+    available
+    base_amount {
+      ...MoneyFragment
+    }
+    carrier_code
+    carrier_title
+    error_message
+    method_code
+    method_title
+    price_excl_tax {
+      ...MoneyFragment
+    }
+    price_incl_tax {
+      ...MoneyFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": EstimateTotalsInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "estimateShippingMethods": [
+      {
+        "amount": Money,
+        "available": false,
+        "base_amount": Money,
+        "carrier_code": "abc123",
+        "carrier_title": "xyz789",
+        "error_message": "xyz789",
+        "method_code": "xyz789",
+        "method_title": "xyz789",
+        "price_excl_tax": Money,
+        "price_incl_tax": Money
+      }
+    ]
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ estimateTotals +

+
+
+
+
Description
+

Estimate totals for cart based on the address

+
+
+
+
+
+
+
Response
+

Returns an EstimateTotalsOutput! +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - EstimateTotalsInput! + An input object that specifies details for cart totals estimation
+
+
+
+

Example

+
+
Query
+ 
mutation estimateTotals($input: EstimateTotalsInput!) {
+  estimateTotals(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": EstimateTotalsInput}
+
+
+
+
Response
+ 
{"data": {"estimateTotals": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ exchangeExternalCustomerToken +

+
+
+
+
Description
+

Generate a token for specified customer.

+
+
+
+
+
+
+
Response
+

Returns an ExchangeExternalCustomerTokenOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - ExchangeExternalCustomerTokenInput + Contains details about external customer.
+
+
+
+

Example

+
+
Query
+ 
mutation exchangeExternalCustomerToken($input: ExchangeExternalCustomerTokenInput) {
+  exchangeExternalCustomerToken(input: $input) {
+    customer {
+      ...CustomerFragment
+    }
+    token
+  }
+}
+
+
+
+
Variables
+ 
{"input": ExchangeExternalCustomerTokenInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "exchangeExternalCustomerToken": {
+      "customer": Customer,
+      "token": "abc123"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ generateCustomerToken +

+
+
+
+
Description
+

Generate a token for specified customer.

+
+
+
+
+
+
+
Response
+

Returns a CustomerToken +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ email - String! + The customer's email address.
+ password - String! + The customer's password.
+
+
+
+

Example

+
+
Query
+ 
mutation generateCustomerToken(
+  $email: String!,
+  $password: String!
+) {
+  generateCustomerToken(
+    email: $email,
+    password: $password
+  ) {
+    token
+  }
+}
+
+
+
+
Variables
+ 
{
+  "email": "xyz789",
+  "password": "xyz789"
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "generateCustomerToken": {
+      "token": "xyz789"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ generateCustomerTokenAsAdmin +

+
+
+
+
Description
+

Request a customer token so that an administrator can perform remote shopping assistance.

+
+
+
+
+
+
+
Response
+

Returns a GenerateCustomerTokenAsAdminOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - GenerateCustomerTokenAsAdminInput! + An input object that defines the customer email address.
+
+
+
+

Example

+
+
Query
+ 
mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput!) {
+  generateCustomerTokenAsAdmin(input: $input) {
+    customer_token
+  }
+}
+
+
+
+
Variables
+ 
{"input": GenerateCustomerTokenAsAdminInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "generateCustomerTokenAsAdmin": {
+      "customer_token": "xyz789"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ generateNegotiableQuoteFromTemplate +

+
+
+
+
Description
+

Generate a negotiable quote from an accept quote template.

+
+
+
+
+
+
+
Response
+

Returns a GenerateNegotiableQuoteFromTemplateOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - GenerateNegotiableQuoteFromTemplateInput! + An input object that contains the data to generate a negotiable quote from quote template.
+
+
+
+

Example

+
+
Query
+ 
mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFromTemplateInput!) {
+  generateNegotiableQuoteFromTemplate(input: $input) {
+    negotiable_quote_uid
+  }
+}
+
+
+
+
Variables
+ 
{"input": GenerateNegotiableQuoteFromTemplateInput}
+
+
+
+
Response
+ 
{"data": {"generateNegotiableQuoteFromTemplate": {"negotiable_quote_uid": 4}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ handlePayflowProResponse +

+
+
+
+
Description
+

Handle a payment response and save the payment in Quote. Use this mutation for Payflow Pro and Payments Pro payment methods.

+
+
+
+
+
+
+
Response
+

Returns a PayflowProResponseOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - PayflowProResponseInput! + An input object that includes the payload returned by PayPal and the cart ID.
+
+
+
+

Example

+
+
Query
+ 
mutation handlePayflowProResponse($input: PayflowProResponseInput!) {
+  handlePayflowProResponse(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": PayflowProResponseInput}
+
+
+
+
Response
+ 
{"data": {"handlePayflowProResponse": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ mergeCarts +

+
+
+
+
Description
+

Transfer the contents of a guest cart into the cart of a logged-in customer.

+
+
+
+
+
+
+
Response
+

Returns a Cart! +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ source_cart_id - String! + The guest's cart ID before they login.
+ destination_cart_id - String + The cart ID after the guest logs in.
+
+
+
+

Example

+
+
Query
+ 
mutation mergeCarts(
+  $source_cart_id: String!,
+  $destination_cart_id: String
+) {
+  mergeCarts(
+    source_cart_id: $source_cart_id,
+    destination_cart_id: $destination_cart_id
+  ) {
+    applied_coupon {
+      ...AppliedCouponFragment
+    }
+    applied_coupons {
+      ...AppliedCouponFragment
+    }
+    applied_gift_cards {
+      ...AppliedGiftCardFragment
+    }
+    applied_reward_points {
+      ...RewardPointsAmountFragment
+    }
+    applied_store_credit {
+      ...AppliedStoreCreditFragment
+    }
+    available_gift_wrappings {
+      ...GiftWrappingFragment
+    }
+    available_payment_methods {
+      ...AvailablePaymentMethodFragment
+    }
+    billing_address {
+      ...BillingCartAddressFragment
+    }
+    email
+    gift_message {
+      ...GiftMessageFragment
+    }
+    gift_receipt_included
+    gift_wrapping {
+      ...GiftWrappingFragment
+    }
+    id
+    is_virtual
+    items {
+      ...CartItemInterfaceFragment
+    }
+    itemsV2 {
+      ...CartItemsFragment
+    }
+    prices {
+      ...CartPricesFragment
+    }
+    printed_card_included
+    rules {
+      ...CartRuleStorefrontFragment
+    }
+    selected_payment_method {
+      ...SelectedPaymentMethodFragment
+    }
+    shipping_addresses {
+      ...ShippingCartAddressFragment
+    }
+    total_quantity
+  }
+}
+
+
+
+
Variables
+ 
{
+  "source_cart_id": "xyz789",
+  "destination_cart_id": "abc123"
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "mergeCarts": {
+      "applied_coupon": AppliedCoupon,
+      "applied_coupons": [AppliedCoupon],
+      "applied_gift_cards": [AppliedGiftCard],
+      "applied_reward_points": RewardPointsAmount,
+      "applied_store_credit": AppliedStoreCredit,
+      "available_gift_wrappings": [GiftWrapping],
+      "available_payment_methods": [
+        AvailablePaymentMethod
+      ],
+      "billing_address": BillingCartAddress,
+      "email": "abc123",
+      "gift_message": GiftMessage,
+      "gift_receipt_included": false,
+      "gift_wrapping": GiftWrapping,
+      "id": 4,
+      "is_virtual": false,
+      "items": [CartItemInterface],
+      "itemsV2": CartItems,
+      "prices": CartPrices,
+      "printed_card_included": false,
+      "rules": [CartRuleStorefront],
+      "selected_payment_method": SelectedPaymentMethod,
+      "shipping_addresses": [ShippingCartAddress],
+      "total_quantity": 987.65
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ moveCartItemsToGiftRegistry +

+
+
+
+
Description
+

Move all items from the cart to a gift registry.

+
+
+
+
+
+
+
Response
+

Returns a MoveCartItemsToGiftRegistryOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ cartUid - ID! + The unique ID of the cart containing items to be moved to a gift registry.
+ giftRegistryUid - ID! + The unique ID of the target gift registry.
+
+
+
+

Example

+
+
Query
+ 
mutation moveCartItemsToGiftRegistry(
+  $cartUid: ID!,
+  $giftRegistryUid: ID!
+) {
+  moveCartItemsToGiftRegistry(
+    cartUid: $cartUid,
+    giftRegistryUid: $giftRegistryUid
+  ) {
+    gift_registry {
+      ...GiftRegistryFragment
+    }
+    status
+    user_errors {
+      ...GiftRegistryItemsUserErrorFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"cartUid": 4, "giftRegistryUid": 4}
+
+
+
+
Response
+ 
{
+  "data": {
+    "moveCartItemsToGiftRegistry": {
+      "gift_registry": GiftRegistry,
+      "status": true,
+      "user_errors": [GiftRegistryItemsUserError]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ moveItemsBetweenRequisitionLists +

+
+
+
+
Description
+

Move Items from one requisition list to another.

+
+
+
+
+
+
+
Response
+

Returns a MoveItemsBetweenRequisitionListsOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
+ sourceRequisitionListUid - ID! + The unique ID of the source requisition list.
+ destinationRequisitionListUid - ID + The unique ID of the destination requisition list. If null, a new requisition list will be created.
+ requisitionListItem - MoveItemsBetweenRequisitionListsInput + The list of products to move.
+
+
+
+

Example

+
+
Query
+ 
mutation moveItemsBetweenRequisitionLists(
+  $sourceRequisitionListUid: ID!,
+  $destinationRequisitionListUid: ID,
+  $requisitionListItem: MoveItemsBetweenRequisitionListsInput
+) {
+  moveItemsBetweenRequisitionLists(
+    sourceRequisitionListUid: $sourceRequisitionListUid,
+    destinationRequisitionListUid: $destinationRequisitionListUid,
+    requisitionListItem: $requisitionListItem
+  ) {
+    destination_requisition_list {
+      ...RequisitionListFragment
+    }
+    source_requisition_list {
+      ...RequisitionListFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{
+  "sourceRequisitionListUid": "4",
+  "destinationRequisitionListUid": "4",
+  "requisitionListItem": MoveItemsBetweenRequisitionListsInput
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "moveItemsBetweenRequisitionLists": {
+      "destination_requisition_list": RequisitionList,
+      "source_requisition_list": RequisitionList
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ moveLineItemToRequisitionList +

+
+
+
+
Description
+

Move negotiable quote item to requisition list.

+
+
+
+
+
+
+
Response
+

Returns a MoveLineItemToRequisitionListOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - MoveLineItemToRequisitionListInput! + An input object that defines the quote item and requisition list moved to.
+
+
+
+

Example

+
+
Query
+ 
mutation moveLineItemToRequisitionList($input: MoveLineItemToRequisitionListInput!) {
+  moveLineItemToRequisitionList(input: $input) {
+    quote {
+      ...NegotiableQuoteFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": MoveLineItemToRequisitionListInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "moveLineItemToRequisitionList": {
+      "quote": NegotiableQuote
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ moveProductsBetweenWishlists +

+
+
+
+
Description
+

Move products from one wish list to another.

+
+
+
+
+
+
+
Response
+

Returns a MoveProductsBetweenWishlistsOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
+ sourceWishlistUid - ID! + The ID of the original wish list.
+ destinationWishlistUid - ID! + The ID of the target wish list.
+ wishlistItems - [WishlistItemMoveInput!]! + An array of items to move.
+
+
+
+

Example

+
+
Query
+ 
mutation moveProductsBetweenWishlists(
+  $sourceWishlistUid: ID!,
+  $destinationWishlistUid: ID!,
+  $wishlistItems: [WishlistItemMoveInput!]!
+) {
+  moveProductsBetweenWishlists(
+    sourceWishlistUid: $sourceWishlistUid,
+    destinationWishlistUid: $destinationWishlistUid,
+    wishlistItems: $wishlistItems
+  ) {
+    destination_wishlist {
+      ...WishlistFragment
+    }
+    source_wishlist {
+      ...WishlistFragment
+    }
+    user_errors {
+      ...WishListUserInputErrorFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{
+  "sourceWishlistUid": "4",
+  "destinationWishlistUid": 4,
+  "wishlistItems": [WishlistItemMoveInput]
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "moveProductsBetweenWishlists": {
+      "destination_wishlist": Wishlist,
+      "source_wishlist": Wishlist,
+      "user_errors": [WishListUserInputError]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ openNegotiableQuoteTemplate +

+
+
+
+
Description
+

Open an existing negotiable quote template.

+
+
+
+
+
+
+
Response
+

Returns a NegotiableQuoteTemplate +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - OpenNegotiableQuoteTemplateInput! + An input object that contains the data to open a negotiable quote template.
+
+
+
+

Example

+
+
Query
+ 
mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) {
+  openNegotiableQuoteTemplate(input: $input) {
+    buyer {
+      ...NegotiableQuoteUserFragment
+    }
+    comments {
+      ...NegotiableQuoteCommentFragment
+    }
+    expiration_date
+    history {
+      ...NegotiableQuoteHistoryEntryFragment
+    }
+    is_min_max_qty_used
+    is_virtual
+    items {
+      ...CartItemInterfaceFragment
+    }
+    max_order_commitment
+    min_order_commitment
+    name
+    notifications {
+      ...QuoteTemplateNotificationMessageFragment
+    }
+    prices {
+      ...CartPricesFragment
+    }
+    reference_document_links {
+      ...NegotiableQuoteReferenceDocumentLinkFragment
+    }
+    shipping_addresses {
+      ...NegotiableQuoteShippingAddressFragment
+    }
+    status
+    template_id
+    total_quantity
+  }
+}
+
+
+
+
Variables
+ 
{"input": OpenNegotiableQuoteTemplateInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "openNegotiableQuoteTemplate": {
+      "buyer": NegotiableQuoteUser,
+      "comments": [NegotiableQuoteComment],
+      "expiration_date": "xyz789",
+      "history": [NegotiableQuoteHistoryEntry],
+      "is_min_max_qty_used": false,
+      "is_virtual": true,
+      "items": [CartItemInterface],
+      "max_order_commitment": 123,
+      "min_order_commitment": 123,
+      "name": "xyz789",
+      "notifications": [QuoteTemplateNotificationMessage],
+      "prices": CartPrices,
+      "reference_document_links": [
+        NegotiableQuoteReferenceDocumentLink
+      ],
+      "shipping_addresses": [
+        NegotiableQuoteShippingAddress
+      ],
+      "status": "xyz789",
+      "template_id": 4,
+      "total_quantity": 123.45
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ placeNegotiableQuoteOrder +

+
+
+
+
Description
+

Convert a negotiable quote into an order.

+
+
+
+
+
+
+
Response
+

Returns a PlaceNegotiableQuoteOrderOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - PlaceNegotiableQuoteOrderInput! + An input object that specifies the negotiable quote.
+
+
+
+

Example

+
+
Query
+ 
mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) {
+  placeNegotiableQuoteOrder(input: $input) {
+    order {
+      ...OrderFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": PlaceNegotiableQuoteOrderInput}
+
+
+
+
Response
+ 
{"data": {"placeNegotiableQuoteOrder": {"order": Order}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ placeOrder +

+
+
+
+
Description
+

Convert the quote into an order.

+
+
+
+
+
+
+
Response
+

Returns a PlaceOrderOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - PlaceOrderInput + An input object that defines the shopper's cart ID.
+
+
+
+

Example

+
+
Query
+ 
mutation placeOrder($input: PlaceOrderInput) {
+  placeOrder(input: $input) {
+    errors {
+      ...PlaceOrderErrorFragment
+    }
+    order {
+      ...OrderFragment
+    }
+    orderV2 {
+      ...CustomerOrderFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": PlaceOrderInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "placeOrder": {
+      "errors": [PlaceOrderError],
+      "order": Order,
+      "orderV2": CustomerOrder
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ placeOrderForPurchaseOrder +

+
+
+
+
Description
+

Convert the purchase order into an order.

+
+
+
+
+
+
+
Response
+

Returns a PlaceOrderForPurchaseOrderOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - PlaceOrderForPurchaseOrderInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) {
+  placeOrderForPurchaseOrder(input: $input) {
+    order {
+      ...CustomerOrderFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": PlaceOrderForPurchaseOrderInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "placeOrderForPurchaseOrder": {"order": CustomerOrder}
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ placePurchaseOrder +

+
+
+
+
Description
+

Place a purchase order.

+
+
+
+
+
+
+
Response
+

Returns a PlacePurchaseOrderOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - PlacePurchaseOrderInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) {
+  placePurchaseOrder(input: $input) {
+    purchase_order {
+      ...PurchaseOrderFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": PlacePurchaseOrderInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "placePurchaseOrder": {
+      "purchase_order": PurchaseOrder
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ redeemGiftCardBalanceAsStoreCredit +

+
+
+
+
Description
+

Redeem a gift card for store credit.

+
+
+
+
+
+
+
Response
+

Returns a GiftCardAccount +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - GiftCardAccountInput! + An input object that specifies the gift card code to redeem.
+
+
+
+

Example

+
+
Query
+ 
mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) {
+  redeemGiftCardBalanceAsStoreCredit(input: $input) {
+    balance {
+      ...MoneyFragment
+    }
+    code
+    expiration_date
+  }
+}
+
+
+
+
Variables
+ 
{"input": GiftCardAccountInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "redeemGiftCardBalanceAsStoreCredit": {
+      "balance": Money,
+      "code": "xyz789",
+      "expiration_date": "xyz789"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ rejectPurchaseOrders +

+
+
+
+
Description
+

Reject purchase orders.

+
+
+
+
+
+
+
Response
+

Returns a PurchaseOrdersActionOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - PurchaseOrdersActionInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation rejectPurchaseOrders($input: PurchaseOrdersActionInput!) {
+  rejectPurchaseOrders(input: $input) {
+    errors {
+      ...PurchaseOrderActionErrorFragment
+    }
+    purchase_orders {
+      ...PurchaseOrderFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": PurchaseOrdersActionInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "rejectPurchaseOrders": {
+      "errors": [PurchaseOrderActionError],
+      "purchase_orders": [PurchaseOrder]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ removeCouponFromCart +

+
+
+
+
Description
+

Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon.

+
+
+
+
+
+
+
Response
+

Returns a RemoveCouponFromCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - RemoveCouponFromCartInput + An input object that defines which coupon code to remove from the cart.
+
+
+
+

Example

+
+
Query
+ 
mutation removeCouponFromCart($input: RemoveCouponFromCartInput) {
+  removeCouponFromCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": RemoveCouponFromCartInput}
+
+
+
+
Response
+ 
{"data": {"removeCouponFromCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ removeCouponsFromCart +

+
+
+
+
Description
+

Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon.

+
+
+
+
+
+
+
Response
+

Returns a RemoveCouponFromCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - RemoveCouponsFromCartInput + An input object that defines which coupon code to remove from the cart.
+
+
+
+

Example

+
+
Query
+ 
mutation removeCouponsFromCart($input: RemoveCouponsFromCartInput) {
+  removeCouponsFromCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": RemoveCouponsFromCartInput}
+
+
+
+
Response
+ 
{"data": {"removeCouponsFromCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ removeGiftCardFromCart +

+
+
+
+
Description
+

Removes a gift card from the cart.

+
+
+
+
+
+
+
Response
+

Returns a RemoveGiftCardFromCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - RemoveGiftCardFromCartInput + An input object that specifies which gift card code to remove from the cart.
+
+
+
+

Example

+
+
Query
+ 
mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) {
+  removeGiftCardFromCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": RemoveGiftCardFromCartInput}
+
+
+
+
Response
+ 
{"data": {"removeGiftCardFromCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ removeGiftRegistry +

+
+
+
+
Description
+

Delete the specified gift registry.

+
+
+
+
+
+
+
Response
+

Returns a RemoveGiftRegistryOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ giftRegistryUid - ID! + The unique ID of the gift registry to delete.
+
+
+
+

Example

+
+
Query
+ 
mutation removeGiftRegistry($giftRegistryUid: ID!) {
+  removeGiftRegistry(giftRegistryUid: $giftRegistryUid) {
+    success
+  }
+}
+
+
+
+
Variables
+ 
{"giftRegistryUid": 4}
+
+
+
+
Response
+ 
{"data": {"removeGiftRegistry": {"success": false}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ removeGiftRegistryItems +

+
+
+
+
Description
+

Delete the specified items from a gift registry.

+
+
+
+
+
+
+
Response
+

Returns a RemoveGiftRegistryItemsOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ giftRegistryUid - ID! + The unique ID of the gift registry.
+ itemsUid - [ID!]! + An array of item IDs to remove from the gift registry.
+
+
+
+

Example

+
+
Query
+ 
mutation removeGiftRegistryItems(
+  $giftRegistryUid: ID!,
+  $itemsUid: [ID!]!
+) {
+  removeGiftRegistryItems(
+    giftRegistryUid: $giftRegistryUid,
+    itemsUid: $itemsUid
+  ) {
+    gift_registry {
+      ...GiftRegistryFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"giftRegistryUid": 4, "itemsUid": [4]}
+
+
+
+
Response
+ 
{
+  "data": {
+    "removeGiftRegistryItems": {
+      "gift_registry": GiftRegistry
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ removeGiftRegistryRegistrants +

+
+
+
+
Description
+

Removes registrants from a gift registry.

+
+
+
+
+
+
+
Response
+

Returns a RemoveGiftRegistryRegistrantsOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ giftRegistryUid - ID! + The unique ID of the gift registry.
+ registrantsUid - [ID!]! + An array of registrant IDs to remove.
+
+
+
+

Example

+
+
Query
+ 
mutation removeGiftRegistryRegistrants(
+  $giftRegistryUid: ID!,
+  $registrantsUid: [ID!]!
+) {
+  removeGiftRegistryRegistrants(
+    giftRegistryUid: $giftRegistryUid,
+    registrantsUid: $registrantsUid
+  ) {
+    gift_registry {
+      ...GiftRegistryFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{
+  "giftRegistryUid": "4",
+  "registrantsUid": ["4"]
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "removeGiftRegistryRegistrants": {
+      "gift_registry": GiftRegistry
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ removeItemFromCart +

+
+
+
+
Description
+

Delete the entire quantity of a specified item from the cart. If you remove all items from the cart, the cart continues to exist.

+
+
+
+
+
+
+
Response
+

Returns a RemoveItemFromCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - RemoveItemFromCartInput + An input object that defines which products to remove from the cart.
+
+
+
+

Example

+
+
Query
+ 
mutation removeItemFromCart($input: RemoveItemFromCartInput) {
+  removeItemFromCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": RemoveItemFromCartInput}
+
+
+
+
Response
+ 
{"data": {"removeItemFromCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ removeNegotiableQuoteItems +

+
+
+
+
Description
+

Remove one or more products from a negotiable quote.

+
+
+
+
+
+
+
Response
+

Returns a RemoveNegotiableQuoteItemsOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - RemoveNegotiableQuoteItemsInput! + An input object that removes one or more items from a negotiable quote.
+
+
+
+

Example

+
+
Query
+ 
mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) {
+  removeNegotiableQuoteItems(input: $input) {
+    quote {
+      ...NegotiableQuoteFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": RemoveNegotiableQuoteItemsInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "removeNegotiableQuoteItems": {
+      "quote": NegotiableQuote
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ removeNegotiableQuoteTemplateItems +

+
+
+
+
Description
+

Remove one or more products from a negotiable quote template.

+
+
+
+
+
+
+
Response
+

Returns a NegotiableQuoteTemplate +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - RemoveNegotiableQuoteTemplateItemsInput! + An input object that removes one or more items from a negotiable quote template.
+
+
+
+

Example

+
+
Query
+ 
mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplateItemsInput!) {
+  removeNegotiableQuoteTemplateItems(input: $input) {
+    buyer {
+      ...NegotiableQuoteUserFragment
+    }
+    comments {
+      ...NegotiableQuoteCommentFragment
+    }
+    expiration_date
+    history {
+      ...NegotiableQuoteHistoryEntryFragment
+    }
+    is_min_max_qty_used
+    is_virtual
+    items {
+      ...CartItemInterfaceFragment
+    }
+    max_order_commitment
+    min_order_commitment
+    name
+    notifications {
+      ...QuoteTemplateNotificationMessageFragment
+    }
+    prices {
+      ...CartPricesFragment
+    }
+    reference_document_links {
+      ...NegotiableQuoteReferenceDocumentLinkFragment
+    }
+    shipping_addresses {
+      ...NegotiableQuoteShippingAddressFragment
+    }
+    status
+    template_id
+    total_quantity
+  }
+}
+
+
+
+
Variables
+ 
{"input": RemoveNegotiableQuoteTemplateItemsInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "removeNegotiableQuoteTemplateItems": {
+      "buyer": NegotiableQuoteUser,
+      "comments": [NegotiableQuoteComment],
+      "expiration_date": "abc123",
+      "history": [NegotiableQuoteHistoryEntry],
+      "is_min_max_qty_used": false,
+      "is_virtual": true,
+      "items": [CartItemInterface],
+      "max_order_commitment": 987,
+      "min_order_commitment": 987,
+      "name": "abc123",
+      "notifications": [QuoteTemplateNotificationMessage],
+      "prices": CartPrices,
+      "reference_document_links": [
+        NegotiableQuoteReferenceDocumentLink
+      ],
+      "shipping_addresses": [
+        NegotiableQuoteShippingAddress
+      ],
+      "status": "abc123",
+      "template_id": 4,
+      "total_quantity": 123.45
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ removeProductsFromCompareList +

+
+
+
+
Description
+

Remove products from the specified compare list.

+
+
+
+
+
+
+
Response
+

Returns a CompareList +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - RemoveProductsFromCompareListInput + An input object that defines which products to remove from a compare list.
+
+
+
+

Example

+
+
Query
+ 
mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInput) {
+  removeProductsFromCompareList(input: $input) {
+    attributes {
+      ...ComparableAttributeFragment
+    }
+    item_count
+    items {
+      ...ComparableItemFragment
+    }
+    uid
+  }
+}
+
+
+
+
Variables
+ 
{"input": RemoveProductsFromCompareListInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "removeProductsFromCompareList": {
+      "attributes": [ComparableAttribute],
+      "item_count": 123,
+      "items": [ComparableItem],
+      "uid": 4
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ removeProductsFromWishlist +

+
+
+
+
Description
+

Remove one or more products from the specified wish list.

+
+
+
+
+
+
+
Response
+

Returns a RemoveProductsFromWishlistOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ wishlistId - ID! + The ID of a wish list.
+ wishlistItemsIds - [ID!]! + An array of item IDs representing products to be removed.
+
+
+
+

Example

+
+
Query
+ 
mutation removeProductsFromWishlist(
+  $wishlistId: ID!,
+  $wishlistItemsIds: [ID!]!
+) {
+  removeProductsFromWishlist(
+    wishlistId: $wishlistId,
+    wishlistItemsIds: $wishlistItemsIds
+  ) {
+    user_errors {
+      ...WishListUserInputErrorFragment
+    }
+    wishlist {
+      ...WishlistFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{
+  "wishlistId": "4",
+  "wishlistItemsIds": ["4"]
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "removeProductsFromWishlist": {
+      "user_errors": [WishListUserInputError],
+      "wishlist": Wishlist
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ removeReturnTracking +

+
+
+
+
Description
+

Remove a tracked shipment from a return.

+
+
+
+
+
+
+
Response
+

Returns a RemoveReturnTrackingOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - RemoveReturnTrackingInput! + An input object that removes tracking information.
+
+
+
+

Example

+
+
Query
+ 
mutation removeReturnTracking($input: RemoveReturnTrackingInput!) {
+  removeReturnTracking(input: $input) {
+    return {
+      ...ReturnFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": RemoveReturnTrackingInput}
+
+
+
+
Response
+ 
{"data": {"removeReturnTracking": {"return": Return}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ removeRewardPointsFromCart +

+
+
+
+
Description
+

Cancel the application of reward points to the cart.

+
+
+
+
+
+
+
Response
+

Returns a RemoveRewardPointsFromCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ cartId - ID! + +
+
+
+
+

Example

+
+
Query
+ 
mutation removeRewardPointsFromCart($cartId: ID!) {
+  removeRewardPointsFromCart(cartId: $cartId) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"cartId": 4}
+
+
+
+
Response
+ 
{"data": {"removeRewardPointsFromCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ removeStoreCreditFromCart +

+
+
+
+
Description
+

Remove store credit that has been applied to the specified cart.

+
+
+
+
+
+
+
Response
+

Returns a RemoveStoreCreditFromCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - RemoveStoreCreditFromCartInput! + An input object that specifies the cart ID.
+
+
+
+

Example

+
+
Query
+ 
mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) {
+  removeStoreCreditFromCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": RemoveStoreCreditFromCartInput}
+
+
+
+
Response
+ 
{"data": {"removeStoreCreditFromCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ renameNegotiableQuote +

+
+
+
+
Description
+

Rename negotiable quote.

+
+
+
+
+
+
+
Response
+

Returns a RenameNegotiableQuoteOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - RenameNegotiableQuoteInput! + An input object that defines the quote item name and comment.
+
+
+
+

Example

+
+
Query
+ 
mutation renameNegotiableQuote($input: RenameNegotiableQuoteInput!) {
+  renameNegotiableQuote(input: $input) {
+    quote {
+      ...NegotiableQuoteFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": RenameNegotiableQuoteInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "renameNegotiableQuote": {"quote": NegotiableQuote}
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ reorderItems +

+
+
+
+
Description
+

Add all products from a customer's previous order to the cart.

+
+
+
+
+
+
+
Response
+

Returns a ReorderItemsOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ orderNumber - String! + +
+
+
+
+

Example

+
+
Query
+ 
mutation reorderItems($orderNumber: String!) {
+  reorderItems(orderNumber: $orderNumber) {
+    cart {
+      ...CartFragment
+    }
+    userInputErrors {
+      ...CheckoutUserInputErrorFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"orderNumber": "abc123"}
+
+
+
+
Response
+ 
{
+  "data": {
+    "reorderItems": {
+      "cart": Cart,
+      "userInputErrors": [CheckoutUserInputError]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ requestGuestOrderCancel +

+
+
+
+
Description
+

Request to cancel specified guest order.

+
+
+
+
+
+
+
Response
+

Returns a CancelOrderOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - GuestOrderCancelInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation requestGuestOrderCancel($input: GuestOrderCancelInput!) {
+  requestGuestOrderCancel(input: $input) {
+    error
+    errorV2 {
+      ...CancelOrderErrorFragment
+    }
+    order {
+      ...CustomerOrderFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": GuestOrderCancelInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "requestGuestOrderCancel": {
+      "error": "xyz789",
+      "errorV2": CancelOrderError,
+      "order": CustomerOrder
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ requestGuestReturn +

+
+
+
+
Response
+

Returns a RequestReturnOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - RequestGuestReturnInput! + An input object that contains the fields needed to start a return request for guest.
+
+
+
+

Example

+
+
Query
+ 
mutation requestGuestReturn($input: RequestGuestReturnInput!) {
+  requestGuestReturn(input: $input) {
+    return {
+      ...ReturnFragment
+    }
+    returns {
+      ...ReturnsFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": RequestGuestReturnInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "requestGuestReturn": {
+      "return": Return,
+      "returns": Returns
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ requestNegotiableQuote +

+
+
+
+
Description
+

Request a new negotiable quote on behalf of the buyer.

+
+
+
+
+
+
+
Response
+

Returns a RequestNegotiableQuoteOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - RequestNegotiableQuoteInput! + An input object that contains a request to initiate a negotiable quote.
+
+
+
+

Example

+
+
Query
+ 
mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) {
+  requestNegotiableQuote(input: $input) {
+    quote {
+      ...NegotiableQuoteFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": RequestNegotiableQuoteInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "requestNegotiableQuote": {"quote": NegotiableQuote}
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ requestNegotiableQuoteTemplateFromQuote +

+
+
+
+
Description
+

Request a new negotiable quote on behalf of the buyer.

+
+
+
+
+
+
+
Response
+

Returns a NegotiableQuoteTemplate +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - RequestNegotiableQuoteTemplateInput! + An input object that contains a request to initiate a negotiable quote template.
+
+
+
+

Example

+
+
Query
+ 
mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteTemplateInput!) {
+  requestNegotiableQuoteTemplateFromQuote(input: $input) {
+    buyer {
+      ...NegotiableQuoteUserFragment
+    }
+    comments {
+      ...NegotiableQuoteCommentFragment
+    }
+    expiration_date
+    history {
+      ...NegotiableQuoteHistoryEntryFragment
+    }
+    is_min_max_qty_used
+    is_virtual
+    items {
+      ...CartItemInterfaceFragment
+    }
+    max_order_commitment
+    min_order_commitment
+    name
+    notifications {
+      ...QuoteTemplateNotificationMessageFragment
+    }
+    prices {
+      ...CartPricesFragment
+    }
+    reference_document_links {
+      ...NegotiableQuoteReferenceDocumentLinkFragment
+    }
+    shipping_addresses {
+      ...NegotiableQuoteShippingAddressFragment
+    }
+    status
+    template_id
+    total_quantity
+  }
+}
+
+
+
+
Variables
+ 
{"input": RequestNegotiableQuoteTemplateInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "requestNegotiableQuoteTemplateFromQuote": {
+      "buyer": NegotiableQuoteUser,
+      "comments": [NegotiableQuoteComment],
+      "expiration_date": "xyz789",
+      "history": [NegotiableQuoteHistoryEntry],
+      "is_min_max_qty_used": true,
+      "is_virtual": false,
+      "items": [CartItemInterface],
+      "max_order_commitment": 123,
+      "min_order_commitment": 987,
+      "name": "xyz789",
+      "notifications": [QuoteTemplateNotificationMessage],
+      "prices": CartPrices,
+      "reference_document_links": [
+        NegotiableQuoteReferenceDocumentLink
+      ],
+      "shipping_addresses": [
+        NegotiableQuoteShippingAddress
+      ],
+      "status": "xyz789",
+      "template_id": "4",
+      "total_quantity": 987.65
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ requestPasswordResetEmail +

+
+
+
+
Description
+

Request an email with a reset password token for the registered customer identified by the specified email.

+
+
+
+
+
+
+
Response
+

Returns a Boolean +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ email - String! + The customer's email address.
+
+
+
+

Example

+
+
Query
+ 
mutation requestPasswordResetEmail($email: String!) {
+  requestPasswordResetEmail(email: $email)
+}
+
+
+
+
Variables
+ 
{"email": "xyz789"}
+
+
+
+
Response
+ 
{"data": {"requestPasswordResetEmail": true}}
+
+
+
+
+
+
+
+ Mutations +
+

+ requestReturn +

+
+
+
+
Description
+

Initiates a buyer's request to return items for replacement or refund.

+
+
+
+
+
+
+
Response
+

Returns a RequestReturnOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - RequestReturnInput! + An input object that contains the fields needed to start a return request.
+
+
+
+

Example

+
+
Query
+ 
mutation requestReturn($input: RequestReturnInput!) {
+  requestReturn(input: $input) {
+    return {
+      ...ReturnFragment
+    }
+    returns {
+      ...ReturnsFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": RequestReturnInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "requestReturn": {
+      "return": Return,
+      "returns": Returns
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ resendConfirmationEmail +

+
+
+
+
Description
+

Resends the confirmation email to a customer.

+
+
+
+
+
+
+
Response
+

Returns a Boolean +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ email - String! + The email address to send the confirmation email to.
+
+
+
+

Example

+
+
Query
+ 
mutation resendConfirmationEmail($email: String!) {
+  resendConfirmationEmail(email: $email)
+}
+
+
+
+
Variables
+ 
{"email": "abc123"}
+
+
+
+
Response
+ 
{"data": {"resendConfirmationEmail": true}}
+
+
+
+
+
+
+
+ Mutations +
+

+ resetPassword +

+
+
+
+
Description
+

Reset a customer's password using the reset password token that the customer received in an email after requesting it using requestPasswordResetEmail.

+
+
+
+
+
+
+
Response
+

Returns a Boolean +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
+ email - String! + The customer's email address.
+ resetPasswordToken - String! + A runtime token generated by the requestPasswordResetEmail mutation.
+ newPassword - String! + The customer's new password.
+
+
+
+

Example

+
+
Query
+ 
mutation resetPassword(
+  $email: String!,
+  $resetPasswordToken: String!,
+  $newPassword: String!
+) {
+  resetPassword(
+    email: $email,
+    resetPasswordToken: $resetPasswordToken,
+    newPassword: $newPassword
+  )
+}
+
+
+
+
Variables
+ 
{
+  "email": "xyz789",
+  "resetPasswordToken": "abc123",
+  "newPassword": "abc123"
+}
+
+
+
+
Response
+ 
{"data": {"resetPassword": true}}
+
+
+
+
+
+
+
+ Mutations +
+

+ revokeCustomerToken +

+
+
+
+
Description
+

Revoke the customer token.

+
+
+
+
+
+
+
Response
+

Returns a RevokeCustomerTokenOutput +

+
+
+
+

Example

+
+
Query
+ 
mutation revokeCustomerToken {
+  revokeCustomerToken {
+    result
+  }
+}
+
+
+
+
Response
+ 
{"data": {"revokeCustomerToken": {"result": true}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ sendEmailToFriend +

+
+
+
+
Description
+

Send a message on behalf of a customer to the specified email addresses.

+
+
+
+
+
+
+
Response
+

Returns a SendEmailToFriendOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - SendEmailToFriendInput + An input object that defines sender, recipients, and product.
+
+
+
+

Example

+
+
Query
+ 
mutation sendEmailToFriend($input: SendEmailToFriendInput) {
+  sendEmailToFriend(input: $input) {
+    recipients {
+      ...SendEmailToFriendRecipientFragment
+    }
+    sender {
+      ...SendEmailToFriendSenderFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": SendEmailToFriendInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "sendEmailToFriend": {
+      "recipients": [SendEmailToFriendRecipient],
+      "sender": SendEmailToFriendSender
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ sendNegotiableQuoteForReview +

+
+
+
+
Description
+

Send the negotiable quote to the seller for review.

+
+
+
+
+
+
+
Response
+

Returns a SendNegotiableQuoteForReviewOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - SendNegotiableQuoteForReviewInput! + An input object that sends a request for the merchant to review a negotiable quote.
+
+
+
+

Example

+
+
Query
+ 
mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput!) {
+  sendNegotiableQuoteForReview(input: $input) {
+    quote {
+      ...NegotiableQuoteFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": SendNegotiableQuoteForReviewInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "sendNegotiableQuoteForReview": {
+      "quote": NegotiableQuote
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ setBillingAddressOnCart +

+
+
+
+
Description
+

Set the billing address on a specific cart.

+
+
+
+
+
+
+
Response
+

Returns a SetBillingAddressOnCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - SetBillingAddressOnCartInput + An input object that defines the billing address to be assigned to the cart.
+
+
+
+

Example

+
+
Query
+ 
mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) {
+  setBillingAddressOnCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": SetBillingAddressOnCartInput}
+
+
+
+
Response
+ 
{"data": {"setBillingAddressOnCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ setCartAsInactive +

+
+
+
+
Description
+

Sets the cart as inactive

+
+
+
+
+
+
+
Response
+

Returns a SetCartAsInactiveOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ cartId - String! + The customer cart ID
+
+
+
+

Example

+
+
Query
+ 
mutation setCartAsInactive($cartId: String!) {
+  setCartAsInactive(cartId: $cartId) {
+    error
+    success
+  }
+}
+
+
+
+
Variables
+ 
{"cartId": "abc123"}
+
+
+
+
Response
+ 
{
+  "data": {
+    "setCartAsInactive": {
+      "error": "abc123",
+      "success": false
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ setGiftOptionsOnCart +

+
+
+
+
Description
+

Set gift options, including gift messages, gift wrapping, gift receipts, and printed cards.

+
+
+
+
+
+
+
Response
+

Returns a SetGiftOptionsOnCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - SetGiftOptionsOnCartInput + An input object that defines the selected gift options.
+
+
+
+

Example

+
+
Query
+ 
mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) {
+  setGiftOptionsOnCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": SetGiftOptionsOnCartInput}
+
+
+
+
Response
+ 
{"data": {"setGiftOptionsOnCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ setGuestEmailOnCart +

+
+
+
+
Description
+

Assign the email address of a guest to the cart.

+
+
+
+
+
+
+
Response
+

Returns a SetGuestEmailOnCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - SetGuestEmailOnCartInput + An input object that defines a guest email address.
+
+
+
+

Example

+
+
Query
+ 
mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) {
+  setGuestEmailOnCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": SetGuestEmailOnCartInput}
+
+
+
+
Response
+ 
{"data": {"setGuestEmailOnCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ setLineItemNote +

+
+
+
+
Description
+

Add buyer's note to a negotiable quote item.

+
+
+
+
+
+
+
Response
+

Returns a SetLineItemNoteOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - LineItemNoteInput! + An input object that defines the quote item note.
+
+
+
+

Example

+
+
Query
+ 
mutation setLineItemNote($input: LineItemNoteInput!) {
+  setLineItemNote(input: $input) {
+    quote {
+      ...NegotiableQuoteFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": LineItemNoteInput}
+
+
+
+
Response
+ 
{"data": {"setLineItemNote": {"quote": NegotiableQuote}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ setNegotiableQuoteBillingAddress +

+
+
+
+
Description
+

Assign a billing address to a negotiable quote.

+
+
+
+
+
+
+
Response
+

Returns a SetNegotiableQuoteBillingAddressOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - SetNegotiableQuoteBillingAddressInput! + An input object that defines the billing address to be assigned to a negotiable quote.
+
+
+
+

Example

+
+
Query
+ 
mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddressInput!) {
+  setNegotiableQuoteBillingAddress(input: $input) {
+    quote {
+      ...NegotiableQuoteFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": SetNegotiableQuoteBillingAddressInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "setNegotiableQuoteBillingAddress": {
+      "quote": NegotiableQuote
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ setNegotiableQuotePaymentMethod +

+
+
+
+
Description
+

Set the payment method on a negotiable quote.

+
+
+
+
+
+
+
Response
+

Returns a SetNegotiableQuotePaymentMethodOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - SetNegotiableQuotePaymentMethodInput! + An input object that defines the payment method for the specified negotiable quote.
+
+
+
+

Example

+
+
Query
+ 
mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethodInput!) {
+  setNegotiableQuotePaymentMethod(input: $input) {
+    quote {
+      ...NegotiableQuoteFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": SetNegotiableQuotePaymentMethodInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "setNegotiableQuotePaymentMethod": {
+      "quote": NegotiableQuote
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ setNegotiableQuoteShippingAddress +

+
+
+
+
Description
+

Assign a previously-defined address as the shipping address for a negotiable quote.

+
+
+
+
+
+
+
Response
+

Returns a SetNegotiableQuoteShippingAddressOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - SetNegotiableQuoteShippingAddressInput! + An input object that defines the shipping address to be assigned to a negotiable quote.
+
+
+
+

Example

+
+
Query
+ 
mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAddressInput!) {
+  setNegotiableQuoteShippingAddress(input: $input) {
+    quote {
+      ...NegotiableQuoteFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": SetNegotiableQuoteShippingAddressInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "setNegotiableQuoteShippingAddress": {
+      "quote": NegotiableQuote
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ setNegotiableQuoteShippingMethods +

+
+
+
+
Description
+

Assign the shipping methods on the negotiable quote.

+
+
+
+
+
+
+
Response
+

Returns a SetNegotiableQuoteShippingMethodsOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - SetNegotiableQuoteShippingMethodsInput! + An input object that defines the shipping methods to be assigned to a negotiable quote.
+
+
+
+

Example

+
+
Query
+ 
mutation setNegotiableQuoteShippingMethods($input: SetNegotiableQuoteShippingMethodsInput!) {
+  setNegotiableQuoteShippingMethods(input: $input) {
+    quote {
+      ...NegotiableQuoteFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": SetNegotiableQuoteShippingMethodsInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "setNegotiableQuoteShippingMethods": {
+      "quote": NegotiableQuote
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ setNegotiableQuoteTemplateShippingAddress +

+
+
+
+
Description
+

Assign a previously-defined address as the shipping address for a negotiable quote template.

+
+
+
+
+
+
+
Response
+

Returns a NegotiableQuoteTemplate +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - SetNegotiableQuoteTemplateShippingAddressInput! + An input object that defines the shipping address to be assigned to a negotiable quote template.
+
+
+
+

Example

+
+
Query
+ 
mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTemplateShippingAddressInput!) {
+  setNegotiableQuoteTemplateShippingAddress(input: $input) {
+    buyer {
+      ...NegotiableQuoteUserFragment
+    }
+    comments {
+      ...NegotiableQuoteCommentFragment
+    }
+    expiration_date
+    history {
+      ...NegotiableQuoteHistoryEntryFragment
+    }
+    is_min_max_qty_used
+    is_virtual
+    items {
+      ...CartItemInterfaceFragment
+    }
+    max_order_commitment
+    min_order_commitment
+    name
+    notifications {
+      ...QuoteTemplateNotificationMessageFragment
+    }
+    prices {
+      ...CartPricesFragment
+    }
+    reference_document_links {
+      ...NegotiableQuoteReferenceDocumentLinkFragment
+    }
+    shipping_addresses {
+      ...NegotiableQuoteShippingAddressFragment
+    }
+    status
+    template_id
+    total_quantity
+  }
+}
+
+
+
+
Variables
+ 
{"input": SetNegotiableQuoteTemplateShippingAddressInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "setNegotiableQuoteTemplateShippingAddress": {
+      "buyer": NegotiableQuoteUser,
+      "comments": [NegotiableQuoteComment],
+      "expiration_date": "xyz789",
+      "history": [NegotiableQuoteHistoryEntry],
+      "is_min_max_qty_used": true,
+      "is_virtual": true,
+      "items": [CartItemInterface],
+      "max_order_commitment": 123,
+      "min_order_commitment": 987,
+      "name": "abc123",
+      "notifications": [QuoteTemplateNotificationMessage],
+      "prices": CartPrices,
+      "reference_document_links": [
+        NegotiableQuoteReferenceDocumentLink
+      ],
+      "shipping_addresses": [
+        NegotiableQuoteShippingAddress
+      ],
+      "status": "abc123",
+      "template_id": 4,
+      "total_quantity": 123.45
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ setPaymentMethodAndPlaceOrder +

+
+
+
+
Should use setPaymentMethodOnCart and placeOrder mutations in single request.
+
+
+
+
+
+
+
Description
+

Set the cart payment method and convert the cart into an order.

+
+
+
+
+
+
+
Response
+

Returns a PlaceOrderOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - SetPaymentMethodAndPlaceOrderInput + +
+
+
+
+

Example

+
+
Query
+ 
mutation setPaymentMethodAndPlaceOrder($input: SetPaymentMethodAndPlaceOrderInput) {
+  setPaymentMethodAndPlaceOrder(input: $input) {
+    errors {
+      ...PlaceOrderErrorFragment
+    }
+    order {
+      ...OrderFragment
+    }
+    orderV2 {
+      ...CustomerOrderFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": SetPaymentMethodAndPlaceOrderInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "setPaymentMethodAndPlaceOrder": {
+      "errors": [PlaceOrderError],
+      "order": Order,
+      "orderV2": CustomerOrder
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ setPaymentMethodOnCart +

+
+
+
+
Description
+

Apply a payment method to the cart.

+
+
+
+
+
+
+
Response
+

Returns a SetPaymentMethodOnCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - SetPaymentMethodOnCartInput + An input object that defines which payment method to apply to the cart.
+
+
+
+

Example

+
+
Query
+ 
mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) {
+  setPaymentMethodOnCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": SetPaymentMethodOnCartInput}
+
+
+
+
Response
+ 
{"data": {"setPaymentMethodOnCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ setQuoteTemplateLineItemNote +

+
+
+
+
Description
+

Add buyer's note to a negotiable quote template item.

+
+
+
+
+
+
+
Response
+

Returns a NegotiableQuoteTemplate +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - QuoteTemplateLineItemNoteInput! + An input object that defines the quote template item note.
+
+
+
+

Example

+
+
Query
+ 
mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) {
+  setQuoteTemplateLineItemNote(input: $input) {
+    buyer {
+      ...NegotiableQuoteUserFragment
+    }
+    comments {
+      ...NegotiableQuoteCommentFragment
+    }
+    expiration_date
+    history {
+      ...NegotiableQuoteHistoryEntryFragment
+    }
+    is_min_max_qty_used
+    is_virtual
+    items {
+      ...CartItemInterfaceFragment
+    }
+    max_order_commitment
+    min_order_commitment
+    name
+    notifications {
+      ...QuoteTemplateNotificationMessageFragment
+    }
+    prices {
+      ...CartPricesFragment
+    }
+    reference_document_links {
+      ...NegotiableQuoteReferenceDocumentLinkFragment
+    }
+    shipping_addresses {
+      ...NegotiableQuoteShippingAddressFragment
+    }
+    status
+    template_id
+    total_quantity
+  }
+}
+
+
+
+
Variables
+ 
{"input": QuoteTemplateLineItemNoteInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "setQuoteTemplateLineItemNote": {
+      "buyer": NegotiableQuoteUser,
+      "comments": [NegotiableQuoteComment],
+      "expiration_date": "xyz789",
+      "history": [NegotiableQuoteHistoryEntry],
+      "is_min_max_qty_used": true,
+      "is_virtual": true,
+      "items": [CartItemInterface],
+      "max_order_commitment": 123,
+      "min_order_commitment": 123,
+      "name": "xyz789",
+      "notifications": [QuoteTemplateNotificationMessage],
+      "prices": CartPrices,
+      "reference_document_links": [
+        NegotiableQuoteReferenceDocumentLink
+      ],
+      "shipping_addresses": [
+        NegotiableQuoteShippingAddress
+      ],
+      "status": "abc123",
+      "template_id": "4",
+      "total_quantity": 987.65
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ setShippingAddressesOnCart +

+
+
+
+
Description
+

Set one or more shipping addresses on a specific cart.

+
+
+
+
+
+
+
Response
+

Returns a SetShippingAddressesOnCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - SetShippingAddressesOnCartInput + An input object that defines one or more shipping addresses to be assigned to the cart.
+
+
+
+

Example

+
+
Query
+ 
mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) {
+  setShippingAddressesOnCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": SetShippingAddressesOnCartInput}
+
+
+
+
Response
+ 
{"data": {"setShippingAddressesOnCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ setShippingMethodsOnCart +

+
+
+
+
Description
+

Set one or more delivery methods on a cart.

+
+
+
+
+
+
+
Response
+

Returns a SetShippingMethodsOnCartOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - SetShippingMethodsOnCartInput + An input object that applies one or more shipping methods to the cart.
+
+
+
+

Example

+
+
Query
+ 
mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) {
+  setShippingMethodsOnCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": SetShippingMethodsOnCartInput}
+
+
+
+
Response
+ 
{"data": {"setShippingMethodsOnCart": {"cart": Cart}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ shareGiftRegistry +

+
+
+
+
Description
+

Send an email about the gift registry to a list of invitees.

+
+
+
+
+
+
+
Response
+

Returns a ShareGiftRegistryOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
+ giftRegistryUid - ID! + The unique ID of the gift registry.
+ sender - ShareGiftRegistrySenderInput! + The sender's email address and gift message.
+ invitees - [ShareGiftRegistryInviteeInput!]! + An array containing invitee names and email addresses.
+
+
+
+

Example

+
+
Query
+ 
mutation shareGiftRegistry(
+  $giftRegistryUid: ID!,
+  $sender: ShareGiftRegistrySenderInput!,
+  $invitees: [ShareGiftRegistryInviteeInput!]!
+) {
+  shareGiftRegistry(
+    giftRegistryUid: $giftRegistryUid,
+    sender: $sender,
+    invitees: $invitees
+  ) {
+    is_shared
+  }
+}
+
+
+
+
Variables
+ 
{
+  "giftRegistryUid": "4",
+  "sender": ShareGiftRegistrySenderInput,
+  "invitees": [ShareGiftRegistryInviteeInput]
+}
+
+
+
+
Response
+ 
{"data": {"shareGiftRegistry": {"is_shared": true}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ submitNegotiableQuoteTemplateForReview +

+
+
+
+
Description
+

Accept an existing negotiable quote template.

+
+
+
+
+
+
+
Response
+

Returns a NegotiableQuoteTemplate +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - SubmitNegotiableQuoteTemplateForReviewInput! + An input object that contains the data to update a negotiable quote template.
+
+
+
+

Example

+
+
Query
+ 
mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTemplateForReviewInput!) {
+  submitNegotiableQuoteTemplateForReview(input: $input) {
+    buyer {
+      ...NegotiableQuoteUserFragment
+    }
+    comments {
+      ...NegotiableQuoteCommentFragment
+    }
+    expiration_date
+    history {
+      ...NegotiableQuoteHistoryEntryFragment
+    }
+    is_min_max_qty_used
+    is_virtual
+    items {
+      ...CartItemInterfaceFragment
+    }
+    max_order_commitment
+    min_order_commitment
+    name
+    notifications {
+      ...QuoteTemplateNotificationMessageFragment
+    }
+    prices {
+      ...CartPricesFragment
+    }
+    reference_document_links {
+      ...NegotiableQuoteReferenceDocumentLinkFragment
+    }
+    shipping_addresses {
+      ...NegotiableQuoteShippingAddressFragment
+    }
+    status
+    template_id
+    total_quantity
+  }
+}
+
+
+
+
Variables
+ 
{"input": SubmitNegotiableQuoteTemplateForReviewInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "submitNegotiableQuoteTemplateForReview": {
+      "buyer": NegotiableQuoteUser,
+      "comments": [NegotiableQuoteComment],
+      "expiration_date": "abc123",
+      "history": [NegotiableQuoteHistoryEntry],
+      "is_min_max_qty_used": false,
+      "is_virtual": false,
+      "items": [CartItemInterface],
+      "max_order_commitment": 123,
+      "min_order_commitment": 987,
+      "name": "xyz789",
+      "notifications": [QuoteTemplateNotificationMessage],
+      "prices": CartPrices,
+      "reference_document_links": [
+        NegotiableQuoteReferenceDocumentLink
+      ],
+      "shipping_addresses": [
+        NegotiableQuoteShippingAddress
+      ],
+      "status": "abc123",
+      "template_id": "4",
+      "total_quantity": 123.45
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ subscribeEmailToNewsletter +

+
+
+
+
Description
+

Subscribe the specified email to the store's newsletter.

+
+
+
+
+
+
+
Response
+

Returns a SubscribeEmailToNewsletterOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ email - String! + The email address that will receive the store's newsletter.
+
+
+
+

Example

+
+
Query
+ 
mutation subscribeEmailToNewsletter($email: String!) {
+  subscribeEmailToNewsletter(email: $email) {
+    status
+  }
+}
+
+
+
+
Variables
+ 
{"email": "abc123"}
+
+
+
+
Response
+ 
{"data": {"subscribeEmailToNewsletter": {"status": "NOT_ACTIVE"}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ syncPaymentOrder +

+
+
+
+
Description
+

Synchronizes the payment order details for further payment processing

+
+
+
+
+
+
+
Response
+

Returns a Boolean +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - SyncPaymentOrderInput + Describes the variables needed to synchronize the payment order details
+
+
+
+

Example

+
+
Query
+ 
mutation syncPaymentOrder($input: SyncPaymentOrderInput) {
+  syncPaymentOrder(input: $input)
+}
+
+
+
+
Variables
+ 
{"input": SyncPaymentOrderInput}
+
+
+
+
Response
+ 
{"data": {"syncPaymentOrder": false}}
+
+
+
+
+
+
+
+ Mutations +
+

+ updateCartItems +

+
+
+
+
Description
+

Modify items in the cart.

+
+
+
+
+
+
+
Response
+

Returns an UpdateCartItemsOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - UpdateCartItemsInput + An input object that defines products to be updated.
+
+
+
+

Example

+
+
Query
+ 
mutation updateCartItems($input: UpdateCartItemsInput) {
+  updateCartItems(input: $input) {
+    cart {
+      ...CartFragment
+    }
+    errors {
+      ...CartUserInputErrorFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": UpdateCartItemsInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "updateCartItems": {
+      "cart": Cart,
+      "errors": [CartUserInputError]
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ updateCompany +

+
+
+
+
Description
+

Update company information.

+
+
+
+
+
+
+
Response
+

Returns an UpdateCompanyOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CompanyUpdateInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation updateCompany($input: CompanyUpdateInput!) {
+  updateCompany(input: $input) {
+    company {
+      ...CompanyFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": CompanyUpdateInput}
+
+
+
+
Response
+ 
{"data": {"updateCompany": {"company": Company}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ updateCompanyRole +

+
+
+
+
Description
+

Update company role information.

+
+
+
+
+
+
+
Response
+

Returns an UpdateCompanyRoleOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CompanyRoleUpdateInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation updateCompanyRole($input: CompanyRoleUpdateInput!) {
+  updateCompanyRole(input: $input) {
+    role {
+      ...CompanyRoleFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": CompanyRoleUpdateInput}
+
+
+
+
Response
+ 
{"data": {"updateCompanyRole": {"role": CompanyRole}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ updateCompanyStructure +

+
+
+
+
Description
+

Change the parent node of a company team within the current company context.

+
+
+
+
+
+
+
Response
+

Returns an UpdateCompanyStructureOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CompanyStructureUpdateInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation updateCompanyStructure($input: CompanyStructureUpdateInput!) {
+  updateCompanyStructure(input: $input) {
+    company {
+      ...CompanyFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": CompanyStructureUpdateInput}
+
+
+
+
Response
+ 
{"data": {"updateCompanyStructure": {"company": Company}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ updateCompanyTeam +

+
+
+
+
Description
+

Update company team data.

+
+
+
+
+
+
+
Response
+

Returns an UpdateCompanyTeamOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CompanyTeamUpdateInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation updateCompanyTeam($input: CompanyTeamUpdateInput!) {
+  updateCompanyTeam(input: $input) {
+    team {
+      ...CompanyTeamFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": CompanyTeamUpdateInput}
+
+
+
+
Response
+ 
{"data": {"updateCompanyTeam": {"team": CompanyTeam}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ updateCompanyUser +

+
+
+
+
Description
+

Update an existing company user.

+
+
+
+
+
+
+
Response
+

Returns an UpdateCompanyUserOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CompanyUserUpdateInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation updateCompanyUser($input: CompanyUserUpdateInput!) {
+  updateCompanyUser(input: $input) {
+    user {
+      ...CustomerFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": CompanyUserUpdateInput}
+
+
+
+
Response
+ 
{"data": {"updateCompanyUser": {"user": Customer}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ updateCustomer +

+
+
+
+
Use updateCustomerV2 instead.
+
+
+
+
+
+
+
Response
+

Returns a CustomerOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CustomerInput! + An input object that defines the customer characteristics to update.
+
+
+
+

Example

+
+
Query
+ 
mutation updateCustomer($input: CustomerInput!) {
+  updateCustomer(input: $input) {
+    customer {
+      ...CustomerFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": CustomerInput}
+
+
+
+
Response
+ 
{"data": {"updateCustomer": {"customer": Customer}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ updateCustomerAddress +

+
+
+
+
Use updateCustomerAddressV2 instead.
+
+
+
+
+
+
+
Description
+

Update the billing or shipping address of a customer or guest.

+
+
+
+
+
+
+
Response
+

Returns a CustomerAddress +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ id - Int! + The ID assigned to the customer address.
+ input - CustomerAddressInput + An input object that contains changes to the customer address.
+
+
+
+

Example

+
+
Query
+ 
mutation updateCustomerAddress(
+  $id: Int!,
+  $input: CustomerAddressInput
+) {
+  updateCustomerAddress(
+    id: $id,
+    input: $input
+  ) {
+    city
+    company
+    country_code
+    country_id
+    custom_attributes {
+      ...CustomerAddressAttributeFragment
+    }
+    custom_attributesV2 {
+      ...AttributeValueInterfaceFragment
+    }
+    customer_id
+    default_billing
+    default_shipping
+    extension_attributes {
+      ...CustomerAddressAttributeFragment
+    }
+    fax
+    firstname
+    id
+    lastname
+    middlename
+    postcode
+    prefix
+    region {
+      ...CustomerAddressRegionFragment
+    }
+    region_id
+    street
+    suffix
+    telephone
+    uid
+    vat_id
+  }
+}
+
+
+
+
Variables
+ 
{"id": 123, "input": CustomerAddressInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "updateCustomerAddress": {
+      "city": "abc123",
+      "company": "xyz789",
+      "country_code": "AF",
+      "country_id": "xyz789",
+      "custom_attributes": [CustomerAddressAttribute],
+      "custom_attributesV2": [AttributeValueInterface],
+      "customer_id": 123,
+      "default_billing": false,
+      "default_shipping": false,
+      "extension_attributes": [CustomerAddressAttribute],
+      "fax": "abc123",
+      "firstname": "abc123",
+      "id": 123,
+      "lastname": "abc123",
+      "middlename": "xyz789",
+      "postcode": "abc123",
+      "prefix": "abc123",
+      "region": CustomerAddressRegion,
+      "region_id": 987,
+      "street": ["abc123"],
+      "suffix": "xyz789",
+      "telephone": "xyz789",
+      "uid": "4",
+      "vat_id": "abc123"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ updateCustomerAddressV2 +

+
+
+
+
Description
+

Update the billing or shipping address of a customer or guest.

+
+
+
+
+
+
+
Response
+

Returns a CustomerAddress +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ uid - ID! + The unique ID of the customer address.
+ input - CustomerAddressInput + An input object that contains changes to the customer address.
+
+
+
+

Example

+
+
Query
+ 
mutation updateCustomerAddressV2(
+  $uid: ID!,
+  $input: CustomerAddressInput
+) {
+  updateCustomerAddressV2(
+    uid: $uid,
+    input: $input
+  ) {
+    city
+    company
+    country_code
+    country_id
+    custom_attributes {
+      ...CustomerAddressAttributeFragment
+    }
+    custom_attributesV2 {
+      ...AttributeValueInterfaceFragment
+    }
+    customer_id
+    default_billing
+    default_shipping
+    extension_attributes {
+      ...CustomerAddressAttributeFragment
+    }
+    fax
+    firstname
+    id
+    lastname
+    middlename
+    postcode
+    prefix
+    region {
+      ...CustomerAddressRegionFragment
+    }
+    region_id
+    street
+    suffix
+    telephone
+    uid
+    vat_id
+  }
+}
+
+
+
+
Variables
+ 
{
+  "uid": "4",
+  "input": CustomerAddressInput
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "updateCustomerAddressV2": {
+      "city": "abc123",
+      "company": "abc123",
+      "country_code": "AF",
+      "country_id": "abc123",
+      "custom_attributes": [CustomerAddressAttribute],
+      "custom_attributesV2": [AttributeValueInterface],
+      "customer_id": 123,
+      "default_billing": false,
+      "default_shipping": false,
+      "extension_attributes": [CustomerAddressAttribute],
+      "fax": "abc123",
+      "firstname": "xyz789",
+      "id": 987,
+      "lastname": "abc123",
+      "middlename": "abc123",
+      "postcode": "abc123",
+      "prefix": "xyz789",
+      "region": CustomerAddressRegion,
+      "region_id": 123,
+      "street": ["xyz789"],
+      "suffix": "xyz789",
+      "telephone": "xyz789",
+      "uid": 4,
+      "vat_id": "abc123"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ updateCustomerEmail +

+
+
+
+
Description
+

Change the email address for the logged-in customer.

+
+
+
+
+
+
+
Response
+

Returns a CustomerOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ email - String! + The customer's email address.
+ password - String! + The customer's password.
+
+
+
+

Example

+
+
Query
+ 
mutation updateCustomerEmail(
+  $email: String!,
+  $password: String!
+) {
+  updateCustomerEmail(
+    email: $email,
+    password: $password
+  ) {
+    customer {
+      ...CustomerFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{
+  "email": "abc123",
+  "password": "xyz789"
+}
+
+
+
+
Response
+ 
{"data": {"updateCustomerEmail": {"customer": Customer}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ updateCustomerV2 +

+
+
+
+
Description
+

Update the customer's personal information.

+
+
+
+
+
+
+
Response
+

Returns a CustomerOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - CustomerUpdateInput! + An input object that defines the customer characteristics to update.
+
+
+
+

Example

+
+
Query
+ 
mutation updateCustomerV2($input: CustomerUpdateInput!) {
+  updateCustomerV2(input: $input) {
+    customer {
+      ...CustomerFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": CustomerUpdateInput}
+
+
+
+
Response
+ 
{"data": {"updateCustomerV2": {"customer": Customer}}}
+
+
+
+
+
+
+
+ Mutations +
+

+ updateGiftRegistry +

+
+
+
+
Description
+

Update the specified gift registry.

+
+
+
+
+
+
+
Response
+

Returns an UpdateGiftRegistryOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ giftRegistryUid - ID! + The unique ID of an existing gift registry.
+ giftRegistry - UpdateGiftRegistryInput! + An input object that defines which fields to update.
+
+
+
+

Example

+
+
Query
+ 
mutation updateGiftRegistry(
+  $giftRegistryUid: ID!,
+  $giftRegistry: UpdateGiftRegistryInput!
+) {
+  updateGiftRegistry(
+    giftRegistryUid: $giftRegistryUid,
+    giftRegistry: $giftRegistry
+  ) {
+    gift_registry {
+      ...GiftRegistryFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{
+  "giftRegistryUid": "4",
+  "giftRegistry": UpdateGiftRegistryInput
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "updateGiftRegistry": {"gift_registry": GiftRegistry}
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ updateGiftRegistryItems +

+
+
+
+
Description
+

Update the specified items in the gift registry.

+
+
+
+
+
+
+
Response
+

Returns an UpdateGiftRegistryItemsOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ giftRegistryUid - ID! + The unique ID of the gift registry.
+ items - [UpdateGiftRegistryItemInput!]! + An array of items to be updated.
+
+
+
+

Example

+
+
Query
+ 
mutation updateGiftRegistryItems(
+  $giftRegistryUid: ID!,
+  $items: [UpdateGiftRegistryItemInput!]!
+) {
+  updateGiftRegistryItems(
+    giftRegistryUid: $giftRegistryUid,
+    items: $items
+  ) {
+    gift_registry {
+      ...GiftRegistryFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{
+  "giftRegistryUid": "4",
+  "items": [UpdateGiftRegistryItemInput]
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "updateGiftRegistryItems": {
+      "gift_registry": GiftRegistry
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ updateGiftRegistryRegistrants +

+
+
+
+
Description
+

Modify the properties of one or more gift registry registrants.

+
+
+
+
+
+
+
Response
+

Returns an UpdateGiftRegistryRegistrantsOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ giftRegistryUid - ID! + The unique ID of the gift registry.
+ registrants - [UpdateGiftRegistryRegistrantInput!]! + An array of registrants to update.
+
+
+
+

Example

+
+
Query
+ 
mutation updateGiftRegistryRegistrants(
+  $giftRegistryUid: ID!,
+  $registrants: [UpdateGiftRegistryRegistrantInput!]!
+) {
+  updateGiftRegistryRegistrants(
+    giftRegistryUid: $giftRegistryUid,
+    registrants: $registrants
+  ) {
+    gift_registry {
+      ...GiftRegistryFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{
+  "giftRegistryUid": "4",
+  "registrants": [UpdateGiftRegistryRegistrantInput]
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "updateGiftRegistryRegistrants": {
+      "gift_registry": GiftRegistry
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ updateNegotiableQuoteQuantities +

+
+
+
+
Description
+

Change the quantity of one or more items in an existing negotiable quote.

+
+
+
+
+
+
+
Response
+

Returns an UpdateNegotiableQuoteItemsQuantityOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - UpdateNegotiableQuoteQuantitiesInput! + An input object that changes the quantity of one or more items in a negotiable quote.
+
+
+
+

Example

+
+
Query
+ 
mutation updateNegotiableQuoteQuantities($input: UpdateNegotiableQuoteQuantitiesInput!) {
+  updateNegotiableQuoteQuantities(input: $input) {
+    quote {
+      ...NegotiableQuoteFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": UpdateNegotiableQuoteQuantitiesInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "updateNegotiableQuoteQuantities": {
+      "quote": NegotiableQuote
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ updateNegotiableQuoteTemplateQuantities +

+
+
+
+
Description
+

Change the quantity of one or more items in an existing negotiable quote template.

+
+
+
+
+
+
+
Response
+

Returns an UpdateNegotiableQuoteTemplateItemsQuantityOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - UpdateNegotiableQuoteTemplateQuantitiesInput! + An input object that changes the quantity of one or more items in a negotiable quote template.
+
+
+
+

Example

+
+
Query
+ 
mutation updateNegotiableQuoteTemplateQuantities($input: UpdateNegotiableQuoteTemplateQuantitiesInput!) {
+  updateNegotiableQuoteTemplateQuantities(input: $input) {
+    quote_template {
+      ...NegotiableQuoteTemplateFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": UpdateNegotiableQuoteTemplateQuantitiesInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "updateNegotiableQuoteTemplateQuantities": {
+      "quote_template": NegotiableQuoteTemplate
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ updateProductsInWishlist +

+
+
+
+
Description
+

Update one or more products in the specified wish list.

+
+
+
+
+
+
+
Response
+

Returns an UpdateProductsInWishlistOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ wishlistId - ID! + The ID of a wish list.
+ wishlistItems - [WishlistItemUpdateInput!]! + An array of items to be updated.
+
+
+
+

Example

+
+
Query
+ 
mutation updateProductsInWishlist(
+  $wishlistId: ID!,
+  $wishlistItems: [WishlistItemUpdateInput!]!
+) {
+  updateProductsInWishlist(
+    wishlistId: $wishlistId,
+    wishlistItems: $wishlistItems
+  ) {
+    user_errors {
+      ...WishListUserInputErrorFragment
+    }
+    wishlist {
+      ...WishlistFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{
+  "wishlistId": "4",
+  "wishlistItems": [WishlistItemUpdateInput]
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "updateProductsInWishlist": {
+      "user_errors": [WishListUserInputError],
+      "wishlist": Wishlist
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ updatePurchaseOrderApprovalRule +

+
+
+
+
Description
+

Update existing purchase order approval rules.

+
+
+
+
+
+
+
Response
+

Returns a PurchaseOrderApprovalRule +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - UpdatePurchaseOrderApprovalRuleInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRuleInput!) {
+  updatePurchaseOrderApprovalRule(input: $input) {
+    applies_to_roles {
+      ...CompanyRoleFragment
+    }
+    approver_roles {
+      ...CompanyRoleFragment
+    }
+    condition {
+      ...PurchaseOrderApprovalRuleConditionInterfaceFragment
+    }
+    created_at
+    created_by
+    description
+    name
+    status
+    uid
+    updated_at
+  }
+}
+
+
+
+
Variables
+ 
{"input": UpdatePurchaseOrderApprovalRuleInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "updatePurchaseOrderApprovalRule": {
+      "applies_to_roles": [CompanyRole],
+      "approver_roles": [CompanyRole],
+      "condition": PurchaseOrderApprovalRuleConditionInterface,
+      "created_at": "abc123",
+      "created_by": "abc123",
+      "description": "abc123",
+      "name": "xyz789",
+      "status": "ENABLED",
+      "uid": 4,
+      "updated_at": "abc123"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ updateRequisitionList +

+
+
+
+
Description
+

Rename a requisition list and change its description.

+
+
+
+
+
+
+
Response
+

Returns an UpdateRequisitionListOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ requisitionListUid - ID! + The unique ID of the requisition list.
+ input - UpdateRequisitionListInput + +
+
+
+
+

Example

+
+
Query
+ 
mutation updateRequisitionList(
+  $requisitionListUid: ID!,
+  $input: UpdateRequisitionListInput
+) {
+  updateRequisitionList(
+    requisitionListUid: $requisitionListUid,
+    input: $input
+  ) {
+    requisition_list {
+      ...RequisitionListFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{
+  "requisitionListUid": 4,
+  "input": UpdateRequisitionListInput
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "updateRequisitionList": {
+      "requisition_list": RequisitionList
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ updateRequisitionListItems +

+
+
+
+
Description
+

Update items in a requisition list.

+
+
+
+
+
+
+
Response
+

Returns an UpdateRequisitionListItemsOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + +
NameDescription
+ requisitionListUid - ID! + The unique ID of the requisition list.
+ requisitionListItems - [UpdateRequisitionListItemsInput!]! + Items to be updated in the requisition list.
+
+
+
+

Example

+
+
Query
+ 
mutation updateRequisitionListItems(
+  $requisitionListUid: ID!,
+  $requisitionListItems: [UpdateRequisitionListItemsInput!]!
+) {
+  updateRequisitionListItems(
+    requisitionListUid: $requisitionListUid,
+    requisitionListItems: $requisitionListItems
+  ) {
+    requisition_list {
+      ...RequisitionListFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{
+  "requisitionListUid": "4",
+  "requisitionListItems": [
+    UpdateRequisitionListItemsInput
+  ]
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "updateRequisitionListItems": {
+      "requisition_list": RequisitionList
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ updateWishlist +

+
+
+
+
Description
+

Change the name and visibility of the specified wish list.

+
+
+
+
+
+
+
Response
+

Returns an UpdateWishlistOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + + + + + + + + + +
NameDescription
+ wishlistId - ID! + The ID of the wish list to update.
+ name - String + The name assigned to the wish list.
+ visibility - WishlistVisibilityEnum + Indicates the visibility of the wish list.
+
+
+
+

Example

+
+
Query
+ 
mutation updateWishlist(
+  $wishlistId: ID!,
+  $name: String,
+  $visibility: WishlistVisibilityEnum
+) {
+  updateWishlist(
+    wishlistId: $wishlistId,
+    name: $name,
+    visibility: $visibility
+  ) {
+    name
+    uid
+    visibility
+  }
+}
+
+
+
+
Variables
+ 
{
+  "wishlistId": "4",
+  "name": "abc123",
+  "visibility": "PUBLIC"
+}
+
+
+
+
Response
+ 
{
+  "data": {
+    "updateWishlist": {
+      "name": "abc123",
+      "uid": "4",
+      "visibility": "PUBLIC"
+    }
+  }
+}
+
+
+
+
+
+
+
+ Mutations +
+

+ validatePurchaseOrders +

+
+
+
+
Description
+

Validate purchase orders.

+
+
+
+
+
+
+
Response
+

Returns a ValidatePurchaseOrdersOutput +

+
+
+
Arguments
+ + + + + + + + + + + + + +
NameDescription
+ input - ValidatePurchaseOrdersInput! + +
+
+
+
+

Example

+
+
Query
+ 
mutation validatePurchaseOrders($input: ValidatePurchaseOrdersInput!) {
+  validatePurchaseOrders(input: $input) {
+    errors {
+      ...ValidatePurchaseOrderErrorFragment
+    }
+    purchase_orders {
+      ...PurchaseOrderFragment
+    }
+  }
+}
+
+
+
+
Variables
+ 
{"input": ValidatePurchaseOrdersInput}
+
+
+
+
Response
+ 
{
+  "data": {
+    "validatePurchaseOrders": {
+      "errors": [ValidatePurchaseOrderError],
+      "purchase_orders": [PurchaseOrder]
+    }
+  }
+}
+
+
+
+
+
+

Types

+
+

AcceptNegotiableQuoteTemplateInput

+
+
+
+
Description
+

Specifies the quote template id to accept quote template.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ template_id - ID! + The unique ID of a NegotiableQuoteTemplate object.
+
+
+
+
+
Example
+ 
{"template_id": "4"}
+
+
+
+
+
+
+
+ Types +
+

AddBundleProductsToCartInput

+
+
+
+
Description
+

Defines the bundle products to add to the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The ID of the cart.
+ cart_items - [BundleProductCartItemInput]! + An array of bundle products to add.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "xyz789",
+  "cart_items": [BundleProductCartItemInput]
+}
+
+
+
+
+
+
+
+ Types +
+

AddBundleProductsToCartOutput

+
+
+
+
Description
+

Contains details about the cart after adding bundle products.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The cart after adding products.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

AddConfigurableProductsToCartInput

+
+
+
+
Description
+

Defines the configurable products to add to the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The ID of the cart.
+ cart_items - [ConfigurableProductCartItemInput]! + An array of configurable products to add.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "abc123",
+  "cart_items": [ConfigurableProductCartItemInput]
+}
+
+
+
+
+
+
+
+ Types +
+

AddConfigurableProductsToCartOutput

+
+
+
+
Description
+

Contains details about the cart after adding configurable products.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The cart after adding products.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

AddDownloadableProductsToCartInput

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The ID of the cart.
+ cart_items - [DownloadableProductCartItemInput]! + An array of downloadable products to add.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "abc123",
+  "cart_items": [DownloadableProductCartItemInput]
+}
+
+
+
+
+
+
+
+ Types +
+

AddDownloadableProductsToCartOutput

+
+
+
+
Description
+

Contains details about the cart after adding downloadable products.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The cart after adding products.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

AddGiftRegistryRegistrantInput

+
+
+
+
Description
+

Defines a new registrant.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ dynamic_attributes - [GiftRegistryDynamicAttributeInput] + Additional attributes specified as a code-value pair.
+ email - String! + The email address of the registrant.
+ firstname - String! + The first name of the registrant.
+ lastname - String! + The last name of the registrant.
+
+
+
+
+
Example
+ 
{
+  "dynamic_attributes": [
+    GiftRegistryDynamicAttributeInput
+  ],
+  "email": "xyz789",
+  "firstname": "abc123",
+  "lastname": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

AddGiftRegistryRegistrantsOutput

+
+
+
+
Description
+

Contains the results of a request to add registrants.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
gift_registry - GiftRegistry + The gift registry after adding registrants.
+
+
+
+
+
Example
+ 
{"gift_registry": GiftRegistry}
+
+
+
+
+
+
+
+ Types +
+

AddProductsToCartOutput

+
+
+
+
Description
+

Contains details about the cart after adding products to it.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The cart after products have been added.
user_errors - [Error]! + Contains errors encountered while adding an item to the cart.
+
+
+
+
+
Example
+ 
{
+  "cart": Cart,
+  "user_errors": [Error]
+}
+
+
+
+
+
+
+
+ Types +
+

AddProductsToCompareListInput

+
+
+
+
Description
+

Contains products to add to an existing compare list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ products - [ID]! + An array of product IDs to add to the compare list.
+ uid - ID! + The unique identifier of the compare list to modify.
+
+
+
+
+
Example
+ 
{
+  "products": ["4"],
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

AddProductsToNewCartOutput

+
+
+
+
Description
+

Contains details about the cart after adding products to it.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
cart - Cart + The cart after products have been added.
user_errors - [CartUserInputError] + Contains errors encountered while adding an item to the cart.
+
+
+
+
+
Example
+ 
{
+  "cart": Cart,
+  "user_errors": [CartUserInputError]
+}
+
+
+
+
+
+
+
+ Types +
+

AddProductsToRequisitionListOutput

+
+
+
+
Description
+

Output of the request to add products to a requisition list.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
requisition_list - RequisitionList + The requisition list after adding products.
+
+
+
+
+
Example
+ 
{"requisition_list": RequisitionList}
+
+
+
+
+
+
+
+ Types +
+

AddProductsToWishlistOutput

+
+
+
+
Description
+

Contains the customer's wish list and any errors encountered.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
user_errors - [WishListUserInputError]! + An array of errors encountered while adding products to a wish list.
wishlist - Wishlist! + Contains the wish list with all items that were successfully added.
+
+
+
+
+
Example
+ 
{
+  "user_errors": [WishListUserInputError],
+  "wishlist": Wishlist
+}
+
+
+
+
+
+
+
+ Types +
+

AddPurchaseOrderCommentInput

+
+
+
+
Description
+

Contains the comment to be added to a purchase order.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ comment - String! + Comment text.
+ purchase_order_uid - ID! + The unique ID of a purchase order.
+
+
+
+
+
Example
+ 
{
+  "comment": "xyz789",
+  "purchase_order_uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

AddPurchaseOrderCommentOutput

+
+
+
+
Description
+

Contains the successfully added comment.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
comment - PurchaseOrderComment! + The purchase order comment.
+
+
+
+
+
Example
+ 
{"comment": PurchaseOrderComment}
+
+
+
+
+
+
+
+ Types +
+

AddPurchaseOrderItemsToCartInput

+
+
+
+
Description
+

Defines the purchase order and cart to act on.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The ID to assign to the cart.
+ purchase_order_uid - ID! + Purchase order unique ID.
+ replace_existing_cart_items - Boolean! + Replace existing cart or merge items.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "xyz789",
+  "purchase_order_uid": "4",
+  "replace_existing_cart_items": false
+}
+
+
+
+
+
+
+
+ Types +
+

AddRequisitionListItemToCartUserError

+
+
+
+
Description
+

Contains details about why an attempt to add items to the requistion list failed.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
message - String! + A description of the error.
type - AddRequisitionListItemToCartUserErrorType! + The type of error that occurred.
+
+
+
+
+
Example
+ 
{
+  "message": "abc123",
+  "type": "OUT_OF_STOCK"
+}
+
+
+
+
+
+
+
+ Types +
+

AddRequisitionListItemToCartUserErrorType

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

OUT_OF_STOCK

+ 		+
+

UNAVAILABLE_SKU

+ 		+
+

OPTIONS_UPDATED

+ 		+
+

LOW_QUANTITY

+ 		+
+
+
+
+
+
Example
+ 
"OUT_OF_STOCK"
+
+
+
+
+
+
+
+ Types +
+

AddRequisitionListItemsToCartOutput

+
+
+
+
Description
+

Output of the request to add items in a requisition list to the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
add_requisition_list_items_to_cart_user_errors - [AddRequisitionListItemToCartUserError]! + Details about why the attempt to add items to the requistion list was not successful.
cart - Cart + The cart after adding requisition list items.
status - Boolean! + Indicates whether the attempt to add items to the requisition list was successful.
+
+
+
+
+
Example
+ 
{
+  "add_requisition_list_items_to_cart_user_errors": [
+    AddRequisitionListItemToCartUserError
+  ],
+  "cart": Cart,
+  "status": false
+}
+
+
+
+
+
+
+
+ Types +
+

AddReturnCommentInput

+
+
+
+
Description
+

Defines a return comment.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ comment_text - String! + The text added to the return request.
+ return_uid - ID! + The unique ID for a Return object.
+
+
+
+
+
Example
+ 
{
+  "comment_text": "abc123",
+  "return_uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

AddReturnCommentOutput

+
+
+
+
Description
+

Contains details about the return request.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
return - Return + The modified return.
+
+
+
+
+
Example
+ 
{"return": Return}
+
+
+
+
+
+
+
+ Types +
+

AddReturnTrackingInput

+
+
+
+
Description
+

Defines tracking information to be added to the return.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ carrier_uid - ID! + The unique ID for a ReturnShippingCarrier object.
+ return_uid - ID! + The unique ID for a Returns object.
+ tracking_number - String! + The shipping tracking number for this return request.
+
+
+
+
+
Example
+ 
{
+  "carrier_uid": 4,
+  "return_uid": "4",
+  "tracking_number": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

AddReturnTrackingOutput

+
+
+
+
Description
+

Contains the response after adding tracking information.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
return - Return + Details about the modified return.
return_shipping_tracking - ReturnShippingTracking + Details about shipping for a return.
+
+
+
+
+
Example
+ 
{
+  "return": Return,
+  "return_shipping_tracking": ReturnShippingTracking
+}
+
+
+
+
+
+
+
+ Types +
+

AddSimpleProductsToCartInput

+
+
+
+
Description
+

Defines the simple and group products to add to the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID of a Cart object.
+ cart_items - [SimpleProductCartItemInput]! + An array of simple and group items to add.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "xyz789",
+  "cart_items": [SimpleProductCartItemInput]
+}
+
+
+
+
+
+
+
+ Types +
+

AddSimpleProductsToCartOutput

+
+
+
+
Description
+

Contains details about the cart after adding simple or group products.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The cart after adding products.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

AddVirtualProductsToCartInput

+
+
+
+
Description
+

Defines the virtual products to add to the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID of a Cart object.
+ cart_items - [VirtualProductCartItemInput]! + An array of virtual products to add.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "abc123",
+  "cart_items": [VirtualProductCartItemInput]
+}
+
+
+
+
+
+
+
+ Types +
+

AddVirtualProductsToCartOutput

+
+
+
+
Description
+

Contains details about the cart after adding virtual products.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The cart after adding products.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

AddWishlistItemsToCartOutput

+
+
+
+
Description
+

Contains the resultant wish list and any error information.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
add_wishlist_items_to_cart_user_errors - [WishlistCartUserInputError]! + An array of errors encountered while adding products to the customer's cart.
status - Boolean! + Indicates whether the attempt to add items to the customer's cart was successful.
wishlist - Wishlist! + Contains the wish list with all items that were successfully added.
+
+
+
+
+
Example
+ 
{
+  "add_wishlist_items_to_cart_user_errors": [
+    WishlistCartUserInputError
+  ],
+  "status": true,
+  "wishlist": Wishlist
+}
+
+
+
+
+
+
+
+ Types +
+

Aggregation

+
+
+
+
Description
+

Contains information for each filterable option (such as price, category UID, and custom attributes).

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
attribute_code - String! + Attribute code of the aggregation group.
count - Int + The number of options in the aggregation group.
label - String + The aggregation display name.
options - [AggregationOption] + Array of options for the aggregation.
position - Int + The relative position of the attribute in a layered navigation block.
+
+
+
+
+
Example
+ 
{
+  "attribute_code": "xyz789",
+  "count": 123,
+  "label": "abc123",
+  "options": [AggregationOption],
+  "position": 987
+}
+
+
+
+
+
+
+
+ Types +
+

AggregationOption

+
+
+
+
Description
+

An implementation of AggregationOptionInterface.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
count - Int + The number of items that match the aggregation option.
label - String + The display label for an aggregation option.
value - String! + The internal ID that represents the value of the option.
+
+
+
+
+
Example
+ 
{
+  "count": 123,
+  "label": "xyz789",
+  "value": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

AggregationOptionInterface

+
+
+
+
Description
+

Defines aggregation option fields.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
count - Int + The number of items that match the aggregation option.
label - String + The display label for an aggregation option.
value - String! + The internal ID that represents the value of the option.
+
+
+
Possible Types
+ + + + + + + + + + + +
AggregationOptionInterface Types
+

AggregationOption

+
+
+
+
+
+
Example
+ 
{
+  "count": 987,
+  "label": "xyz789",
+  "value": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

AggregationsCategoryFilterInput

+
+
+
+
Description
+

Filter category aggregations in layered navigation.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ includeDirectChildrenOnly - Boolean + Indicates whether to include only direct subcategories or all children categories at all levels.
+
+
+
+
+
Example
+ 
{"includeDirectChildrenOnly": true}
+
+
+
+
+
+
+
+ Types +
+

AggregationsFilterInput

+
+
+
+
Description
+

An input object that specifies the filters used in product aggregations.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ category - AggregationsCategoryFilterInput + Filter category aggregations in layered navigation.
+
+
+
+
+
Example
+ 
{"category": AggregationsCategoryFilterInput}
+
+
+
+
+
+
+
+ Types +
+

ApplePayConfig

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
button_styles - ButtonStyles + The styles for the ApplePay Smart Button configuration
code - String + The payment method code as defined in the payment gateway
is_visible - Boolean + Indicates whether the payment method is displayed
payment_intent - String + Defines the payment intent (Authorize or Capture
payment_source - String + The payment source for the payment method
sdk_params - [SDKParams] + The PayPal parameters required to load the JS SDK
sort_order - String + The relative order the payment method is displayed on the checkout page
title - String + The name displayed for the payment method
+
+
+
+
+
Example
+ 
{
+  "button_styles": ButtonStyles,
+  "code": "xyz789",
+  "is_visible": false,
+  "payment_intent": "xyz789",
+  "payment_source": "abc123",
+  "sdk_params": [SDKParams],
+  "sort_order": "xyz789",
+  "title": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

ApplePayMethodInput

+
+
+
+
Description
+

Apple Pay inputs

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ payment_source - String + The payment source for the payment method
+ payments_order_id - String + The payment services order ID
+ paypal_order_id - String + PayPal order ID
+
+
+
+
+
Example
+ 
{
+  "payment_source": "xyz789",
+  "payments_order_id": "abc123",
+  "paypal_order_id": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

AppliedCoupon

+
+
+
+
Description
+

Contains the applied coupon code.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
code - String! + The coupon code the shopper applied to the card.
+
+
+
+
+
Example
+ 
{"code": "abc123"}
+
+
+
+
+
+
+
+ Types +
+

AppliedGiftCard

+
+
+
+
Description
+

Contains an applied gift card with applied and remaining balance.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
applied_balance - Money + The amount applied to the current cart.
code - String + The gift card account code.
current_balance - Money + The remaining balance on the gift card.
expiration_date - String + The expiration date of the gift card.
+
+
+
+
+
Example
+ 
{
+  "applied_balance": Money,
+  "code": "xyz789",
+  "current_balance": Money,
+  "expiration_date": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

AppliedStoreCredit

+
+
+
+
Description
+

Contains the applied and current balances.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
applied_balance - Money + The applied store credit balance to the current cart.
current_balance - Money + The current balance remaining on store credit.
enabled - Boolean + Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned.
+
+
+
+
+
Example
+ 
{
+  "applied_balance": Money,
+  "current_balance": Money,
+  "enabled": true
+}
+
+
+
+
+
+
+
+ Types +
+

ApplyCouponToCartInput

+
+
+
+
Description
+

Specifies the coupon code to apply to the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID of a Cart object.
+ coupon_code - String! + A valid coupon code.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "abc123",
+  "coupon_code": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

ApplyCouponToCartOutput

+
+
+
+
Description
+

Contains details about the cart after applying a coupon.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The cart after applying a coupon.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

ApplyCouponsStrategy

+
+
+
+
Description
+

The strategy to apply coupons to the cart.

+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

APPEND

+ 		Append new coupons keeping the coupons that have been applied before.
+

REPLACE

+ 		Remove all the coupons from the cart and apply only new provided coupons.
+
+
+
+
+
Example
+ 
"APPEND"
+
+
+
+
+
+
+
+ Types +
+

ApplyCouponsToCartInput

+
+
+
+
Description
+

Apply coupons to the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID of a Cart object.
+ coupon_codes - [String]! + An array of valid coupon codes.
+ type - ApplyCouponsStrategy + + replace to replace the existing coupon(s) or append to add the coupon to the coupon(s) list. +
+
+
+
+
+
Example
+ 
{
+  "cart_id": "abc123",
+  "coupon_codes": ["abc123"],
+  "type": "APPEND"
+}
+
+
+
+
+
+
+
+ Types +
+

ApplyGiftCardToCartInput

+
+
+
+
Description
+

Defines the input required to run the applyGiftCardToCart mutation.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID that identifies the customer's cart.
+ gift_card_code - String! + The gift card code to be applied to the cart.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "xyz789",
+  "gift_card_code": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

ApplyGiftCardToCartOutput

+
+
+
+
Description
+

Defines the possible output for the applyGiftCardToCart mutation.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + Describes the contents of the specified shopping cart.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

ApplyGiftCardToOrder

+
+
+
+
Description
+

Contains applied gift cards with gift card code and amount.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
applied_balance - Money! + The gift card amount applied to the current order.
code - String! + The gift card account code.
+
+
+
+
+
Example
+ 
{
+  "applied_balance": Money,
+  "code": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

ApplyRewardPointsToCartOutput

+
+
+
+
Description
+

Contains the customer cart.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The customer cart after reward points are applied.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

ApplyStoreCreditToCartInput

+
+
+
+
Description
+

Defines the input required to run the applyStoreCreditToCart mutation.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID that identifies the customer's cart.
+
+
+
+
+
Example
+ 
{"cart_id": "xyz789"}
+
+
+
+
+
+
+
+ Types +
+

ApplyStoreCreditToCartOutput

+
+
+
+
Description
+

Defines the possible output for the applyStoreCreditToCart mutation.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The contents of the specified shopping cart.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

AreaInput

+
+
+
+
Description
+

AreaInput defines the parameters which will be used for filter by specified location.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ radius - Int! + The radius for the search in KM.
+ search_term - String! + The country code where search must be performed. Required parameter together with region, city or postcode.
+
+
+
+
+
Example
+ 
{"radius": 987, "search_term": "abc123"}
+
+
+
+
+
+
+
+ Types +
+

AssignCompareListToCustomerOutput

+
+
+
+
Description
+

Contains the results of the request to assign a compare list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
compare_list - CompareList + The contents of the customer's compare list.
result - Boolean! + Indicates whether the compare list was successfully assigned to the customer.
+
+
+
+
+
Example
+ 
{"compare_list": CompareList, "result": true}
+
+
+
+
+
+
+
+ Types +
+

Attribute

+
+
+
+
Description
+

Contains details about the attribute, including the code and type.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
attribute_code - String + The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
attribute_options - [AttributeOption] + Attribute options list.
attribute_type - String + The data type of the attribute.
entity_type - String + The type of entity that defines the attribute.
input_type - String + The frontend input type of the attribute.
storefront_properties - StorefrontProperties + Details about the storefront properties configured for the attribute.
+
+
+
+
+
Example
+ 
{
+  "attribute_code": "xyz789",
+  "attribute_options": [AttributeOption],
+  "attribute_type": "xyz789",
+  "entity_type": "abc123",
+  "input_type": "xyz789",
+  "storefront_properties": StorefrontProperties
+}
+
+
+
+
+
+
+
+ Types +
+

AttributeEntityTypeEnum

+
+
+
+
Description
+

List of all entity types. Populated by the modules introducing EAV entities.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

CATALOG_PRODUCT

+ 		+
+

CATALOG_CATEGORY

+ 		+
+

CUSTOMER

+ 		+
+

CUSTOMER_ADDRESS

+ 		+
+

RMA_ITEM

+ 		+
+
+
+
+
+
Example
+ 
"CATALOG_PRODUCT"
+
+
+
+
+
+
+
+ Types +
+

AttributeFilterInput

+
+
+
+
Description
+

An input object that specifies the filters used for attributes.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ is_comparable - Boolean + Whether a product or category attribute can be compared against another or not.
+ is_filterable - Boolean + Whether a product or category attribute can be filtered or not.
+ is_filterable_in_search - Boolean + Whether a product or category attribute can be filtered in search or not.
+ is_html_allowed_on_front - Boolean + Whether a product or category attribute can use HTML on front or not.
+ is_searchable - Boolean + Whether a product or category attribute can be searched or not.
+ is_used_for_customer_segment - Boolean + Whether a customer or customer address attribute is used for customer segment or not.
+ is_used_for_price_rules - Boolean + Whether a product or category attribute can be used for price rules or not.
+ is_used_for_promo_rules - Boolean + Whether a product or category attribute is used for promo rules or not.
+ is_visible_in_advanced_search - Boolean + Whether a product or category attribute is visible in advanced search or not.
+ is_visible_on_front - Boolean + Whether a product or category attribute is visible on front or not.
+ is_wysiwyg_enabled - Boolean + Whether a product or category attribute has WYSIWYG enabled or not.
+ used_in_product_listing - Boolean + Whether a product or category attribute is used in product listing or not.
+
+
+
+
+
Example
+ 
{
+  "is_comparable": true,
+  "is_filterable": false,
+  "is_filterable_in_search": true,
+  "is_html_allowed_on_front": true,
+  "is_searchable": false,
+  "is_used_for_customer_segment": true,
+  "is_used_for_price_rules": false,
+  "is_used_for_promo_rules": true,
+  "is_visible_in_advanced_search": false,
+  "is_visible_on_front": true,
+  "is_wysiwyg_enabled": false,
+  "used_in_product_listing": false
+}
+
+
+
+
+
+
+
+ Types +
+

AttributeFrontendInputEnum

+
+
+
+
Description
+

EAV attribute frontend input types.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

BOOLEAN

+ 		+
+

DATE

+ 		+
+

DATETIME

+ 		+
+

FILE

+ 		+
+

GALLERY

+ 		+
+

HIDDEN

+ 		+
+

IMAGE

+ 		+
+

MEDIA_IMAGE

+ 		+
+

MULTILINE

+ 		+
+

MULTISELECT

+ 		+
+

PRICE

+ 		+
+

SELECT

+ 		+
+

TEXT

+ 		+
+

TEXTAREA

+ 		+
+

WEIGHT

+ 		+
+

UNDEFINED

+ 		+
+
+
+
+
+
Example
+ 
"BOOLEAN"
+
+
+
+
+
+
+
+ Types +
+

AttributeInput

+
+
+
+
Description
+

Defines the attribute characteristics to search for the attribute_code and entity_type to search.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ attribute_code - String + The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
+ entity_type - String + The type of entity that defines the attribute.
+
+
+
+
+
Example
+ 
{
+  "attribute_code": "xyz789",
+  "entity_type": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

AttributeInputSelectedOption

+
+
+
+
Description
+

Specifies selected option for a select or multiselect attribute value.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ value - String! + The attribute option value.
+
+
+
+
+
Example
+ 
{"value": "abc123"}
+
+
+
+
+
+
+
+ Types +
+

AttributeMetadata

+
+
+
+
Description
+

Base EAV implementation of CustomAttributeMetadataInterface.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
code - ID! + The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
default_value - String + Default attribute value.
entity_type - AttributeEntityTypeEnum! + The type of entity that defines the attribute.
frontend_class - String + The frontend class of the attribute.
frontend_input - AttributeFrontendInputEnum + The frontend input type of the attribute.
is_required - Boolean! + Whether the attribute value is required.
is_unique - Boolean! + Whether the attribute value must be unique.
label - String + The label assigned to the attribute.
options - [CustomAttributeOptionInterface]! + Attribute options.
+
+
+
+
+
Example
+ 
{
+  "code": 4,
+  "default_value": "xyz789",
+  "entity_type": "CATALOG_PRODUCT",
+  "frontend_class": "abc123",
+  "frontend_input": "BOOLEAN",
+  "is_required": true,
+  "is_unique": true,
+  "label": "abc123",
+  "options": [CustomAttributeOptionInterface]
+}
+
+
+
+
+
+
+
+ Types +
+

AttributeMetadataError

+
+
+
+
Description
+

Attribute metadata retrieval error.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
message - String! + Attribute metadata retrieval error message.
type - AttributeMetadataErrorType! + Attribute metadata retrieval error type.
+
+
+
+
+
Example
+ 
{
+  "message": "abc123",
+  "type": "ENTITY_NOT_FOUND"
+}
+
+
+
+
+
+
+
+ Types +
+

AttributeMetadataErrorType

+
+
+
+
Description
+

Attribute metadata retrieval error types.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

ENTITY_NOT_FOUND

+ 		The requested entity was not found.
+

ATTRIBUTE_NOT_FOUND

+ 		The requested attribute was not found.
+

FILTER_NOT_FOUND

+ 		The filter cannot be applied as it does not belong to the entity
+

UNDEFINED

+ 		Not categorized error, see the error message.
+
+
+
+
+
Example
+ 
"ENTITY_NOT_FOUND"
+
+
+
+
+
+
+
+ Types +
+

AttributeOption

+
+
+
+
Description
+

Defines an attribute option.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
label - String + The label assigned to the attribute option.
value - String + The attribute option value.
+
+
+
+
+
Example
+ 
{
+  "label": "xyz789",
+  "value": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

AttributeOptionMetadata

+
+
+
+
Description
+

Base EAV implementation of CustomAttributeOptionInterface.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
is_default - Boolean! + Is the option value default.
label - String! + The label assigned to the attribute option.
value - String! + The attribute option value.
+
+
+
+
+
Example
+ 
{
+  "is_default": true,
+  "label": "xyz789",
+  "value": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

AttributeSelectedOption

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
label - String! + The attribute selected option label.
value - String! + The attribute selected option value.
+
+
+
+
+
Example
+ 
{
+  "label": "xyz789",
+  "value": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

AttributeSelectedOptionInterface

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
label - String! + The attribute selected option label.
value - String! + The attribute selected option value.
+
+
+
Possible Types
+ + + + + + + + + + + +
AttributeSelectedOptionInterface Types
+

AttributeSelectedOption

+
+
+
+
+
+
Example
+ 
{
+  "label": "abc123",
+  "value": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

AttributeSelectedOptions

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
code - ID! + The attribute code.
selected_options - [AttributeSelectedOptionInterface]! + +
+
+
+
+
+
Example
+ 
{
+  "code": "4",
+  "selected_options": [AttributeSelectedOptionInterface]
+}
+
+
+
+
+
+
+
+ Types +
+

AttributeValue

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
code - ID! + The attribute code.
value - String! + The attribute value.
+
+
+
+
+
Example
+ 
{
+  "code": "4",
+  "value": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

AttributeValueInput

+
+
+
+
Description
+

Specifies the value for attribute.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ attribute_code - String! + The code of the attribute.
+ selected_options - [AttributeInputSelectedOption] + An array containing selected options for a select or multiselect attribute.
+ value - String + The value assigned to the attribute.
+
+
+
+
+
Example
+ 
{
+  "attribute_code": "abc123",
+  "selected_options": [AttributeInputSelectedOption],
+  "value": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

AttributeValueInterface

+
+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
code - ID! + The attribute code.
+
+
+
Possible Types
+ + + + + + + + + + + + + + + + + +
AttributeValueInterface Types
+

AttributeValue

+
+

AttributeSelectedOptions

+
+

GiftCartAttributeValue

+
+
+
+
+
+
Example
+ 
{"code": 4}
+
+
+
+
+
+
+
+ Types +
+

AttributesFormOutput

+
+
+
+
Description
+

Metadata of EAV attributes associated to form

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
errors - [AttributeMetadataError]! + Errors of retrieving certain attributes metadata.
items - [CustomAttributeMetadataInterface]! + Requested attributes metadata.
+
+
+
+
+
Example
+ 
{
+  "errors": [AttributeMetadataError],
+  "items": [CustomAttributeMetadataInterface]
+}
+
+
+
+
+
+
+
+ Types +
+

AttributesMetadataOutput

+
+
+
+
Description
+

Metadata of EAV attributes.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
errors - [AttributeMetadataError]! + Errors of retrieving certain attributes metadata.
items - [CustomAttributeMetadataInterface]! + Requested attributes metadata.
+
+
+
+
+
Example
+ 
{
+  "errors": [AttributeMetadataError],
+  "items": [CustomAttributeMetadataInterface]
+}
+
+
+
+
+
+
+
+ Types +
+

AvailableCurrency

+
+
+
+
Description
+

Defines the code and symbol of a currency that can be used for purchase orders.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
code - CurrencyEnum! + 3-letter currency code, for example USD.
symbol - String! + Currency symbol, for example $.
+
+
+
+
+
Example
+ 
{"code": "AFN", "symbol": "abc123"}
+
+
+
+
+
+
+
+ Types +
+

AvailablePaymentMethod

+
+
+
+
Description
+

Describes a payment method that the shopper can use to pay for the order.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
code - String! + The payment method code.
is_deferred - Boolean! + If the payment method is an online integration
title - String! + The payment method title.
+
+
+
+
+
Example
+ 
{
+  "code": "abc123",
+  "is_deferred": false,
+  "title": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

AvailableShippingMethod

+
+
+
+
Description
+

Contains details about the possible shipping methods and carriers.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
amount - Money! + The cost of shipping using this shipping method.
available - Boolean! + Indicates whether this shipping method can be applied to the cart.
base_amount - Money + + The field should not be used on the storefront. +
carrier_code - String! + A string that identifies a commercial carrier or an offline shipping method.
carrier_title - String! + The label for the carrier code.
error_message - String + Describes an error condition.
method_code - String + A shipping method code associated with a carrier. The value could be null if no method is available.
method_title - String + The label for the shipping method code. The value could be null if no method is available.
price_excl_tax - Money! + The cost of shipping using this shipping method, excluding tax.
price_incl_tax - Money! + The cost of shipping using this shipping method, including tax.
+
+
+
+
+
Example
+ 
{
+  "amount": Money,
+  "available": false,
+  "base_amount": Money,
+  "carrier_code": "abc123",
+  "carrier_title": "abc123",
+  "error_message": "abc123",
+  "method_code": "abc123",
+  "method_title": "abc123",
+  "price_excl_tax": Money,
+  "price_incl_tax": Money
+}
+
+
+
+
+
+
+
+ Types +
+

BatchMutationStatus

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

SUCCESS

+ 		+
+

FAILURE

+ 		+
+

MIXED_RESULTS

+ 		+
+
+
+
+
+
Example
+ 
"SUCCESS"
+
+
+
+
+
+
+
+ Types +
+

BillingAddressInput

+
+
+
+
Description
+

Defines the billing address.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ address - CartAddressInput + Defines a billing address.
+ customer_address_id - Int + An ID from the customer's address book that uniquely identifies the address to be used for billing.
+ customer_address_uid - ID + The unique ID from the customer's address book that uniquely identifies the address to be used for billing.
+ same_as_shipping - Boolean + Indicates whether to set the billing address to be the same as the existing shipping address on the cart.
+ use_for_shipping - Boolean + Indicates whether to set the shipping address to be the same as this billing address.
+
+
+
+
+
Example
+ 
{
+  "address": CartAddressInput,
+  "customer_address_id": 987,
+  "customer_address_uid": 4,
+  "same_as_shipping": true,
+  "use_for_shipping": true
+}
+
+
+
+
+
+
+
+ Types +
+

BillingAddressPaymentSourceInput

+
+
+
+
Description
+

The billing address information

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ address_line_1 - String + The first line of the address
+ address_line_2 - String + The second line of the address
+ city - String + The city of the address
+ country_code - String! + The country of the address
+ postal_code - String + The postal code of the address
+ region - String + The region of the address
+
+
+
+
+
Example
+ 
{
+  "address_line_1": "xyz789",
+  "address_line_2": "abc123",
+  "city": "abc123",
+  "country_code": "abc123",
+  "postal_code": "xyz789",
+  "region": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

BillingCartAddress

+
+
+
+
Description
+

Contains details about the billing address.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
city - String! + The city specified for the billing or shipping address.
company - String + The company specified for the billing or shipping address.
country - CartAddressCountry! + An object containing the country label and code.
custom_attributes - [AttributeValueInterface]! + The custom attribute values of the billing or shipping address.
customer_address_uid - ID + The unique ID from the customer's address book that uniquely identifies the address.
customer_notes - String + + The field is used only in shipping address. +
fax - String + The customer's fax number.
firstname - String! + The first name of the customer or guest.
id - Int + Id of the customer address. Use customer_address_uid instead. +
lastname - String! + The last name of the customer or guest.
middlename - String + The middle name of the person associated with the billing/shipping address.
postcode - String + The ZIP or postal code of the billing or shipping address.
prefix - String + An honorific, such as Dr., Mr., or Mrs.
region - CartAddressRegion + An object containing the region label and code.
street - [String]! + An array containing the street for the billing or shipping address.
suffix - String + A value such as Sr., Jr., or III.
telephone - String + The telephone number for the billing or shipping address.
uid - ID! + The unique id of the customer cart address.
vat_id - String + The VAT company number for billing or shipping address.
+
+
+
+
+
Example
+ 
{
+  "city": "abc123",
+  "company": "abc123",
+  "country": CartAddressCountry,
+  "custom_attributes": [AttributeValueInterface],
+  "customer_address_uid": 4,
+  "customer_notes": "abc123",
+  "fax": "abc123",
+  "firstname": "xyz789",
+  "id": 987,
+  "lastname": "abc123",
+  "middlename": "abc123",
+  "postcode": "xyz789",
+  "prefix": "abc123",
+  "region": CartAddressRegion,
+  "street": ["xyz789"],
+  "suffix": "abc123",
+  "telephone": "abc123",
+  "uid": 4,
+  "vat_id": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

Boolean

+
+
+
+
Description
+

The Boolean scalar type represents true or false.

+
+
+
+
+
Example
+ 
true
+
+
+
+
+
+
+
+ Types +
+

BraintreeCcVaultInput

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ device_data - String + +
+ public_hash - String! + +
+
+
+
+
+
Example
+ 
{
+  "device_data": "abc123",
+  "public_hash": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

BraintreeInput

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ device_data - String + Contains a fingerprint provided by Braintree JS SDK and should be sent with sale transaction details to the Braintree payment gateway.
+ is_active_payment_token_enabler - Boolean! + States whether the payment details (Credit/Debit Card, PayPal Account) entered by a customer should be tokenized for later usage. Required only if Vault is enabled for the relevant Braintree payment integration.
+ payment_method_nonce - String! + The one-time payment token generated by Braintree payment gateway based on payment details (Card, PayPal). Required field to make sale transaction.
+
+
+
+
+
Example
+ 
{
+  "device_data": "xyz789",
+  "is_active_payment_token_enabler": false,
+  "payment_method_nonce": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

BraintreeVaultInput

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ device_data - String + +
+ public_hash - String! + +
+
+
+
+
+
Example
+ 
{
+  "device_data": "xyz789",
+  "public_hash": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

Breadcrumb

+
+
+
+
Description
+

Contains details about an individual category that comprises a breadcrumb.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
category_id - Int + The ID of the category. Use category_uid instead. +
category_level - Int + The category level.
category_name - String + The display name of the category.
category_uid - ID! + The unique ID for a Breadcrumb object.
category_url_key - String + The URL key of the category.
category_url_path - String + The URL path of the category.
+
+
+
+
+
Example
+ 
{
+  "category_id": 123,
+  "category_level": 123,
+  "category_name": "abc123",
+  "category_uid": 4,
+  "category_url_key": "xyz789",
+  "category_url_path": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

BundleCartItem

+
+
+
+
Description
+

An implementation for bundle product cart items.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
available_gift_wrapping - [GiftWrapping]! + The list of available gift wrapping options for the cart item.
bundle_options - [SelectedBundleOption]! + An array containing the bundle options the shopper selected.
customizable_options - [SelectedCustomizableOption]! + An array containing the customizable options the shopper selected.
discount - [Discount] + Contains discount for quote line item.
errors - [CartItemError] + An array of errors encountered while loading the cart item
gift_message - GiftMessage + The entered gift message for the cart item
gift_wrapping - GiftWrapping + The selected gift wrapping for the cart item.
id - String! + + Use uid instead. +
is_available - Boolean! + True if requested quantity is less than available stock, false otherwise.
max_qty - Float + Line item max qty in quote template
min_qty - Float + Line item min qty in quote template
not_available_message - String + Message to display when the product is not available with this selected option.
note_from_buyer - [ItemNote] + The buyer's quote line item note.
note_from_seller - [ItemNote] + The seller's quote line item note.
prices - CartItemPrices + Contains details about the price of the item, including taxes and discounts.
product - ProductInterface! + Details about an item in the cart.
quantity - Float! + The quantity of this item in the cart.
uid - ID! + The unique ID for a CartItemInterface object.
+
+
+
+
+
Example
+ 
{
+  "available_gift_wrapping": [GiftWrapping],
+  "bundle_options": [SelectedBundleOption],
+  "customizable_options": [SelectedCustomizableOption],
+  "discount": [Discount],
+  "errors": [CartItemError],
+  "gift_message": GiftMessage,
+  "gift_wrapping": GiftWrapping,
+  "id": "abc123",
+  "is_available": false,
+  "max_qty": 123.45,
+  "min_qty": 123.45,
+  "not_available_message": "xyz789",
+  "note_from_buyer": [ItemNote],
+  "note_from_seller": [ItemNote],
+  "prices": CartItemPrices,
+  "product": ProductInterface,
+  "quantity": 987.65,
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

BundleCreditMemoItem

+
+
+
+
Description
+

Defines bundle product options for CreditMemoItemInterface.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
bundle_options - [ItemSelectedBundleOption] + A list of bundle options that are assigned to a bundle product that is part of a credit memo.
discounts - [Discount] + Details about the final discount amount for the base product, including discounts on options.
id - ID! + The unique ID for a CreditMemoItemInterface object.
order_item - OrderItemInterface + The order item the credit memo is applied to.
product_name - String + The name of the base product.
product_sale_price - Money! + The sale price for the base product, including selected options.
product_sku - String! + The SKU of the base product.
quantity_refunded - Float + The number of refunded items.
+
+
+
+
+
Example
+ 
{
+  "bundle_options": [ItemSelectedBundleOption],
+  "discounts": [Discount],
+  "id": "4",
+  "order_item": OrderItemInterface,
+  "product_name": "xyz789",
+  "product_sale_price": Money,
+  "product_sku": "abc123",
+  "quantity_refunded": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

BundleInvoiceItem

+
+
+
+
Description
+

Defines bundle product options for InvoiceItemInterface.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
bundle_options - [ItemSelectedBundleOption] + A list of bundle options that are assigned to an invoiced bundle product.
discounts - [Discount] + Information about the final discount amount for the base product, including discounts on options.
id - ID! + The unique ID for an InvoiceItemInterface object.
order_item - OrderItemInterface + Details about an individual order item.
product_name - String + The name of the base product.
product_sale_price - Money! + The sale price for the base product including selected options.
product_sku - String! + The SKU of the base product.
quantity_invoiced - Float + The number of invoiced items.
+
+
+
+
+
Example
+ 
{
+  "bundle_options": [ItemSelectedBundleOption],
+  "discounts": [Discount],
+  "id": "4",
+  "order_item": OrderItemInterface,
+  "product_name": "abc123",
+  "product_sale_price": Money,
+  "product_sku": "xyz789",
+  "quantity_invoiced": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

BundleItem

+
+
+
+
Description
+

Defines an individual item within a bundle product.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
option_id - Int + An ID assigned to each type of item in a bundle product. Use uid instead +
options - [BundleItemOption] + An array of additional options for this bundle item.
position - Int + A number indicating the sequence order of this item compared to the other bundle items.
price_range - PriceRange! + The range of prices for the product
required - Boolean + Indicates whether the item must be included in the bundle.
sku - String + The SKU of the bundle product.
title - String + The display name of the item.
type - String + The input type that the customer uses to select the item. Examples include radio button and checkbox.
uid - ID + The unique ID for a BundleItem object.
+
+
+
+
+
Example
+ 
{
+  "option_id": 987,
+  "options": [BundleItemOption],
+  "position": 987,
+  "price_range": PriceRange,
+  "required": true,
+  "sku": "xyz789",
+  "title": "abc123",
+  "type": "xyz789",
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

BundleItemOption

+
+
+
+
Description
+

Defines the characteristics that comprise a specific bundle item and its options.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
can_change_quantity - Boolean + Indicates whether the customer can change the number of items for this option.
id - Int + The ID assigned to the bundled item option. Use uid instead +
is_default - Boolean + Indicates whether this option is the default option.
label - String + The text that identifies the bundled item option.
position - Int + When a bundle item contains multiple options, the relative position of this option compared to the other options.
price - Float + The price of the selected option.
price_type - PriceTypeEnum + One of FIXED, PERCENT, or DYNAMIC.
product - ProductInterface + Contains details about this product option.
qty - Float + Indicates the quantity of this specific bundle item. Use quantity instead. +
quantity - Float + The quantity of this specific bundle item.
uid - ID! + The unique ID for a BundleItemOption object.
+
+
+
+
+
Example
+ 
{
+  "can_change_quantity": false,
+  "id": 987,
+  "is_default": false,
+  "label": "abc123",
+  "position": 123,
+  "price": 987.65,
+  "price_type": "FIXED",
+  "product": ProductInterface,
+  "qty": 987.65,
+  "quantity": 987.65,
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

BundleOptionInput

+
+
+
+
Description
+

Defines the input for a bundle option.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ id - Int! + The ID of the option.
+ quantity - Float! + The number of the selected item to add to the cart.
+ value - [String]! + An array with the chosen value of the option.
+
+
+
+
+
Example
+ 
{
+  "id": 987,
+  "quantity": 123.45,
+  "value": ["abc123"]
+}
+
+
+
+
+
+
+
+ Types +
+

BundleOrderItem

+
+
+
+
Description
+

Defines bundle product options for OrderItemInterface.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
bundle_options - [ItemSelectedBundleOption] + A list of bundle options that are assigned to the bundle product.
discounts - [Discount] + The final discount information for the product.
eligible_for_return - Boolean + Indicates whether the order item is eligible to be in a return request.
entered_options - [OrderItemOption] + The entered option for the base product, such as a logo or image.
gift_message - GiftMessage + The selected gift message for the order item
gift_wrapping - GiftWrapping + The selected gift wrapping for the order item.
id - ID! + The unique ID for an OrderItemInterface object.
parent_sku - String + The SKU of parent product.
prices - OrderItemPrices + Contains details about the price of the item, including taxes and discounts.
product - ProductInterface + The ProductInterface object, which contains details about the base product
product_name - String + The name of the base product.
product_sale_price - Money! + The sale price of the base product, including selected options.
product_sku - String! + The SKU of the base product.
product_type - String + The type of product, such as simple, configurable, etc.
product_url_key - String + URL key of the base product.
quantity_canceled - Float + The number of canceled items.
quantity_invoiced - Float + The number of invoiced items.
quantity_ordered - Float + The number of units ordered for this item.
quantity_refunded - Float + The number of refunded items.
quantity_return_requested - Float + The requested return quantity of the item.
quantity_returned - Float + The number of returned items.
quantity_shipped - Float + The number of shipped items.
selected_options - [OrderItemOption] + The selected options for the base product, such as color or size.
status - String + The status of the order item.
+
+
+
+
+
Example
+ 
{
+  "bundle_options": [ItemSelectedBundleOption],
+  "discounts": [Discount],
+  "eligible_for_return": false,
+  "entered_options": [OrderItemOption],
+  "gift_message": GiftMessage,
+  "gift_wrapping": GiftWrapping,
+  "id": 4,
+  "parent_sku": "xyz789",
+  "prices": OrderItemPrices,
+  "product": ProductInterface,
+  "product_name": "abc123",
+  "product_sale_price": Money,
+  "product_sku": "xyz789",
+  "product_type": "abc123",
+  "product_url_key": "abc123",
+  "quantity_canceled": 987.65,
+  "quantity_invoiced": 123.45,
+  "quantity_ordered": 123.45,
+  "quantity_refunded": 987.65,
+  "quantity_return_requested": 987.65,
+  "quantity_returned": 123.45,
+  "quantity_shipped": 123.45,
+  "selected_options": [OrderItemOption],
+  "status": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

BundleProduct

+
+
+
+
Description
+

Defines basic features of a bundle product and contains multiple BundleItems.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
activity - String + + Use the custom_attributes field instead. +
attribute_set_id - Int + The attribute set assigned to the product. The field should not be used on the storefront. +
canonical_url - String + The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface] + The categories assigned to a product.
category_gear - String + + Use the custom_attributes field instead. +
climate - String + + Use the custom_attributes field instead. +
collar - String + + Use the custom_attributes field instead. +
color - Int + + Use the custom_attributes field instead. +
country_of_manufacture - String + The product's country of origin.
created_at - String + Timestamp indicating when the product was created. The field should not be used on the storefront. +
crosssell_products - [ProductInterface] + An array of cross-sell products.
custom_attributesV2 - ProductCustomAttributes + Product custom attributes.
+
+
Arguments
+
+
+
filters - AttributeFilterInput +
+
+
+
+
description - ComplexTextValue + Detailed information about the product. The value can include simple HTML tags.
dynamic_price - Boolean + Indicates whether the bundle product has a dynamic price.
dynamic_sku - Boolean + Indicates whether the bundle product has a dynamic SKU.
dynamic_weight - Boolean + Indicates whether the bundle product has a dynamically calculated weight.
eco_collection - Int + + Use the custom_attributes field instead. +
erin_recommends - Int + + Use the custom_attributes field instead. +
features_bags - String + + Use the custom_attributes field instead. +
format - Int + + Use the custom_attributes field instead. +
gender - String + + Use the custom_attributes field instead. +
gift_message_available - Boolean! + Returns a value indicating gift message availability for the product.
gift_wrapping_available - Boolean! + Returns a value indicating gift wrapping availability for the product.
gift_wrapping_price - Money + Returns value and currency indicating gift wrapping price for the product.
id - Int + The ID number assigned to the product. Use the uid field instead. +
image - ProductImage + The relative path to the main image on the product page.
is_returnable - String + Indicates whether the product can be returned.
items - [BundleItem] + An array containing information about individual bundle items.
manufacturer - Int + A number representing the product's manufacturer. Use the custom_attributes field instead. +
material - String + + Use the custom_attributes field instead. +
max_sale_qty - Float + Maximum Qty Allowed in Shopping Cart
media_gallery - [MediaGalleryInterface] + An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry] + An array of MediaGalleryEntry objects. Use media_gallery instead. +
meta_description - String + A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String + A comma-separated list of keywords that are visible only to search engines.
meta_title - String + A string that is displayed in the title bar and tab of the browser and in search results lists.
min_sale_qty - Float + Minimum Qty Allowed in Shopping Cart
name - String + The product name. Customers use this name to identify the product.
new - Int + + Use the custom_attributes field instead. +
new_from_date - String + The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String + The end date for new product listings.
only_x_left_in_stock - Float + Product stock only x left count
options - [CustomizableOptionInterface] + An array of options for a customizable product.
options_container - String + If the product has multiple options, determines where they appear on the product page.
pattern - String + + Use the custom_attributes field instead. +
performance_fabric - Int + + Use the custom_attributes field instead. +
price - ProductPrices + Indicates the price of an item. Use price_range for product price information. +
price_details - PriceDetails + The price details of the main product
price_range - PriceRange! + The range of prices for the product
price_tiers - [TierPrice] + An array of TierPrice objects.
price_view - PriceViewEnum + One of PRICE_RANGE or AS_LOW_AS.
product_links - [ProductLinksInterface] + An array of ProductLinks objects.
purpose - Int + + Use the custom_attributes field instead. +
quantity - Float + Amount of available stock
rating_summary - Float! + The average of all the ratings given to the product.
redirect_code - Int! + Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface] + An array of related products.
relative_url - String + The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int! + The total count of all the reviews given to the product.
reviews - ProductReviews! + The list of products reviews.
+
+
Arguments
+
+
+
pageSize - Int +
+

The maximum number of results to return at once. The default is 20.

+
+
+
currentPage - Int +
+

The page of results to return. The default is 1.

+
+
+
+
sale - Int + + Use the custom_attributes field instead. +
ship_bundle_items - ShipBundleItemsEnum + Indicates whether to ship bundle items together or individually.
short_description - ComplexTextValue + A short description of the product. Its use depends on the theme.
size - Int + + Use the custom_attributes field instead. +
sku - String + A number or code assigned to a product to identify the product, options, price, and manufacturer.
sleeve - String + + Use the custom_attributes field instead. +
small_image - ProductImage + The relative path to the small image, which is used on catalog pages.
special_from_date - String + The beginning date that a product has a special price. The field should not be used on the storefront. +
special_price - Float + The discounted price of the product.
special_to_date - String + The end date for a product with a special price.
staged - Boolean! + Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus + Stock status of the product
strap_bags - String + + Use the custom_attributes field instead. +
style_bags - String + + Use the custom_attributes field instead. +
style_bottom - String + + Use the custom_attributes field instead. +
style_general - String + + Use the custom_attributes field instead. +
swatch_image - String + The file name of a swatch image.
thumbnail - ProductImage + The relative path to the product's thumbnail image.
tier_price - Float + The price when tier pricing is in effect and the items purchased threshold has been reached. Use price_tiers for product tier price information. +
tier_prices - [ProductTierPrices] + An array of ProductTierPrices objects. Use price_tiers for product tier price information. +
type - UrlRewriteEntityTypeEnum + One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String + One of simple, virtual, bundle, downloadable, grouped, or configurable. Use __typename instead. +
uid - ID! + The unique ID for a ProductInterface object.
updated_at - String + Timestamp indicating when the product was updated. The field should not be used on the storefront. +
upsell_products - [ProductInterface] + An array of up-sell products.
url_key - String + The part of the URL that identifies the product
url_path - String + + Use product's canonical_url or url rewrites instead +
url_rewrites - [UrlRewrite] + URL rewrites list
url_suffix - String + The part of the product URL that is appended after the url key
websites - [Website] + An array of websites in which the product is available. The field should not be used on the storefront. +
weight - Float + The weight of the item, in units defined by the store.
+
+
+
+
+
Example
+ 
{
+  "activity": "abc123",
+  "attribute_set_id": 987,
+  "canonical_url": "xyz789",
+  "categories": [CategoryInterface],
+  "category_gear": "xyz789",
+  "climate": "abc123",
+  "collar": "xyz789",
+  "color": 123,
+  "country_of_manufacture": "abc123",
+  "created_at": "abc123",
+  "crosssell_products": [ProductInterface],
+  "custom_attributesV2": ProductCustomAttributes,
+  "description": ComplexTextValue,
+  "dynamic_price": false,
+  "dynamic_sku": true,
+  "dynamic_weight": true,
+  "eco_collection": 123,
+  "erin_recommends": 987,
+  "features_bags": "xyz789",
+  "format": 123,
+  "gender": "xyz789",
+  "gift_message_available": false,
+  "gift_wrapping_available": false,
+  "gift_wrapping_price": Money,
+  "id": 987,
+  "image": ProductImage,
+  "is_returnable": "xyz789",
+  "items": [BundleItem],
+  "manufacturer": 123,
+  "material": "xyz789",
+  "max_sale_qty": 123.45,
+  "media_gallery": [MediaGalleryInterface],
+  "media_gallery_entries": [MediaGalleryEntry],
+  "meta_description": "abc123",
+  "meta_keyword": "abc123",
+  "meta_title": "abc123",
+  "min_sale_qty": 987.65,
+  "name": "abc123",
+  "new": 123,
+  "new_from_date": "abc123",
+  "new_to_date": "xyz789",
+  "only_x_left_in_stock": 987.65,
+  "options": [CustomizableOptionInterface],
+  "options_container": "xyz789",
+  "pattern": "abc123",
+  "performance_fabric": 987,
+  "price": ProductPrices,
+  "price_details": PriceDetails,
+  "price_range": PriceRange,
+  "price_tiers": [TierPrice],
+  "price_view": "PRICE_RANGE",
+  "product_links": [ProductLinksInterface],
+  "purpose": 123,
+  "quantity": 123.45,
+  "rating_summary": 123.45,
+  "redirect_code": 987,
+  "related_products": [ProductInterface],
+  "relative_url": "xyz789",
+  "review_count": 987,
+  "reviews": ProductReviews,
+  "sale": 123,
+  "ship_bundle_items": "TOGETHER",
+  "short_description": ComplexTextValue,
+  "size": 123,
+  "sku": "abc123",
+  "sleeve": "xyz789",
+  "small_image": ProductImage,
+  "special_from_date": "abc123",
+  "special_price": 123.45,
+  "special_to_date": "abc123",
+  "staged": true,
+  "stock_status": "IN_STOCK",
+  "strap_bags": "abc123",
+  "style_bags": "abc123",
+  "style_bottom": "abc123",
+  "style_general": "abc123",
+  "swatch_image": "abc123",
+  "thumbnail": ProductImage,
+  "tier_price": 123.45,
+  "tier_prices": [ProductTierPrices],
+  "type": "CMS_PAGE",
+  "type_id": "abc123",
+  "uid": "4",
+  "updated_at": "abc123",
+  "upsell_products": [ProductInterface],
+  "url_key": "abc123",
+  "url_path": "abc123",
+  "url_rewrites": [UrlRewrite],
+  "url_suffix": "abc123",
+  "websites": [Website],
+  "weight": 987.65
+}
+
+
+
+
+
+
+
+ Types +
+

BundleProductCartItemInput

+
+
+
+
Description
+

Defines a single bundle product.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ bundle_options - [BundleOptionInput]! + A mandatory array of options for the bundle product, including each chosen option and specified quantity.
+ customizable_options - [CustomizableOptionInput] + The ID and value of the option.
+ data - CartItemInput! + The quantity and SKU of the bundle product.
+
+
+
+
+
Example
+ 
{
+  "bundle_options": [BundleOptionInput],
+  "customizable_options": [CustomizableOptionInput],
+  "data": CartItemInput
+}
+
+
+
+
+
+
+
+ Types +
+

BundleRequisitionListItem

+
+
+
+
Description
+

Contains details about bundle products added to a requisition list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
bundle_options - [SelectedBundleOption]! + An array of selected options for a bundle product.
customizable_options - [SelectedCustomizableOption]! + Selected custom options for an item in the requisition list.
product - ProductInterface! + Details about a requisition list item.
quantity - Float! + The quantity of the product added to the requisition list.
uid - ID! + The unique ID of an item in a requisition list.
+
+
+
+
+
Example
+ 
{
+  "bundle_options": [SelectedBundleOption],
+  "customizable_options": [SelectedCustomizableOption],
+  "product": ProductInterface,
+  "quantity": 123.45,
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

BundleShipmentItem

+
+
+
+
Description
+

Defines bundle product options for ShipmentItemInterface.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
bundle_options - [ItemSelectedBundleOption] + A list of bundle options that are assigned to a shipped product.
id - ID! + The unique ID for a ShipmentItemInterface object.
order_item - OrderItemInterface + The order item associated with the shipment item.
product_name - String + The name of the base product.
product_sale_price - Money! + The sale price for the base product.
product_sku - String! + The SKU of the base product.
quantity_shipped - Float! + The number of shipped items.
+
+
+
+
+
Example
+ 
{
+  "bundle_options": [ItemSelectedBundleOption],
+  "id": "4",
+  "order_item": OrderItemInterface,
+  "product_name": "xyz789",
+  "product_sale_price": Money,
+  "product_sku": "xyz789",
+  "quantity_shipped": 987.65
+}
+
+
+
+
+
+
+
+ Types +
+

BundleWishlistItem

+
+
+
+
Description
+

Defines bundle product options for WishlistItemInterface.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
added_at - String! + The date and time the item was added to the wish list.
bundle_options - [SelectedBundleOption] + An array containing information about the selected bundle items.
customizable_options - [SelectedCustomizableOption]! + Custom options selected for the wish list item.
description - String + The description of the item.
id - ID! + The unique ID for a WishlistItemInterface object.
product - ProductInterface + Product details of the wish list item.
quantity - Float! + The quantity of this wish list item.
+
+
+
+
+
Example
+ 
{
+  "added_at": "xyz789",
+  "bundle_options": [SelectedBundleOption],
+  "customizable_options": [SelectedCustomizableOption],
+  "description": "xyz789",
+  "id": "4",
+  "product": ProductInterface,
+  "quantity": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

ButtonStyles

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
color - String + The button color
height - Int + The button height in pixels
label - String + The button label
layout - String + The button layout
shape - String + The button shape
tagline - Boolean + Indicates whether the tagline is displayed
use_default_height - Boolean + Defines if the button uses default height. If the value is false, the value of height is used
+
+
+
+
+
Example
+ 
{
+  "color": "xyz789",
+  "height": 123,
+  "label": "xyz789",
+  "layout": "abc123",
+  "shape": "abc123",
+  "tagline": false,
+  "use_default_height": false
+}
+
+
+
+
+
+
+
+ Types +
+

CancelNegotiableQuoteTemplateInput

+
+
+
+
Description
+

Specifies the quote template id of the quote template to cancel

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cancellation_comment - String + A comment to provide reason of cancellation.
+ template_id - ID! + The unique ID of a NegotiableQuoteTemplate object.
+
+
+
+
+
Example
+ 
{
+  "cancellation_comment": "xyz789",
+  "template_id": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

CancelOrderError

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
code - CancelOrderErrorCode! + An error code that is specific to cancel order.
message - String! + A localized error message.
+
+
+
+
+
Example
+ 
{
+  "code": "ORDER_CANCELLATION_DISABLED",
+  "message": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CancelOrderErrorCode

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

ORDER_CANCELLATION_DISABLED

+ 		+
+

UNDEFINED

+ 		+
+

UNAUTHORISED

+ 		+
+

ORDER_NOT_FOUND

+ 		+
+

PARTIAL_ORDER_ITEM_SHIPPED

+ 		+
+

INVALID_ORDER_STATUS

+ 		+
+
+
+
+
+
Example
+ 
"ORDER_CANCELLATION_DISABLED"
+
+
+
+
+
+
+
+ Types +
+

CancelOrderInput

+
+
+
+
Description
+

Defines the order to cancel.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ order_id - ID! + The unique ID of an Order type.
+ reason - String! + Cancellation reason.
+
+
+
+
+
Example
+ 
{"order_id": 4, "reason": "abc123"}
+
+
+
+
+
+
+
+ Types +
+

CancelOrderOutput

+
+
+
+
Description
+

Contains the updated customer order and error message if any.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
error - String + Error encountered while cancelling the order.
errorV2 - CancelOrderError + +
order - CustomerOrder + Updated customer order.
+
+
+
+
+
Example
+ 
{
+  "error": "xyz789",
+  "errorV2": CancelOrderError,
+  "order": CustomerOrder
+}
+
+
+
+
+
+
+
+ Types +
+

CancellationReason

+
+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
description - String! + +
+
+
+
+
+
Example
+ 
{"description": "abc123"}
+
+
+
+
+
+
+
+ Types +
+

Card

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
bin_details - CardBin + Card bin details
card_expiry_month - String + Expiration month of the card
card_expiry_year - String + Expiration year of the card
last_digits - String + Last four digits of the card
name - String + Name on the card
+
+
+
+
+
Example
+ 
{
+  "bin_details": CardBin,
+  "card_expiry_month": "abc123",
+  "card_expiry_year": "abc123",
+  "last_digits": "abc123",
+  "name": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CardBin

+
+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
bin - String + Card bin number
+
+
+
+
+
Example
+ 
{"bin": "abc123"}
+
+
+
+
+
+
+
+ Types +
+

CardPaymentSourceInput

+
+
+
+
Description
+

The card payment source information

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ billing_address - BillingAddressPaymentSourceInput! + The billing address of the card
+ name - String + The name on the cardholder
+
+
+
+
+
Example
+ 
{
+  "billing_address": BillingAddressPaymentSourceInput,
+  "name": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CardPaymentSourceOutput

+
+
+
+
Description
+

The card payment source information

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
brand - String + The brand of the card
expiry - String + The expiry of the card
last_digits - String + The last digits of the card
+
+
+
+
+
Example
+ 
{
+  "brand": "abc123",
+  "expiry": "abc123",
+  "last_digits": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

Cart

+
+
+
+
Description
+

Contains the contents and other details about a guest or customer cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
applied_coupon - AppliedCoupon + + Use applied_coupons instead. +
applied_coupons - [AppliedCoupon] + An array of AppliedCoupon objects. Each object contains the code text attribute, which specifies the coupon code.
applied_gift_cards - [AppliedGiftCard] + An array of gift card items applied to the cart.
applied_reward_points - RewardPointsAmount + The amount of reward points applied to the cart.
applied_store_credit - AppliedStoreCredit + Store credit information applied to the cart.
available_gift_wrappings - [GiftWrapping]! + The list of available gift wrapping options for the cart.
available_payment_methods - [AvailablePaymentMethod] + An array of available payment methods.
billing_address - BillingCartAddress + The billing address assigned to the cart.
email - String + The email address of the guest or customer.
gift_message - GiftMessage + The entered gift message for the cart
gift_receipt_included - Boolean! + Indicates whether the shopper requested gift receipt for the cart.
gift_wrapping - GiftWrapping + The selected gift wrapping for the cart.
id - ID! + The unique ID for a Cart object.
is_virtual - Boolean! + Indicates whether the cart contains only virtual products.
items - [CartItemInterface] + An array of products that have been added to the cart. Use itemsV2 instead. +
itemsV2 - CartItems + +
+
+
Arguments
+
+
+
pageSize - Int +
+
+
+
currentPage - Int +
+
+
+
sort - QuoteItemsSortInput +
+
+
+
+
prices - CartPrices + Pricing details for the quote.
printed_card_included - Boolean! + Indicates whether the shopper requested a printed card for the cart.
rules - [CartRuleStorefront] + Provides applied cart rules in the current active cart
selected_payment_method - SelectedPaymentMethod + Indicates which payment method was applied to the cart.
shipping_addresses - [ShippingCartAddress]! + An array of shipping addresses assigned to the cart.
total_quantity - Float! + The total number of items in the cart.
+
+
+
+
+
Example
+ 
{
+  "applied_coupon": AppliedCoupon,
+  "applied_coupons": [AppliedCoupon],
+  "applied_gift_cards": [AppliedGiftCard],
+  "applied_reward_points": RewardPointsAmount,
+  "applied_store_credit": AppliedStoreCredit,
+  "available_gift_wrappings": [GiftWrapping],
+  "available_payment_methods": [AvailablePaymentMethod],
+  "billing_address": BillingCartAddress,
+  "email": "xyz789",
+  "gift_message": GiftMessage,
+  "gift_receipt_included": true,
+  "gift_wrapping": GiftWrapping,
+  "id": "4",
+  "is_virtual": false,
+  "items": [CartItemInterface],
+  "itemsV2": CartItems,
+  "prices": CartPrices,
+  "printed_card_included": true,
+  "rules": [CartRuleStorefront],
+  "selected_payment_method": SelectedPaymentMethod,
+  "shipping_addresses": [ShippingCartAddress],
+  "total_quantity": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

CartAddressCountry

+
+
+
+
Description
+

Contains details the country in a billing or shipping address.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
code - String! + The country code.
label - String! + The display label for the country.
+
+
+
+
+
Example
+ 
{
+  "code": "abc123",
+  "label": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CartAddressInput

+
+
+
+
Description
+

Defines the billing or shipping address to be applied to the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ city - String! + The city specified for the billing or shipping address.
+ company - String + The company specified for the billing or shipping address.
+ country_code - String! + The country code and label for the billing or shipping address.
+ custom_attributes - [AttributeValueInput] + The custom attribute values of the billing or shipping address.
+ fax - String + The customer's fax number.
+ firstname - String! + The first name of the customer or guest.
+ lastname - String! + The last name of the customer or guest.
+ middlename - String + The middle name of the person associated with the billing/shipping address.
+ postcode - String + The ZIP or postal code of the billing or shipping address.
+ prefix - String + An honorific, such as Dr., Mr., or Mrs.
+ region - String + A string that defines the state or province of the billing or shipping address.
+ region_id - Int + An integer that defines the state or province of the billing or shipping address.
+ save_in_address_book - Boolean + Determines whether to save the address in the customer's address book. The default value is true.
+ street - [String]! + An array containing the street for the billing or shipping address.
+ suffix - String + A value such as Sr., Jr., or III.
+ telephone - String! + The telephone number for the billing or shipping address.
+ vat_id - String + The VAT company number for billing or shipping address.
+
+
+
+
+
Example
+ 
{
+  "city": "abc123",
+  "company": "abc123",
+  "country_code": "xyz789",
+  "custom_attributes": [AttributeValueInput],
+  "fax": "xyz789",
+  "firstname": "xyz789",
+  "lastname": "xyz789",
+  "middlename": "xyz789",
+  "postcode": "xyz789",
+  "prefix": "abc123",
+  "region": "xyz789",
+  "region_id": 123,
+  "save_in_address_book": false,
+  "street": ["abc123"],
+  "suffix": "xyz789",
+  "telephone": "abc123",
+  "vat_id": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CartAddressInterface

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
city - String! + The city specified for the billing or shipping address.
company - String + The company specified for the billing or shipping address.
country - CartAddressCountry! + An object containing the country label and code.
custom_attributes - [AttributeValueInterface]! + The custom attribute values of the billing or shipping address.
customer_address_uid - ID + The unique ID from the customer's address book that uniquely identifies the address.
fax - String + The customer's fax number.
firstname - String! + The first name of the customer or guest.
id - Int + Id of the customer address. Use customer_address_uid instead. +
lastname - String! + The last name of the customer or guest.
middlename - String + The middle name of the person associated with the billing/shipping address.
postcode - String + The ZIP or postal code of the billing or shipping address.
prefix - String + An honorific, such as Dr., Mr., or Mrs.
region - CartAddressRegion + An object containing the region label and code.
street - [String]! + An array containing the street for the billing or shipping address.
suffix - String + A value such as Sr., Jr., or III.
telephone - String + The telephone number for the billing or shipping address.
uid - ID! + The unique id of the customer cart address.
vat_id - String + The VAT company number for billing or shipping address.
+
+
+
Possible Types
+ + + + + + + + + + + + + + +
CartAddressInterface Types
+

ShippingCartAddress

+
+

BillingCartAddress

+
+
+
+
+
+
Example
+ 
{
+  "city": "abc123",
+  "company": "abc123",
+  "country": CartAddressCountry,
+  "custom_attributes": [AttributeValueInterface],
+  "customer_address_uid": 4,
+  "fax": "xyz789",
+  "firstname": "xyz789",
+  "id": 123,
+  "lastname": "xyz789",
+  "middlename": "abc123",
+  "postcode": "abc123",
+  "prefix": "abc123",
+  "region": CartAddressRegion,
+  "street": ["abc123"],
+  "suffix": "abc123",
+  "telephone": "xyz789",
+  "uid": "4",
+  "vat_id": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

CartAddressRegion

+
+
+
+
Description
+

Contains details about the region in a billing or shipping address.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
code - String + The state or province code.
label - String + The display label for the region.
region_id - Int + The unique ID for a pre-defined region.
+
+
+
+
+
Example
+ 
{
+  "code": "xyz789",
+  "label": "abc123",
+  "region_id": 987
+}
+
+
+
+
+
+
+
+ Types +
+

CartDiscount

+
+
+
+
Description
+

Contains information about discounts applied to the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
amount - Money! + The amount of the discount applied to the item.
label - [String]! + The description of the discount.
+
+
+
+
+
Example
+ 
{
+  "amount": Money,
+  "label": ["xyz789"]
+}
+
+
+
+
+
+
+
+ Types +
+

CartDiscountType

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

ITEM

+ 		+
+

SHIPPING

+ 		+
+
+
+
+
+
Example
+ 
"ITEM"
+
+
+
+
+
+
+
+ Types +
+

CartItemError

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
code - CartItemErrorType! + An error code that describes the error encountered
message - String! + A localized error message
+
+
+
+
+
Example
+ 
{"code": "UNDEFINED", "message": "abc123"}
+
+
+
+
+
+
+
+ Types +
+

CartItemErrorType

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

UNDEFINED

+ 		+
+

ITEM_QTY

+ 		+
+

ITEM_INCREMENTS

+ 		+
+
+
+
+
+
Example
+ 
"UNDEFINED"
+
+
+
+
+
+
+
+ Types +
+

CartItemInput

+
+
+
+
Description
+

Defines an item to be added to the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ entered_options - [EnteredOptionInput] + An array of entered options for the base product, such as personalization text.
+ parent_sku - String + For a child product, the SKU of its parent product.
+ quantity - Float! + The amount or number of an item to add.
+ selected_options - [ID] + The selected options for the base product, such as color or size, using the unique ID for an object such as CustomizableRadioOption, CustomizableDropDownOption, or ConfigurableProductOptionsValues.
+ sku - String! + The SKU of the product.
+
+
+
+
+
Example
+ 
{
+  "entered_options": [EnteredOptionInput],
+  "parent_sku": "abc123",
+  "quantity": 987.65,
+  "selected_options": [4],
+  "sku": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

CartItemInterface

+
+
+
+
Description
+

An interface for products in a cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
discount - [Discount] + Contains discount for quote line item.
errors - [CartItemError] + An array of errors encountered while loading the cart item
id - String! + + Use uid instead. +
is_available - Boolean! + True if requested quantity is less than available stock, false otherwise.
max_qty - Float + Line item max qty in quote template
min_qty - Float + Line item min qty in quote template
not_available_message - String + Message to display when the product is not available with this selected option.
note_from_buyer - [ItemNote] + The buyer's quote line item note.
note_from_seller - [ItemNote] + The seller's quote line item note.
prices - CartItemPrices + Contains details about the price of the item, including taxes and discounts.
product - ProductInterface! + Details about an item in the cart.
quantity - Float! + The quantity of this item in the cart.
uid - ID! + The unique ID for a CartItemInterface object.
+
+
+
Possible Types
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
CartItemInterface Types
+

SimpleCartItem

+
+

VirtualCartItem

+
+

ConfigurableCartItem

+
+

DownloadableCartItem

+
+

BundleCartItem

+
+

GiftCardCartItem

+
+
+
+
+
+
Example
+ 
{
+  "discount": [Discount],
+  "errors": [CartItemError],
+  "id": "xyz789",
+  "is_available": false,
+  "max_qty": 123.45,
+  "min_qty": 987.65,
+  "not_available_message": "abc123",
+  "note_from_buyer": [ItemNote],
+  "note_from_seller": [ItemNote],
+  "prices": CartItemPrices,
+  "product": ProductInterface,
+  "quantity": 987.65,
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

CartItemPrices

+
+
+
+
Description
+

Contains details about the price of the item, including taxes and discounts.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
catalog_discount - ProductDiscount + The price discount for the unit price of the item represents the difference between its regular price and final price.
discounts - [Discount] + An array of discounts to be applied to the cart item.
fixed_product_taxes - [FixedProductTax] + An array of FPTs applied to the cart item.
original_item_price - Money! + The value of the original unit price for the item, including discounts.
original_row_total - Money! + The value of the original price multiplied by the quantity of the item.
price - Money! + The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart.
price_including_tax - Money! + The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart.
row_catalog_discount - ProductDiscount + The price discount multiplied by the item quantity represents the total difference between the regular price and the final price for the entire quote item.
row_total - Money! + The value of the price multiplied by the quantity of the item.
row_total_including_tax - Money! + The value of row_total plus the tax applied to the item.
total_item_discount - Money + The total of all discounts applied to the item.
+
+
+
+
+
Example
+ 
{
+  "catalog_discount": ProductDiscount,
+  "discounts": [Discount],
+  "fixed_product_taxes": [FixedProductTax],
+  "original_item_price": Money,
+  "original_row_total": Money,
+  "price": Money,
+  "price_including_tax": Money,
+  "row_catalog_discount": ProductDiscount,
+  "row_total": Money,
+  "row_total_including_tax": Money,
+  "total_item_discount": Money
+}
+
+
+
+
+
+
+
+ Types +
+

CartItemQuantity

+
+
+
+
Description
+

Deprecated: The ShippingCartAddress.cart_items field now returns CartItemInterface.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
cart_item_id - Int! + + The ShippingCartAddress.cart_items field now returns CartItemInterface. +
quantity - Float! + + The ShippingCartAddress.cart_items field now returns CartItemInterface. +
+
+
+
+
+
Example
+ 
{"cart_item_id": 987, "quantity": 987.65}
+
+
+
+
+
+
+
+ Types +
+

CartItemSelectedOptionValuePrice

+
+
+
+
Description
+

Contains details about the price of a selected customizable value.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
type - PriceTypeEnum! + Indicates whether the price type is fixed, percent, or dynamic.
units - String! + A string that describes the unit of the value.
value - Float! + A price value.
+
+
+
+
+
Example
+ 
{
+  "type": "FIXED",
+  "units": "abc123",
+  "value": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

CartItemUpdateInput

+
+
+
+
Description
+

A single item to be updated.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_item_id - Int + Deprecated. Use cart_item_uid instead.
+ cart_item_uid - ID + The unique ID for a CartItemInterface object.
+ customizable_options - [CustomizableOptionInput] + An array that defines customizable options for the product.
+ gift_message - GiftMessageInput + Gift message details for the cart item
+ gift_wrapping_id - ID + The unique ID for a GiftWrapping object to be used for the cart item.
+ quantity - Float + The new quantity of the item.
+
+
+
+
+
Example
+ 
{
+  "cart_item_id": 987,
+  "cart_item_uid": "4",
+  "customizable_options": [CustomizableOptionInput],
+  "gift_message": GiftMessageInput,
+  "gift_wrapping_id": 4,
+  "quantity": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

CartItems

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items - [CartItemInterface]! + An array of products that have been added to the cart.
page_info - SearchResultPageInfo + Metadata for pagination rendering.
total_count - Int! + The number of returned cart items.
+
+
+
+
+
Example
+ 
{
+  "items": [CartItemInterface],
+  "page_info": SearchResultPageInfo,
+  "total_count": 123
+}
+
+
+
+
+
+
+
+ Types +
+

CartPrices

+
+
+
+
Description
+

Contains details about the final price of items in the cart, including discount and tax information.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
applied_taxes - [CartTaxItem] + An array containing the names and amounts of taxes applied to each item in the cart.
discount - CartDiscount + + Use discounts instead. +
discounts - [Discount] + An array containing cart rule discounts, store credit and gift cards applied to the cart.
gift_options - GiftOptionsPrices + The list of prices for the selected gift options.
grand_total - Money + The total, including discounts, taxes, shipping, and other fees.
grand_total_excluding_tax - Money + The total of the cart, including discounts, shipping, and other fees without tax.
subtotal_excluding_tax - Money + The subtotal without any applied taxes.
subtotal_including_tax - Money + The subtotal including any applied taxes.
subtotal_with_discount_excluding_tax - Money + The subtotal with any discounts applied, but not taxes.
+
+
+
+
+
Example
+ 
{
+  "applied_taxes": [CartTaxItem],
+  "discount": CartDiscount,
+  "discounts": [Discount],
+  "gift_options": GiftOptionsPrices,
+  "grand_total": Money,
+  "grand_total_excluding_tax": Money,
+  "subtotal_excluding_tax": Money,
+  "subtotal_including_tax": Money,
+  "subtotal_with_discount_excluding_tax": Money
+}
+
+
+
+
+
+
+
+ Types +
+

CartRuleStorefront

+
+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
uid - ID! + The unique ID for a CartRule object.
+
+
+
+
+
Example
+ 
{"uid": "4"}
+
+
+
+
+
+
+
+ Types +
+

CartTaxItem

+
+
+
+
Description
+

Contains tax information about an item in the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
amount - Money! + The amount of tax applied to the item.
label - String! + The description of the tax.
+
+
+
+
+
Example
+ 
{
+  "amount": Money,
+  "label": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

CartUserInputError

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
code - CartUserInputErrorType! + A cart-specific error code.
message - String! + A localized error message.
+
+
+
+
+
Example
+ 
{
+  "code": "PRODUCT_NOT_FOUND",
+  "message": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CartUserInputErrorType

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

PRODUCT_NOT_FOUND

+ 		+
+

NOT_SALABLE

+ 		+
+

INSUFFICIENT_STOCK

+ 		+
+

COULD_NOT_FIND_CART_ITEM

+ 		+
+

REQUIRED_PARAMETER_MISSING

+ 		+
+

INVALID_PARAMETER_VALUE

+ 		+
+

UNDEFINED

+ 		+
+

PERMISSION_DENIED

+ 		+
+
+
+
+
+
Example
+ 
"PRODUCT_NOT_FOUND"
+
+
+
+
+
+
+
+ Types +
+

CatalogAttributeApplyToEnum

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

SIMPLE

+ 		+
+

VIRTUAL

+ 		+
+

BUNDLE

+ 		+
+

DOWNLOADABLE

+ 		+
+

CONFIGURABLE

+ 		+
+

GROUPED

+ 		+
+

CATEGORY

+ 		+
+
+
+
+
+
Example
+ 
"SIMPLE"
+
+
+
+
+
+
+
+ Types +
+

CatalogAttributeMetadata

+
+
+
+
Description
+

Swatch attribute metadata.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
apply_to - [CatalogAttributeApplyToEnum] + To which catalog types an attribute can be applied.
code - ID! + The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
default_value - String + Default attribute value.
entity_type - AttributeEntityTypeEnum! + The type of entity that defines the attribute.
frontend_class - String + The frontend class of the attribute.
frontend_input - AttributeFrontendInputEnum + The frontend input type of the attribute.
is_comparable - Boolean + Whether a product or category attribute can be compared against another or not.
is_filterable - Boolean + Whether a product or category attribute can be filtered or not.
is_filterable_in_search - Boolean + Whether a product or category attribute can be filtered in search or not.
is_html_allowed_on_front - Boolean + Whether a product or category attribute can use HTML on front or not.
is_required - Boolean! + Whether the attribute value is required.
is_searchable - Boolean + Whether a product or category attribute can be searched or not.
is_unique - Boolean! + Whether the attribute value must be unique.
is_used_for_price_rules - Boolean + Whether a product or category attribute can be used for price rules or not.
is_used_for_promo_rules - Boolean + Whether a product or category attribute is used for promo rules or not.
is_visible_in_advanced_search - Boolean + Whether a product or category attribute is visible in advanced search or not.
is_visible_on_front - Boolean + Whether a product or category attribute is visible on front or not.
is_wysiwyg_enabled - Boolean + Whether a product or category attribute has WYSIWYG enabled or not.
label - String + The label assigned to the attribute.
options - [CustomAttributeOptionInterface]! + Attribute options.
swatch_input_type - SwatchInputTypeEnum + Input type of the swatch attribute option.
update_product_preview_image - Boolean + Whether update product preview image or not.
use_product_image_for_swatch - Boolean + Whether use product image for swatch or not.
used_in_product_listing - Boolean + Whether a product or category attribute is used in product listing or not.
+
+
+
+
+
Example
+ 
{
+  "apply_to": ["SIMPLE"],
+  "code": "4",
+  "default_value": "abc123",
+  "entity_type": "CATALOG_PRODUCT",
+  "frontend_class": "abc123",
+  "frontend_input": "BOOLEAN",
+  "is_comparable": false,
+  "is_filterable": true,
+  "is_filterable_in_search": false,
+  "is_html_allowed_on_front": false,
+  "is_required": false,
+  "is_searchable": true,
+  "is_unique": true,
+  "is_used_for_price_rules": true,
+  "is_used_for_promo_rules": true,
+  "is_visible_in_advanced_search": false,
+  "is_visible_on_front": false,
+  "is_wysiwyg_enabled": true,
+  "label": "xyz789",
+  "options": [CustomAttributeOptionInterface],
+  "swatch_input_type": "BOOLEAN",
+  "update_product_preview_image": true,
+  "use_product_image_for_swatch": false,
+  "used_in_product_listing": true
+}
+
+
+
+
+
+
+
+ Types +
+

CategoryFilterInput

+
+
+
+
Description
+

Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ category_uid - FilterEqualTypeInput + Filter by the unique category ID for a CategoryInterface object.
+ ids - FilterEqualTypeInput + Deprecated: use 'category_uid' to filter uniquely identifiers of categories.
+ name - FilterMatchTypeInput + Filter by the display name of the category.
+ parent_category_uid - FilterEqualTypeInput + Filter by the unique parent category ID for a CategoryInterface object.
+ parent_id - FilterEqualTypeInput + Filter by the unique parent category ID for a CategoryInterface object.
+ url_key - FilterEqualTypeInput + Filter by the part of the URL that identifies the category.
+ url_path - FilterEqualTypeInput + Filter by the URL path for the category.
+
+
+
+
+
Example
+ 
{
+  "category_uid": FilterEqualTypeInput,
+  "ids": FilterEqualTypeInput,
+  "name": FilterMatchTypeInput,
+  "parent_category_uid": FilterEqualTypeInput,
+  "parent_id": FilterEqualTypeInput,
+  "url_key": FilterEqualTypeInput,
+  "url_path": FilterEqualTypeInput
+}
+
+
+
+
+
+
+
+ Types +
+

CategoryInterface

+
+
+
+
Description
+

Contains the full set of attributes that can be returned in a category search.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
automatic_sorting - String + +
available_sort_by - [String] + +
breadcrumbs - [Breadcrumb] + An array of breadcrumb items.
canonical_url - String + The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled.
children_count - String + +
cms_block - CmsBlock + Contains a category CMS block.
created_at - String + The timestamp indicating when the category was created. The field should not be used on the storefront. +
custom_layout_update_file - String + +
default_sort_by - String + The attribute to use for sorting.
description - String + An optional description of the category.
display_mode - String + +
filter_price_range - Float + +
id - Int + An ID that uniquely identifies the category. Use uid instead. +
image - String + +
include_in_menu - Int + +
is_anchor - Int + +
landing_page - Int + +
level - Int + The depth of the category within the tree.
meta_description - String + +
meta_keywords - String + +
meta_title - String + +
name - String + The display name of the category.
path - String + The full category path.
path_in_store - String + The category path within the store.
position - Int + The position of the category relative to other categories at the same level in tree.
product_count - Int + The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.
products - CategoryProducts + The list of products assigned to the category.
+
+
Arguments
+
+
+
pageSize - Int +
+

The maximum number of results to return at once. The default value is 20.

+
+
+
currentPage - Int +
+

The page of results to return. The default value is 1.

+
+
+
sort - ProductAttributeSortInput +
+

The attributes to sort on, and whether to return the results in ascending or descending order.

+
+
+
+
staged - Boolean! + Indicates whether the category is staged for a future campaign.
uid - ID! + The unique ID for a CategoryInterface object.
updated_at - String + The timestamp indicating when the category was updated. The field should not be used on the storefront. +
url_key - String + The URL key assigned to the category.
url_path - String + The URL path assigned to the category.
url_suffix - String + The part of the category URL that is appended after the url key
+
+
+
Possible Types
+ + + + + + + + + + + +
CategoryInterface Types
+

CategoryTree

+
+
+
+
+
+
Example
+ 
{
+  "automatic_sorting": "xyz789",
+  "available_sort_by": ["xyz789"],
+  "breadcrumbs": [Breadcrumb],
+  "canonical_url": "xyz789",
+  "children_count": "xyz789",
+  "cms_block": CmsBlock,
+  "created_at": "abc123",
+  "custom_layout_update_file": "abc123",
+  "default_sort_by": "abc123",
+  "description": "xyz789",
+  "display_mode": "abc123",
+  "filter_price_range": 123.45,
+  "id": 123,
+  "image": "xyz789",
+  "include_in_menu": 987,
+  "is_anchor": 123,
+  "landing_page": 987,
+  "level": 987,
+  "meta_description": "abc123",
+  "meta_keywords": "abc123",
+  "meta_title": "xyz789",
+  "name": "abc123",
+  "path": "abc123",
+  "path_in_store": "abc123",
+  "position": 123,
+  "product_count": 123,
+  "products": CategoryProducts,
+  "staged": false,
+  "uid": 4,
+  "updated_at": "abc123",
+  "url_key": "abc123",
+  "url_path": "xyz789",
+  "url_suffix": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CategoryProducts

+
+
+
+
Description
+

Contains details about the products assigned to a category.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items - [ProductInterface] + An array of products that are assigned to the category.
page_info - SearchResultPageInfo + Pagination metadata.
total_count - Int + The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.
+
+
+
+
+
Example
+ 
{
+  "items": [ProductInterface],
+  "page_info": SearchResultPageInfo,
+  "total_count": 987
+}
+
+
+
+
+
+
+
+ Types +
+

CategoryResult

+
+
+
+
Description
+

Contains a collection of CategoryTree objects and pagination information.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items - [CategoryTree] + A list of categories that match the filter criteria.
page_info - SearchResultPageInfo + An object that includes the page_info and currentPage values specified in the query.
total_count - Int + The total number of categories that match the criteria.
+
+
+
+
+
Example
+ 
{
+  "items": [CategoryTree],
+  "page_info": SearchResultPageInfo,
+  "total_count": 987
+}
+
+
+
+
+
+
+
+ Types +
+

CategoryTree

+
+
+
+
Description
+

Contains the hierarchy of categories.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
automatic_sorting - String + +
available_sort_by - [String] + +
breadcrumbs - [Breadcrumb] + An array of breadcrumb items.
canonical_url - String + The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Categories' is enabled.
children - [CategoryTree] + A tree of child categories.
children_count - String + +
cms_block - CmsBlock + Contains a category CMS block.
created_at - String + The timestamp indicating when the category was created. The field should not be used on the storefront. +
custom_layout_update_file - String + +
default_sort_by - String + The attribute to use for sorting.
description - String + An optional description of the category.
display_mode - String + +
filter_price_range - Float + +
id - Int + An ID that uniquely identifies the category. Use uid instead. +
image - String + +
include_in_menu - Int + +
is_anchor - Int + +
landing_page - Int + +
level - Int + The depth of the category within the tree.
meta_description - String + +
meta_keywords - String + +
meta_title - String + +
name - String + The display name of the category.
path - String + The full category path.
path_in_store - String + The category path within the store.
position - Int + The position of the category relative to other categories at the same level in tree.
product_count - Int + The number of products in the category that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.
products - CategoryProducts + The list of products assigned to the category.
+
+
Arguments
+
+
+
pageSize - Int +
+

The maximum number of results to return at once. The default value is 20.

+
+
+
currentPage - Int +
+

The page of results to return. The default value is 1.

+
+
+
sort - ProductAttributeSortInput +
+

The attributes to sort on, and whether to return the results in ascending or descending order.

+
+
+
+
redirect_code - Int! + Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
relative_url - String + The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
staged - Boolean! + Indicates whether the category is staged for a future campaign.
type - UrlRewriteEntityTypeEnum + One of PRODUCT, CATEGORY, or CMS_PAGE.
uid - ID! + The unique ID for a CategoryInterface object.
updated_at - String + The timestamp indicating when the category was updated. The field should not be used on the storefront. +
url_key - String + The URL key assigned to the category.
url_path - String + The URL path assigned to the category.
url_suffix - String + The part of the category URL that is appended after the url key
+
+
+
+
+
Example
+ 
{
+  "automatic_sorting": "xyz789",
+  "available_sort_by": ["abc123"],
+  "breadcrumbs": [Breadcrumb],
+  "canonical_url": "xyz789",
+  "children": [CategoryTree],
+  "children_count": "abc123",
+  "cms_block": CmsBlock,
+  "created_at": "abc123",
+  "custom_layout_update_file": "xyz789",
+  "default_sort_by": "abc123",
+  "description": "xyz789",
+  "display_mode": "xyz789",
+  "filter_price_range": 123.45,
+  "id": 123,
+  "image": "abc123",
+  "include_in_menu": 123,
+  "is_anchor": 123,
+  "landing_page": 123,
+  "level": 987,
+  "meta_description": "abc123",
+  "meta_keywords": "abc123",
+  "meta_title": "abc123",
+  "name": "abc123",
+  "path": "abc123",
+  "path_in_store": "abc123",
+  "position": 987,
+  "product_count": 123,
+  "products": CategoryProducts,
+  "redirect_code": 123,
+  "relative_url": "abc123",
+  "staged": false,
+  "type": "CMS_PAGE",
+  "uid": "4",
+  "updated_at": "abc123",
+  "url_key": "xyz789",
+  "url_path": "xyz789",
+  "url_suffix": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CheckoutAgreement

+
+
+
+
Description
+

Defines details about an individual checkout agreement.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
agreement_id - Int! + The ID for a checkout agreement.
checkbox_text - String! + The checkbox text for the checkout agreement.
content - String! + Required. The text of the agreement.
content_height - String + The height of the text box where the Terms and Conditions statement appears during checkout.
is_html - Boolean! + Indicates whether the content text is in HTML format.
mode - CheckoutAgreementMode! + Indicates whether agreements are accepted automatically or manually.
name - String! + The name given to the condition.
+
+
+
+
+
Example
+ 
{
+  "agreement_id": 123,
+  "checkbox_text": "xyz789",
+  "content": "xyz789",
+  "content_height": "xyz789",
+  "is_html": false,
+  "mode": "AUTO",
+  "name": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CheckoutAgreementMode

+
+
+
+
Description
+

Indicates how agreements are accepted.

+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

AUTO

+ 		Conditions are automatically accepted upon checkout.
+

MANUAL

+ 		Shoppers must manually accept the conditions to place an order.
+
+
+
+
+
Example
+ 
"AUTO"
+
+
+
+
+
+
+
+ Types +
+

CheckoutUserInputError

+
+
+
+
Description
+

An error encountered while adding an item to the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
code - CheckoutUserInputErrorCodes! + An error code that is specific to Checkout.
message - String! + A localized error message.
path - [String]! + The path to the input field that caused an error. See the GraphQL specification about path errors for details: http://spec.graphql.org/draft/#sec-Errors
+
+
+
+
+
Example
+ 
{
+  "code": "REORDER_NOT_AVAILABLE",
+  "message": "abc123",
+  "path": ["abc123"]
+}
+
+
+
+
+
+
+
+ Types +
+

CheckoutUserInputErrorCodes

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

REORDER_NOT_AVAILABLE

+ 		+
+

PRODUCT_NOT_FOUND

+ 		+
+

NOT_SALABLE

+ 		+
+

INSUFFICIENT_STOCK

+ 		+
+

UNDEFINED

+ 		+
+
+
+
+
+
Example
+ 
"REORDER_NOT_AVAILABLE"
+
+
+
+
+
+
+
+ Types +
+

ClearCartError

+
+
+
+
Description
+

Contains details about errors encountered when a customer clear cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
message - String! + A localized error message
type - ClearCartErrorType! + A cart-specific error type.
+
+
+
+
+
Example
+ 
{"message": "abc123", "type": "NOT_FOUND"}
+
+
+
+
+
+
+
+ Types +
+

ClearCartErrorType

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

NOT_FOUND

+ 		+
+

UNAUTHORISED

+ 		+
+

INACTIVE

+ 		+
+

UNDEFINED

+ 		+
+
+
+
+
+
Example
+ 
"NOT_FOUND"
+
+
+
+
+
+
+
+ Types +
+

ClearCartInput

+
+
+
+
Description
+

Assigns a specific cart_id to the empty cart.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ uid - ID! + The unique ID of a Cart object.
+
+
+
+
+
Example
+ 
{"uid": "4"}
+
+
+
+
+
+
+
+ Types +
+

ClearCartOutput

+
+
+
+
Description
+

Output of the request to clear the customer cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
cart - Cart + The cart after clear cart items.
errors - [ClearCartError] + An array of errors encountered while clearing the cart item
+
+
+
+
+
Example
+ 
{
+  "cart": Cart,
+  "errors": [ClearCartError]
+}
+
+
+
+
+
+
+
+ Types +
+

ClearCustomerCartOutput

+
+
+
+
Description
+

Output of the request to clear the customer cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
cart - Cart + The cart after clearing items.
status - Boolean! + Indicates whether cart was cleared.
+
+
+
+
+
Example
+ 
{"cart": Cart, "status": false}
+
+
+
+
+
+
+
+ Types +
+

CloseNegotiableQuoteError

+
+
+
+
Types
+ + + + + + + + + + + + + + + + + +
Union Types
+

NegotiableQuoteInvalidStateError

+
+

NoSuchEntityUidError

+
+

InternalError

+
+
+
+
+
+
Example
+ 
NegotiableQuoteInvalidStateError
+
+
+
+
+
+
+
+ Types +
+

CloseNegotiableQuoteOperationFailure

+
+
+
+
Description
+

Contains details about a failed close operation on a negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
errors - [CloseNegotiableQuoteError]! + An array of errors encountered while attempting close the negotiable quote.
quote_uid - ID! + The unique ID of a NegotiableQuote object.
+
+
+
+
+
Example
+ 
{
+  "errors": [NegotiableQuoteInvalidStateError],
+  "quote_uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

CloseNegotiableQuoteOperationResult

+
+
+
+
Types
+ + + + + + + + + + + + + + +
Union Types
+

NegotiableQuoteUidOperationSuccess

+
+

CloseNegotiableQuoteOperationFailure

+
+
+
+
+
+
Example
+ 
NegotiableQuoteUidOperationSuccess
+
+
+
+
+
+
+
+ Types +
+

CloseNegotiableQuotesInput

+
+
+
+
Description
+

Defines the negotiable quotes to mark as closed.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ quote_uids - [ID]! + A list of unique IDs from NegotiableQuote objects.
+
+
+
+
+
Example
+ 
{"quote_uids": [4]}
+
+
+
+
+
+
+
+ Types +
+

CloseNegotiableQuotesOutput

+
+
+
+
Description
+

Contains the closed negotiable quotes and other negotiable quotes the company user can view.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
closed_quotes - [NegotiableQuote] + An array containing the negotiable quotes that were just closed. Use operation_results instead. +
negotiable_quotes - NegotiableQuotesOutput + A list of negotiable quotes that can be viewed by the logged-in customer
+
+
Arguments
+
+
+
filter - NegotiableQuoteFilterInput +
+

The filter to use to determine which negotiable quotes to close.

+
+
+
pageSize - Int +
+

The maximum number of results to return at once. The default value is 20.

+
+
+
currentPage - Int +
+

The page of results to return. The default value is 1.

+
+
+
sort - NegotiableQuoteSortInput +
+

The field to use for sorting results.

+
+
+
+
operation_results - [CloseNegotiableQuoteOperationResult]! + An array of closed negotiable quote UIDs and details about any errors.
result_status - BatchMutationStatus! + The status of the request to close one or more negotiable quotes.
+
+
+
+
+
Example
+ 
{
+  "closed_quotes": [NegotiableQuote],
+  "negotiable_quotes": NegotiableQuotesOutput,
+  "operation_results": [
+    NegotiableQuoteUidOperationSuccess
+  ],
+  "result_status": "SUCCESS"
+}
+
+
+
+
+
+
+
+ Types +
+

CmsBlock

+
+
+
+
Description
+

Contains details about a specific CMS block.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
content - String + The content of the CMS block in raw HTML.
identifier - String + The CMS block identifier.
title - String + The title assigned to the CMS block.
+
+
+
+
+
Example
+ 
{
+  "content": "xyz789",
+  "identifier": "xyz789",
+  "title": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

CmsBlocks

+
+
+
+
Description
+

Contains an array CMS block items.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
items - [CmsBlock] + An array of CMS blocks.
+
+
+
+
+
Example
+ 
{"items": [CmsBlock]}
+
+
+
+
+
+
+
+ Types +
+

CmsPage

+
+
+
+
Description
+

Contains details about a CMS page.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
content - String + The content of the CMS page in raw HTML.
content_heading - String + The heading that displays at the top of the CMS page.
identifier - String + The ID of a CMS page.
meta_description - String + A brief description of the page for search results listings.
meta_keywords - String + A brief description of the page for search results listings.
meta_title - String + A page title that is indexed by search engines and appears in search results listings.
page_layout - String + The design layout of the page, indicating the number of columns and navigation features used on the page.
redirect_code - Int! + Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
relative_url - String + The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
title - String + The name that appears in the breadcrumb trail navigation and in the browser title bar and tab.
type - UrlRewriteEntityTypeEnum + One of PRODUCT, CATEGORY, or CMS_PAGE.
url_key - String + The URL key of the CMS page, which is often based on the content_heading.
+
+
+
+
+
Example
+ 
{
+  "content": "abc123",
+  "content_heading": "xyz789",
+  "identifier": "xyz789",
+  "meta_description": "xyz789",
+  "meta_keywords": "xyz789",
+  "meta_title": "xyz789",
+  "page_layout": "abc123",
+  "redirect_code": 987,
+  "relative_url": "xyz789",
+  "title": "abc123",
+  "type": "CMS_PAGE",
+  "url_key": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

ColorSwatchData

+
+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
value - String + The value can be represented as color (HEX code), image link, or text.
+
+
+
+
+
Example
+ 
{"value": "xyz789"}
+
+
+
+
+
+
+
+ Types +
+

CompaniesSortFieldEnum

+
+
+
+
Description
+

The fields available for sorting the customer companies.

+
+
+
Values
+ + + + + + + + + + + + + +
Enum ValueDescription
+

NAME

+ 		The name of the company.
+
+
+
+
+
Example
+ 
"NAME"
+
+
+
+
+
+
+
+ Types +
+

CompaniesSortInput

+
+
+
+
Description
+

Specifies which field to sort on, and whether to return the results in ascending or descending order.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ field - CompaniesSortFieldEnum! + The field for sorting the results.
+ order - SortEnum! + Indicates whether to return results in ascending or descending order.
+
+
+
+
+
Example
+ 
{"field": "NAME", "order": "ASC"}
+
+
+
+
+
+
+
+ Types +
+

Company

+
+
+
+
Description
+

Contains the output schema for a company.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
acl_resources - [CompanyAclResource] + The list of all resources defined within the company.
company_admin - Customer + An object containing information about the company administrator.
credit - CompanyCredit! + Company credit balances and limits.
credit_history - CompanyCreditHistory! + Details about the history of company credit operations.
+
+
Arguments
+
+
+
filter - CompanyCreditHistoryFilterInput +
+
+
+
pageSize - Int +
+
+
+
currentPage - Int +
+
+
+
+
email - String + The email address of the company contact.
id - ID! + The unique ID of a Company object.
legal_address - CompanyLegalAddress + The address where the company is registered to conduct business.
legal_name - String + The full legal name of the company.
name - String + The name of the company.
payment_methods - [String] + The list of payment methods available to a company.
reseller_id - String + The resale number that is assigned to the company for tax reporting purposes.
role - CompanyRole + A company role filtered by the unique ID of a CompanyRole object.
+
+
Arguments
+
+
+
id - ID! +
+
+
+
+
roles - CompanyRoles! + An object that contains a list of company roles.
+
+
Arguments
+
+
+
pageSize - Int +
+

The maximum number of results to return at once. The default value is 20.

+
+
+
currentPage - Int +
+

The page of results to return. The default value is 1

+
+
+
+
sales_representative - CompanySalesRepresentative + An object containing information about the company sales representative.
structure - CompanyStructure + The company structure of teams and customers in depth-first order.
+
+
Arguments
+
+
+
rootId - ID +
+

The ID of the node in the company structure that serves as the root for the query.

+
+
+
depth - Int +
+

The maximum depth that can be reached when listing structure nodes.

+
+
+
+
team - CompanyTeam + The company team data filtered by the unique ID for a CompanyTeam object.
+
+
Arguments
+
+
+
id - ID! +
+
+
+
+
user - Customer + A company user filtered by the unique ID of a Customer object.
+
+
Arguments
+
+
+
id - ID! +
+
+
+
+
users - CompanyUsers + An object that contains a list of company users based on activity status.
+
+
Arguments
+
+
+
filter - CompanyUsersFilterInput +
+

The type of company users to return.

+
+
+
pageSize - Int +
+

The maximum number of results to return at once. The default value is 20.

+
+
+
currentPage - Int +
+

The page of results to return. The default value is 1.

+
+
+
+
vat_tax_id - String + The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.
+
+
+
+
+
Example
+ 
{
+  "acl_resources": [CompanyAclResource],
+  "company_admin": Customer,
+  "credit": CompanyCredit,
+  "credit_history": CompanyCreditHistory,
+  "email": "xyz789",
+  "id": 4,
+  "legal_address": CompanyLegalAddress,
+  "legal_name": "abc123",
+  "name": "xyz789",
+  "payment_methods": ["xyz789"],
+  "reseller_id": "xyz789",
+  "role": CompanyRole,
+  "roles": CompanyRoles,
+  "sales_representative": CompanySalesRepresentative,
+  "structure": CompanyStructure,
+  "team": CompanyTeam,
+  "user": Customer,
+  "users": CompanyUsers,
+  "vat_tax_id": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyAclResource

+
+
+
+
Description
+

Contains details about the access control list settings of a resource.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
children - [CompanyAclResource] + An array of sub-resources.
id - ID! + The unique ID for a CompanyAclResource object.
sort_order - Int + The sort order of an ACL resource.
text - String + The label assigned to the ACL resource.
+
+
+
+
+
Example
+ 
{
+  "children": [CompanyAclResource],
+  "id": 4,
+  "sort_order": 123,
+  "text": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyAdminInput

+
+
+
+
Description
+

Defines the input schema for creating a company administrator.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ custom_attributes - [AttributeValueInput] + The company administrator's custom attributes.
+ email - String! + The email address of the company administrator.
+ firstname - String! + The company administrator's first name.
+ gender - Int + The company administrator's gender (Male - 1, Female - 2, Not Specified - 3).
+ job_title - String + The job title of the company administrator.
+ lastname - String! + The company administrator's last name.
+ telephone - String + The phone number of the company administrator.
+
+
+
+
+
Example
+ 
{
+  "custom_attributes": [AttributeValueInput],
+  "email": "xyz789",
+  "firstname": "abc123",
+  "gender": 123,
+  "job_title": "abc123",
+  "lastname": "xyz789",
+  "telephone": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyBasicInfo

+
+
+
+
Description
+

The minimal required information to identify and display the company.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
id - ID! + The unique ID of a Company object.
legal_name - String + The full legal name of the company.
name - String + The name of the company.
+
+
+
+
+
Example
+ 
{
+  "id": "4",
+  "legal_name": "xyz789",
+  "name": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyCreateInput

+
+
+
+
Description
+

Defines the input schema for creating a new company.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ company_admin - CompanyAdminInput! + Defines the company administrator.
+ company_email - String! + The email address of the company contact.
+ company_name - String! + The name of the company to create.
+ legal_address - CompanyLegalAddressCreateInput! + Defines legal address data of the company.
+ legal_name - String + The full legal name of the company.
+ reseller_id - String + The resale number that is assigned to the company for tax reporting purposes.
+ vat_tax_id - String + The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.
+
+
+
+
+
Example
+ 
{
+  "company_admin": CompanyAdminInput,
+  "company_email": "xyz789",
+  "company_name": "abc123",
+  "legal_address": CompanyLegalAddressCreateInput,
+  "legal_name": "abc123",
+  "reseller_id": "xyz789",
+  "vat_tax_id": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyCredit

+
+
+
+
Description
+

Contains company credit balances and limits.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
available_credit - Money! + The sum of the credit limit and the outstanding balance. If the company has exceeded the credit limit, the amount is as a negative value.
credit_limit - Money! + The amount of credit extended to the company.
outstanding_balance - Money! + The amount reimbursed, less the total due from all orders placed using the Payment on Account payment method. The amount can be a positive or negative value.
+
+
+
+
+
Example
+ 
{
+  "available_credit": Money,
+  "credit_limit": Money,
+  "outstanding_balance": Money
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyCreditHistory

+
+
+
+
Description
+

Contains details about prior company credit operations.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items - [CompanyCreditOperation]! + An array of company credit operations.
page_info - SearchResultPageInfo! + Metadata for pagination rendering.
total_count - Int + The number of the company credit operations matching the specified filter.
+
+
+
+
+
Example
+ 
{
+  "items": [CompanyCreditOperation],
+  "page_info": SearchResultPageInfo,
+  "total_count": 987
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyCreditHistoryFilterInput

+
+
+
+
Description
+

Defines a filter for narrowing the results of a credit history search.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ custom_reference_number - String + The purchase order number associated with the company credit operation.
+ operation_type - CompanyCreditOperationType + The type of the company credit operation.
+ updated_by - String + The name of the person submitting the company credit operation.
+
+
+
+
+
Example
+ 
{
+  "custom_reference_number": "abc123",
+  "operation_type": "ALLOCATION",
+  "updated_by": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyCreditOperation

+
+
+
+
Description
+

Contains details about a single company credit operation.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
amount - Money + The amount of the company credit operation.
balance - CompanyCredit! + The credit balance as a result of the operation.
custom_reference_number - String + The purchase order number associated with the company credit operation.
date - String! + The date the operation occurred.
type - CompanyCreditOperationType! + The type of the company credit operation.
updated_by - CompanyCreditOperationUser! + The company user that submitted the company credit operation.
+
+
+
+
+
Example
+ 
{
+  "amount": Money,
+  "balance": CompanyCredit,
+  "custom_reference_number": "xyz789",
+  "date": "xyz789",
+  "type": "ALLOCATION",
+  "updated_by": CompanyCreditOperationUser
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyCreditOperationType

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

ALLOCATION

+ 		+
+

UPDATE

+ 		+
+

PURCHASE

+ 		+
+

REIMBURSEMENT

+ 		+
+

REFUND

+ 		+
+

REVERT

+ 		+
+
+
+
+
+
Example
+ 
"ALLOCATION"
+
+
+
+
+
+
+
+ Types +
+

CompanyCreditOperationUser

+
+
+
+
Description
+

Defines the administrator or company user that submitted a company credit operation.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
name - String! + The name of the company user submitting the company credit operation.
type - CompanyCreditOperationUserType! + The type of the company user submitting the company credit operation.
+
+
+
+
+
Example
+ 
{"name": "xyz789", "type": "CUSTOMER"}
+
+
+
+
+
+
+
+ Types +
+

CompanyCreditOperationUserType

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

CUSTOMER

+ 		+
+

ADMIN

+ 		+
+
+
+
+
+
Example
+ 
"CUSTOMER"
+
+
+
+
+
+
+
+ Types +
+

CompanyInvitationInput

+
+
+
+
Description
+

Defines the input schema for accepting the company invitation.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ code - String! + The invitation code.
+ role_id - ID + The company role id.
+ user - CompanyInvitationUserInput! + Company user attributes in the invitation.
+
+
+
+
+
Example
+ 
{
+  "code": "abc123",
+  "role_id": 4,
+  "user": CompanyInvitationUserInput
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyInvitationOutput

+
+
+
+
Description
+

The result of accepting the company invitation.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
success - Boolean + Indicates whether the customer was added to the company successfully.
+
+
+
+
+
Example
+ 
{"success": true}
+
+
+
+
+
+
+
+ Types +
+

CompanyInvitationUserInput

+
+
+
+
Description
+

Company user attributes in the invitation.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ company_id - ID! + The company unique identifier.
+ customer_id - ID! + The customer unique identifier.
+ job_title - String + The job title of a company user.
+ status - CompanyUserStatusEnum + Indicates whether the company user is ACTIVE or INACTIVE.
+ telephone - String + The phone number of the company user.
+
+
+
+
+
Example
+ 
{
+  "company_id": 4,
+  "customer_id": 4,
+  "job_title": "abc123",
+  "status": "ACTIVE",
+  "telephone": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyLegalAddress

+
+
+
+
Description
+

Contains details about the address where the company is registered to conduct business.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
city - String + The city where the company is registered to conduct business.
country_code - CountryCodeEnum + The country code of the company's legal address.
postcode - String + The company's postal code.
region - CustomerAddressRegion + An object containing region data for the company.
street - [String] + An array of strings that define the company's street address.
telephone - String + The company's phone number.
+
+
+
+
+
Example
+ 
{
+  "city": "xyz789",
+  "country_code": "AF",
+  "postcode": "xyz789",
+  "region": CustomerAddressRegion,
+  "street": ["abc123"],
+  "telephone": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyLegalAddressCreateInput

+
+
+
+
Description
+

Defines the input schema for defining a company's legal address.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ city - String! + The city where the company is registered to conduct business.
+ country_id - CountryCodeEnum! + The company's country ID. Use the countries query to get this value.
+ postcode - String! + The postal code of the company.
+ region - CustomerAddressRegionInput! + An object containing the region name and/or region ID where the company is registered to conduct business.
+ street - [String]! + An array of strings that define the street address where the company is registered to conduct business.
+ telephone - String! + The primary phone number of the company.
+
+
+
+
+
Example
+ 
{
+  "city": "abc123",
+  "country_id": "AF",
+  "postcode": "abc123",
+  "region": CustomerAddressRegionInput,
+  "street": ["abc123"],
+  "telephone": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyLegalAddressUpdateInput

+
+
+
+
Description
+

Defines the input schema for updating a company's legal address.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ city - String + The city where the company is registered to conduct business.
+ country_id - CountryCodeEnum + The unique ID for a Country object.
+ postcode - String + The postal code of the company.
+ region - CustomerAddressRegionInput + An object containing the region name and/or region ID where the company is registered to conduct business.
+ street - [String] + An array of strings that define the street address where the company is registered to conduct business.
+ telephone - String + The primary phone number of the company.
+
+
+
+
+
Example
+ 
{
+  "city": "abc123",
+  "country_id": "AF",
+  "postcode": "abc123",
+  "region": CustomerAddressRegionInput,
+  "street": ["xyz789"],
+  "telephone": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyRole

+
+
+
+
Description
+

Contails details about a single role.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
id - ID! + The unique ID for a CompanyRole object.
name - String + The name assigned to the role.
permissions - [CompanyAclResource] + A list of permission resources defined for a role.
users_count - Int + The total number of users assigned the specified role.
+
+
+
+
+
Example
+ 
{
+  "id": "4",
+  "name": "abc123",
+  "permissions": [CompanyAclResource],
+  "users_count": 123
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyRoleCreateInput

+
+
+
+
Description
+

Defines the input schema for creating a company role.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ name - String! + The name of the role to create.
+ permissions - [String]! + A list of resources the role can access.
+
+
+
+
+
Example
+ 
{
+  "name": "xyz789",
+  "permissions": ["abc123"]
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyRoleUpdateInput

+
+
+
+
Description
+

Defines the input schema for updating a company role.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ id - ID! + The unique ID for a CompanyRole object.
+ name - String + The name of the role to update.
+ permissions - [String] + A list of resources the role can access.
+
+
+
+
+
Example
+ 
{
+  "id": 4,
+  "name": "abc123",
+  "permissions": ["abc123"]
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyRoles

+
+
+
+
Description
+

Contains an array of roles.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items - [CompanyRole]! + A list of company roles that match the specified filter criteria.
page_info - SearchResultPageInfo + Pagination metadata.
total_count - Int! + The total number of objects matching the specified filter.
+
+
+
+
+
Example
+ 
{
+  "items": [CompanyRole],
+  "page_info": SearchResultPageInfo,
+  "total_count": 123
+}
+
+
+
+
+
+
+
+ Types +
+

CompanySalesRepresentative

+
+
+
+
Description
+

Contains details about a company sales representative.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
email - String + The email address of the company sales representative.
firstname - String + The company sales representative's first name.
lastname - String + The company sales representative's last name.
+
+
+
+
+
Example
+ 
{
+  "email": "xyz789",
+  "firstname": "abc123",
+  "lastname": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyStructure

+
+
+
+
Description
+

Contains an array of the individual nodes that comprise the company structure.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
items - [CompanyStructureItem] + An array of elements in a company structure.
+
+
+
+
+
Example
+ 
{"items": [CompanyStructureItem]}
+
+
+
+
+
+
+
+ Types +
+

CompanyStructureEntity

+
+
+
+
Types
+ + + + + + + + + + + + + + +
Union Types
+

CompanyTeam

+
+

Customer

+
+
+
+
+
+
Example
+ 
CompanyTeam
+
+
+
+
+
+
+
+ Types +
+

CompanyStructureItem

+
+
+
+
Description
+

Defines an individual node in the company structure.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
entity - CompanyStructureEntity + A union of CompanyTeam and Customer objects.
id - ID! + The unique ID for a CompanyStructureItem object.
parent_id - ID + The ID of the parent item in the company hierarchy.
+
+
+
+
+
Example
+ 
{"entity": CompanyTeam, "id": 4, "parent_id": 4}
+
+
+
+
+
+
+
+ Types +
+

CompanyStructureUpdateInput

+
+
+
+
Description
+

Defines the input schema for updating the company structure.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ parent_tree_id - ID! + The ID of a company that will be the new parent.
+ tree_id - ID! + The ID of the company team that is being moved to another parent.
+
+
+
+
+
Example
+ 
{"parent_tree_id": 4, "tree_id": "4"}
+
+
+
+
+
+
+
+ Types +
+

CompanyTeam

+
+
+
+
Description
+

Describes a company team.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
description - String + An optional description of the team.
id - ID + The unique ID for a CompanyTeam object.
name - String + The display name of the team.
structure_id - ID! + ID of the company structure
+
+
+
+
+
Example
+ 
{
+  "description": "abc123",
+  "id": "4",
+  "name": "xyz789",
+  "structure_id": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyTeamCreateInput

+
+
+
+
Description
+

Defines the input schema for creating a company team.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ description - String + An optional description of the team.
+ name - String! + The display name of the team.
+ target_id - ID + The ID of a node within a company's structure. This ID will be the parent of the created team.
+
+
+
+
+
Example
+ 
{
+  "description": "abc123",
+  "name": "xyz789",
+  "target_id": 4
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyTeamUpdateInput

+
+
+
+
Description
+

Defines the input schema for updating a company team.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ description - String + An optional description of the team.
+ id - ID! + The unique ID of the CompanyTeam object to update.
+ name - String + The display name of the team.
+
+
+
+
+
Example
+ 
{
+  "description": "abc123",
+  "id": "4",
+  "name": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyUpdateInput

+
+
+
+
Description
+

Defines the input schema for updating a company.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ company_email - String + The email address of the company contact.
+ company_name - String + The name of the company to update.
+ legal_address - CompanyLegalAddressUpdateInput + The legal address data of the company.
+ legal_name - String + The full legal name of the company.
+ reseller_id - String + The resale number that is assigned to the company for tax reporting purposes.
+ vat_tax_id - String + The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes.
+
+
+
+
+
Example
+ 
{
+  "company_email": "xyz789",
+  "company_name": "xyz789",
+  "legal_address": CompanyLegalAddressUpdateInput,
+  "legal_name": "xyz789",
+  "reseller_id": "abc123",
+  "vat_tax_id": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyUserCreateInput

+
+
+
+
Description
+

Defines the input schema for creating a company user.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ email - String! + The company user's email address
+ firstname - String! + The company user's first name.
+ job_title - String! + The company user's job title or function.
+ lastname - String! + The company user's last name.
+ role_id - ID! + The unique ID for a CompanyRole object.
+ status - CompanyUserStatusEnum! + Indicates whether the company user is ACTIVE or INACTIVE.
+ target_id - ID + The ID of a node within a company's structure. This ID will be the parent of the created company user.
+ telephone - String! + The company user's phone number.
+
+
+
+
+
Example
+ 
{
+  "email": "abc123",
+  "firstname": "abc123",
+  "job_title": "abc123",
+  "lastname": "xyz789",
+  "role_id": "4",
+  "status": "ACTIVE",
+  "target_id": "4",
+  "telephone": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyUserStatusEnum

+
+
+
+
Description
+

Defines the list of company user status values.

+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

ACTIVE

+ 		Only active users.
+

INACTIVE

+ 		Only inactive users.
+
+
+
+
+
Example
+ 
"ACTIVE"
+
+
+
+
+
+
+
+ Types +
+

CompanyUserUpdateInput

+
+
+
+
Description
+

Defines the input schema for updating a company user.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ email - String + The company user's email address.
+ firstname - String + The company user's first name.
+ id - ID! + The unique ID of a Customer object.
+ job_title - String + The company user's job title or function.
+ lastname - String + The company user's last name.
+ role_id - ID + The unique ID for a CompanyRole object.
+ status - CompanyUserStatusEnum + Indicates whether the company user is ACTIVE or INACTIVE.
+ telephone - String + The company user's phone number.
+
+
+
+
+
Example
+ 
{
+  "email": "xyz789",
+  "firstname": "abc123",
+  "id": 4,
+  "job_title": "xyz789",
+  "lastname": "xyz789",
+  "role_id": "4",
+  "status": "ACTIVE",
+  "telephone": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyUsers

+
+
+
+
Description
+

Contains details about company users.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items - [Customer]! + An array of CompanyUser objects that match the specified filter criteria.
page_info - SearchResultPageInfo + Pagination metadata.
total_count - Int! + The number of objects returned.
+
+
+
+
+
Example
+ 
{
+  "items": [Customer],
+  "page_info": SearchResultPageInfo,
+  "total_count": 987
+}
+
+
+
+
+
+
+
+ Types +
+

CompanyUsersFilterInput

+
+
+
+
Description
+

Defines the filter for returning a list of company users.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ status - CompanyUserStatusEnum + The activity status to filter on.
+
+
+
+
+
Example
+ 
{"status": "ACTIVE"}
+
+
+
+
+
+
+
+ Types +
+

ComparableAttribute

+
+
+
+
Description
+

Contains an attribute code that is used for product comparisons.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
code - String! + An attribute code that is enabled for product comparisons.
label - String! + The label of the attribute code.
+
+
+
+
+
Example
+ 
{
+  "code": "abc123",
+  "label": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

ComparableItem

+
+
+
+
Description
+

Defines an object used to iterate through items for product comparisons.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
attributes - [ProductAttribute]! + An array of product attributes that can be used to compare products.
product - ProductInterface! + Details about a product in a compare list.
uid - ID! + The unique ID of an item in a compare list.
+
+
+
+
+
Example
+ 
{
+  "attributes": [ProductAttribute],
+  "product": ProductInterface,
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

CompareList

+
+
+
+
Description
+

Contains iterable information such as the array of items, the count, and attributes that represent the compare list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
attributes - [ComparableAttribute] + An array of attributes that can be used for comparing products.
item_count - Int! + The number of items in the compare list.
items - [ComparableItem] + An array of products to compare.
uid - ID! + The unique ID assigned to the compare list.
+
+
+
+
+
Example
+ 
{
+  "attributes": [ComparableAttribute],
+  "item_count": 987,
+  "items": [ComparableItem],
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

CompleteOrderInput

+
+
+
+
Description
+

Update the quote and complete the order

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cartId - String! + The customer cart ID
+ id - String! + PayPal order ID
+
+
+
+
+
Example
+ 
{
+  "cartId": "xyz789",
+  "id": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

ComplexTextValue

+
+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
html - String! + Text that can contain HTML tags.
+
+
+
+
+
Example
+ 
{"html": "abc123"}
+
+
+
+
+
+
+
+ Types +
+

ConfigurableAttributeOption

+
+
+
+
Description
+

Contains details about a configurable product attribute option.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
code - String + The ID assigned to the attribute.
label - String + A string that describes the configurable attribute option.
uid - ID! + The unique ID for a ConfigurableAttributeOption object.
value_index - Int + A unique index number assigned to the configurable product option.
+
+
+
+
+
Example
+ 
{
+  "code": "abc123",
+  "label": "abc123",
+  "uid": "4",
+  "value_index": 987
+}
+
+
+
+
+
+
+
+ Types +
+

ConfigurableCartItem

+
+
+
+
Description
+

An implementation for configurable product cart items.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
available_gift_wrapping - [GiftWrapping]! + The list of available gift wrapping options for the cart item.
configurable_options - [SelectedConfigurableOption]! + An array containing the configuranle options the shopper selected.
configured_variant - ProductInterface! + Product details of the cart item.
customizable_options - [SelectedCustomizableOption]! + An array containing the customizable options the shopper selected.
discount - [Discount] + Contains discount for quote line item.
errors - [CartItemError] + An array of errors encountered while loading the cart item
gift_message - GiftMessage + The entered gift message for the cart item
gift_wrapping - GiftWrapping + The selected gift wrapping for the cart item.
id - String! + + Use uid instead. +
is_available - Boolean! + True if requested quantity is less than available stock, false otherwise.
max_qty - Float + Line item max qty in quote template
min_qty - Float + Line item min qty in quote template
not_available_message - String + Message to display when the product is not available with this selected option.
note_from_buyer - [ItemNote] + The buyer's quote line item note.
note_from_seller - [ItemNote] + The seller's quote line item note.
prices - CartItemPrices + Contains details about the price of the item, including taxes and discounts.
product - ProductInterface! + Details about an item in the cart.
quantity - Float! + The quantity of this item in the cart.
uid - ID! + The unique ID for a CartItemInterface object.
+
+
+
+
+
Example
+ 
{
+  "available_gift_wrapping": [GiftWrapping],
+  "configurable_options": [SelectedConfigurableOption],
+  "configured_variant": ProductInterface,
+  "customizable_options": [SelectedCustomizableOption],
+  "discount": [Discount],
+  "errors": [CartItemError],
+  "gift_message": GiftMessage,
+  "gift_wrapping": GiftWrapping,
+  "id": "xyz789",
+  "is_available": true,
+  "max_qty": 987.65,
+  "min_qty": 987.65,
+  "not_available_message": "abc123",
+  "note_from_buyer": [ItemNote],
+  "note_from_seller": [ItemNote],
+  "prices": CartItemPrices,
+  "product": ProductInterface,
+  "quantity": 987.65,
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

ConfigurableOptionAvailableForSelection

+
+
+
+
Description
+

Describes configurable options that have been selected and can be selected as a result of the previous selections.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
attribute_code - String! + An attribute code that uniquely identifies a configurable option.
option_value_uids - [ID]! + An array of selectable option value IDs.
+
+
+
+
+
Example
+ 
{
+  "attribute_code": "xyz789",
+  "option_value_uids": ["4"]
+}
+
+
+
+
+
+
+
+ Types +
+

ConfigurableOrderItem

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
discounts - [Discount] + The final discount information for the product.
eligible_for_return - Boolean + Indicates whether the order item is eligible to be in a return request.
entered_options - [OrderItemOption] + The entered option for the base product, such as a logo or image.
gift_message - GiftMessage + The selected gift message for the order item
gift_wrapping - GiftWrapping + The selected gift wrapping for the order item.
id - ID! + The unique ID for an OrderItemInterface object.
parent_sku - String + The SKU of parent product.
prices - OrderItemPrices + Contains details about the price of the item, including taxes and discounts.
product - ProductInterface + The ProductInterface object, which contains details about the base product
product_name - String + The name of the base product.
product_sale_price - Money! + The sale price of the base product, including selected options.
product_sku - String! + The SKU of the base product.
product_type - String + The type of product, such as simple, configurable, etc.
product_url_key - String + URL key of the base product.
quantity_canceled - Float + The number of canceled items.
quantity_invoiced - Float + The number of invoiced items.
quantity_ordered - Float + The number of units ordered for this item.
quantity_refunded - Float + The number of refunded items.
quantity_return_requested - Float + The requested return quantity of the item.
quantity_returned - Float + The number of returned items.
quantity_shipped - Float + The number of shipped items.
selected_options - [OrderItemOption] + The selected options for the base product, such as color or size.
status - String + The status of the order item.
+
+
+
+
+
Example
+ 
{
+  "discounts": [Discount],
+  "eligible_for_return": true,
+  "entered_options": [OrderItemOption],
+  "gift_message": GiftMessage,
+  "gift_wrapping": GiftWrapping,
+  "id": "4",
+  "parent_sku": "xyz789",
+  "prices": OrderItemPrices,
+  "product": ProductInterface,
+  "product_name": "xyz789",
+  "product_sale_price": Money,
+  "product_sku": "xyz789",
+  "product_type": "xyz789",
+  "product_url_key": "xyz789",
+  "quantity_canceled": 987.65,
+  "quantity_invoiced": 987.65,
+  "quantity_ordered": 987.65,
+  "quantity_refunded": 987.65,
+  "quantity_return_requested": 987.65,
+  "quantity_returned": 987.65,
+  "quantity_shipped": 123.45,
+  "selected_options": [OrderItemOption],
+  "status": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

ConfigurableProduct

+
+
+
+
Description
+

Defines basic features of a configurable product and its simple product variants.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
activity - String + + Use the custom_attributes field instead. +
attribute_set_id - Int + The attribute set assigned to the product. The field should not be used on the storefront. +
canonical_url - String + The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface] + The categories assigned to a product.
category_gear - String + + Use the custom_attributes field instead. +
climate - String + + Use the custom_attributes field instead. +
collar - String + + Use the custom_attributes field instead. +
color - Int + + Use the custom_attributes field instead. +
configurable_options - [ConfigurableProductOptions] + An array of options for the configurable product.
configurable_product_options_selection - ConfigurableProductOptionsSelection + An array of media gallery items and other details about selected configurable product options as well as details about remaining selectable options.
+
+
Arguments
+
+
+
configurableOptionValueUids - [ID!] +
+
+
+
+
country_of_manufacture - String + The product's country of origin.
created_at - String + Timestamp indicating when the product was created. The field should not be used on the storefront. +
crosssell_products - [ProductInterface] + An array of cross-sell products.
custom_attributesV2 - ProductCustomAttributes + Product custom attributes.
+
+
Arguments
+
+
+
filters - AttributeFilterInput +
+
+
+
+
description - ComplexTextValue + Detailed information about the product. The value can include simple HTML tags.
eco_collection - Int + + Use the custom_attributes field instead. +
erin_recommends - Int + + Use the custom_attributes field instead. +
features_bags - String + + Use the custom_attributes field instead. +
format - Int + + Use the custom_attributes field instead. +
gender - String + + Use the custom_attributes field instead. +
gift_message_available - Boolean! + Returns a value indicating gift message availability for the product.
gift_wrapping_available - Boolean! + Returns a value indicating gift wrapping availability for the product.
gift_wrapping_price - Money + Returns value and currency indicating gift wrapping price for the product.
id - Int + The ID number assigned to the product. Use the uid field instead. +
image - ProductImage + The relative path to the main image on the product page.
is_returnable - String + Indicates whether the product can be returned.
manufacturer - Int + A number representing the product's manufacturer. Use the custom_attributes field instead. +
material - String + + Use the custom_attributes field instead. +
max_sale_qty - Float + Maximum Qty Allowed in Shopping Cart
media_gallery - [MediaGalleryInterface] + An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry] + An array of MediaGalleryEntry objects. Use media_gallery instead. +
meta_description - String + A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String + A comma-separated list of keywords that are visible only to search engines.
meta_title - String + A string that is displayed in the title bar and tab of the browser and in search results lists.
min_sale_qty - Float + Minimum Qty Allowed in Shopping Cart
name - String + The product name. Customers use this name to identify the product.
new - Int + + Use the custom_attributes field instead. +
new_from_date - String + The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String + The end date for new product listings.
only_x_left_in_stock - Float + Product stock only x left count
options - [CustomizableOptionInterface] + An array of options for a customizable product.
options_container - String + If the product has multiple options, determines where they appear on the product page.
pattern - String + + Use the custom_attributes field instead. +
performance_fabric - Int + + Use the custom_attributes field instead. +
price - ProductPrices + Indicates the price of an item. Use price_range for product price information. +
price_range - PriceRange! + The range of prices for the product
price_tiers - [TierPrice] + An array of TierPrice objects.
product_links - [ProductLinksInterface] + An array of ProductLinks objects.
purpose - Int + + Use the custom_attributes field instead. +
quantity - Float + Amount of available stock
rating_summary - Float! + The average of all the ratings given to the product.
redirect_code - Int! + Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface] + An array of related products.
relative_url - String + The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int! + The total count of all the reviews given to the product.
reviews - ProductReviews! + The list of products reviews.
+
+
Arguments
+
+
+
pageSize - Int +
+

The maximum number of results to return at once. The default is 20.

+
+
+
currentPage - Int +
+

The page of results to return. The default is 1.

+
+
+
+
sale - Int + + Use the custom_attributes field instead. +
short_description - ComplexTextValue + A short description of the product. Its use depends on the theme.
size - Int + + Use the custom_attributes field instead. +
sku - String + A number or code assigned to a product to identify the product, options, price, and manufacturer.
sleeve - String + + Use the custom_attributes field instead. +
small_image - ProductImage + The relative path to the small image, which is used on catalog pages.
special_from_date - String + The beginning date that a product has a special price. The field should not be used on the storefront. +
special_price - Float + The discounted price of the product.
special_to_date - String + The end date for a product with a special price.
staged - Boolean! + Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus + Stock status of the product
strap_bags - String + + Use the custom_attributes field instead. +
style_bags - String + + Use the custom_attributes field instead. +
style_bottom - String + + Use the custom_attributes field instead. +
style_general - String + + Use the custom_attributes field instead. +
swatch_image - String + The file name of a swatch image.
thumbnail - ProductImage + The relative path to the product's thumbnail image.
tier_price - Float + The price when tier pricing is in effect and the items purchased threshold has been reached. Use price_tiers for product tier price information. +
tier_prices - [ProductTierPrices] + An array of ProductTierPrices objects. Use price_tiers for product tier price information. +
type - UrlRewriteEntityTypeEnum + One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String + One of simple, virtual, bundle, downloadable, grouped, or configurable. Use __typename instead. +
uid - ID! + The unique ID for a ProductInterface object.
updated_at - String + Timestamp indicating when the product was updated. The field should not be used on the storefront. +
upsell_products - [ProductInterface] + An array of up-sell products.
url_key - String + The part of the URL that identifies the product
url_path - String + + Use product's canonical_url or url rewrites instead +
url_rewrites - [UrlRewrite] + URL rewrites list
url_suffix - String + The part of the product URL that is appended after the url key
variants - [ConfigurableVariant] + An array of simple product variants.
websites - [Website] + An array of websites in which the product is available. The field should not be used on the storefront. +
weight - Float + The weight of the item, in units defined by the store.
+
+
+
+
+
Example
+ 
{
+  "activity": "xyz789",
+  "attribute_set_id": 987,
+  "canonical_url": "xyz789",
+  "categories": [CategoryInterface],
+  "category_gear": "abc123",
+  "climate": "xyz789",
+  "collar": "xyz789",
+  "color": 123,
+  "configurable_options": [ConfigurableProductOptions],
+  "configurable_product_options_selection": ConfigurableProductOptionsSelection,
+  "country_of_manufacture": "abc123",
+  "created_at": "xyz789",
+  "crosssell_products": [ProductInterface],
+  "custom_attributesV2": ProductCustomAttributes,
+  "description": ComplexTextValue,
+  "eco_collection": 987,
+  "erin_recommends": 123,
+  "features_bags": "xyz789",
+  "format": 123,
+  "gender": "xyz789",
+  "gift_message_available": true,
+  "gift_wrapping_available": true,
+  "gift_wrapping_price": Money,
+  "id": 123,
+  "image": ProductImage,
+  "is_returnable": "xyz789",
+  "manufacturer": 987,
+  "material": "xyz789",
+  "max_sale_qty": 123.45,
+  "media_gallery": [MediaGalleryInterface],
+  "media_gallery_entries": [MediaGalleryEntry],
+  "meta_description": "abc123",
+  "meta_keyword": "abc123",
+  "meta_title": "xyz789",
+  "min_sale_qty": 123.45,
+  "name": "xyz789",
+  "new": 123,
+  "new_from_date": "abc123",
+  "new_to_date": "abc123",
+  "only_x_left_in_stock": 987.65,
+  "options": [CustomizableOptionInterface],
+  "options_container": "xyz789",
+  "pattern": "xyz789",
+  "performance_fabric": 123,
+  "price": ProductPrices,
+  "price_range": PriceRange,
+  "price_tiers": [TierPrice],
+  "product_links": [ProductLinksInterface],
+  "purpose": 987,
+  "quantity": 123.45,
+  "rating_summary": 123.45,
+  "redirect_code": 123,
+  "related_products": [ProductInterface],
+  "relative_url": "xyz789",
+  "review_count": 123,
+  "reviews": ProductReviews,
+  "sale": 123,
+  "short_description": ComplexTextValue,
+  "size": 123,
+  "sku": "xyz789",
+  "sleeve": "abc123",
+  "small_image": ProductImage,
+  "special_from_date": "xyz789",
+  "special_price": 123.45,
+  "special_to_date": "xyz789",
+  "staged": true,
+  "stock_status": "IN_STOCK",
+  "strap_bags": "xyz789",
+  "style_bags": "abc123",
+  "style_bottom": "xyz789",
+  "style_general": "xyz789",
+  "swatch_image": "abc123",
+  "thumbnail": ProductImage,
+  "tier_price": 987.65,
+  "tier_prices": [ProductTierPrices],
+  "type": "CMS_PAGE",
+  "type_id": "xyz789",
+  "uid": 4,
+  "updated_at": "abc123",
+  "upsell_products": [ProductInterface],
+  "url_key": "abc123",
+  "url_path": "xyz789",
+  "url_rewrites": [UrlRewrite],
+  "url_suffix": "xyz789",
+  "variants": [ConfigurableVariant],
+  "websites": [Website],
+  "weight": 987.65
+}
+
+
+
+
+
+
+
+ Types +
+

ConfigurableProductCartItemInput

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ customizable_options - [CustomizableOptionInput] + The ID and value of the option.
+ data - CartItemInput! + The quantity and SKU of the configurable product.
+ parent_sku - String + The SKU of the parent configurable product.
+ variant_sku - String + +
+
+
+
+
+
Example
+ 
{
+  "customizable_options": [CustomizableOptionInput],
+  "data": CartItemInput,
+  "parent_sku": "xyz789",
+  "variant_sku": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

ConfigurableProductOption

+
+
+
+
Description
+

Contains details about configurable product options.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
attribute_code - String! + An attribute code that uniquely identifies a configurable option.
label - String! + The display name of the option.
uid - ID! + The unique ID of the configurable option.
values - [ConfigurableProductOptionValue] + An array of values that are applicable for this option.
+
+
+
+
+
Example
+ 
{
+  "attribute_code": "abc123",
+  "label": "xyz789",
+  "uid": 4,
+  "values": [ConfigurableProductOptionValue]
+}
+
+
+
+
+
+
+
+ Types +
+

ConfigurableProductOptionValue

+
+
+
+
Description
+

Defines a value for a configurable product option.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
is_available - Boolean! + Indicates whether the product is available with this selected option.
is_use_default - Boolean! + Indicates whether the value is the default.
label - String! + The display name of the value.
swatch - SwatchDataInterface + The URL assigned to the thumbnail of the swatch image.
uid - ID! + The unique ID of the value.
+
+
+
+
+
Example
+ 
{
+  "is_available": false,
+  "is_use_default": true,
+  "label": "xyz789",
+  "swatch": SwatchDataInterface,
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

ConfigurableProductOptions

+
+
+
+
Description
+

Defines configurable attributes for the specified product.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
attribute_code - String + A string that identifies the attribute.
attribute_id - String + The ID assigned to the attribute. Use attribute_uid instead. +
attribute_id_v2 - Int + The ID assigned to the attribute. Use attribute_uid instead. +
attribute_uid - ID! + The unique ID for an Attribute object.
id - Int + The configurable option ID number assigned by the system. Use uid instead. +
label - String + A displayed string that describes the configurable product option.
position - Int + A number that indicates the order in which the attribute is displayed.
product_id - Int + This is the same as a product's id field. product_id is not needed and can be obtained from its parent. +
uid - ID! + The unique ID for a ConfigurableProductOptions object.
use_default - Boolean + Indicates whether the option is the default.
values - [ConfigurableProductOptionsValues] + An array that defines the value_index codes assigned to the configurable product.
+
+
+
+
+
Example
+ 
{
+  "attribute_code": "abc123",
+  "attribute_id": "xyz789",
+  "attribute_id_v2": 123,
+  "attribute_uid": "4",
+  "id": 123,
+  "label": "abc123",
+  "position": 987,
+  "product_id": 123,
+  "uid": 4,
+  "use_default": false,
+  "values": [ConfigurableProductOptionsValues]
+}
+
+
+
+
+
+
+
+ Types +
+

ConfigurableProductOptionsSelection

+
+
+
+
Description
+

Contains metadata corresponding to the selected configurable options.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
configurable_options - [ConfigurableProductOption] + An array of all possible configurable options.
media_gallery - [MediaGalleryInterface] + Product images and videos corresponding to the specified configurable options selection.
options_available_for_selection - [ConfigurableOptionAvailableForSelection] + The configurable options available for further selection based on the current selection.
variant - SimpleProduct + A variant represented by the specified configurable options selection. The value is expected to be null until selections are made for each configurable option.
+
+
+
+
+
Example
+ 
{
+  "configurable_options": [ConfigurableProductOption],
+  "media_gallery": [MediaGalleryInterface],
+  "options_available_for_selection": [
+    ConfigurableOptionAvailableForSelection
+  ],
+  "variant": SimpleProduct
+}
+
+
+
+
+
+
+
+ Types +
+

ConfigurableProductOptionsValues

+
+
+
+
Description
+

Contains the index number assigned to a configurable product option.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
default_label - String + The label of the product on the default store.
label - String + The label of the product.
store_label - String + The label of the product on the current store.
swatch_data - SwatchDataInterface + Swatch data for a configurable product option.
uid - ID + The unique ID for a ConfigurableProductOptionsValues object.
use_default_value - Boolean + Indicates whether to use the default_label.
value_index - Int + A unique index number assigned to the configurable product option. Use uid instead. +
+
+
+
+
+
Example
+ 
{
+  "default_label": "abc123",
+  "label": "xyz789",
+  "store_label": "abc123",
+  "swatch_data": SwatchDataInterface,
+  "uid": "4",
+  "use_default_value": true,
+  "value_index": 123
+}
+
+
+
+
+
+
+
+ Types +
+

ConfigurableRequisitionListItem

+
+
+
+
Description
+

Contains details about configurable products added to a requisition list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
configurable_options - [SelectedConfigurableOption] + Selected configurable options for an item in the requisition list.
customizable_options - [SelectedCustomizableOption]! + Selected custom options for an item in the requisition list.
product - ProductInterface! + Details about a requisition list item.
quantity - Float! + The quantity of the product added to the requisition list.
uid - ID! + The unique ID of an item in a requisition list.
+
+
+
+
+
Example
+ 
{
+  "configurable_options": [SelectedConfigurableOption],
+  "customizable_options": [SelectedCustomizableOption],
+  "product": ProductInterface,
+  "quantity": 987.65,
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

ConfigurableVariant

+
+
+
+
Description
+

Contains all the simple product variants of a configurable product.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
attributes - [ConfigurableAttributeOption] + An array of configurable attribute options.
product - SimpleProduct + An array of linked simple products.
+
+
+
+
+
Example
+ 
{
+  "attributes": [ConfigurableAttributeOption],
+  "product": SimpleProduct
+}
+
+
+
+
+
+
+
+ Types +
+

ConfigurableWishlistItem

+
+
+
+
Description
+

A configurable product wish list item.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
added_at - String! + The date and time the item was added to the wish list.
child_sku - String! + The SKU of the simple product corresponding to a set of selected configurable options. Use ConfigurableWishlistItem.configured_variant.sku instead. +
configurable_options - [SelectedConfigurableOption] + An array of selected configurable options.
configured_variant - ProductInterface + Product details of the selected variant. The value is null if some options are not configured.
customizable_options - [SelectedCustomizableOption]! + Custom options selected for the wish list item.
description - String + The description of the item.
id - ID! + The unique ID for a WishlistItemInterface object.
product - ProductInterface + Product details of the wish list item.
quantity - Float! + The quantity of this wish list item.
+
+
+
+
+
Example
+ 
{
+  "added_at": "xyz789",
+  "child_sku": "abc123",
+  "configurable_options": [SelectedConfigurableOption],
+  "configured_variant": ProductInterface,
+  "customizable_options": [SelectedCustomizableOption],
+  "description": "xyz789",
+  "id": "4",
+  "product": ProductInterface,
+  "quantity": 987.65
+}
+
+
+
+
+
+
+
+ Types +
+

ConfirmCancelOrderInput

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ confirmation_key - String! + Confirmation Key to cancel the order.
+ order_id - ID! + The unique ID of an Order type.
+
+
+
+
+
Example
+ 
{
+  "confirmation_key": "xyz789",
+  "order_id": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

ConfirmEmailInput

+
+
+
+
Description
+

Contains details about a customer email address to confirm.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ confirmation_key - String! + The key to confirm the email address.
+ email - String! + The email address to be confirmed.
+
+
+
+
+
Example
+ 
{
+  "confirmation_key": "xyz789",
+  "email": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

ConfirmReturnInput

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ confirmation_key - String! + Confirmation Key to return order.
+ order_id - ID! + The unique ID of an Order type.
+
+
+
+
+
Example
+ 
{
+  "confirmation_key": "abc123",
+  "order_id": 4
+}
+
+
+
+
+
+
+
+ Types +
+

ConfirmationStatusEnum

+
+
+
+
Description
+

List of account confirmation statuses.

+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

ACCOUNT_CONFIRMED

+ 		Account confirmed
+

ACCOUNT_CONFIRMATION_NOT_REQUIRED

+ 		Account confirmation not required
+
+
+
+
+
Example
+ 
"ACCOUNT_CONFIRMED"
+
+
+
+
+
+
+
+ Types +
+

ContactUsInput

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ comment - String! + The shopper's comment to the merchant.
+ email - String! + The email address of the shopper.
+ name - String! + The full name of the shopper.
+ telephone - String + The shopper's telephone number.
+
+
+
+
+
Example
+ 
{
+  "comment": "xyz789",
+  "email": "abc123",
+  "name": "xyz789",
+  "telephone": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

ContactUsOutput

+
+
+
+
Description
+

Contains the status of the request.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
status - Boolean! + Indicates whether the request was successful.
+
+
+
+
+
Example
+ 
{"status": true}
+
+
+
+
+
+
+
+ Types +
+

CopyItemsBetweenRequisitionListsInput

+
+
+
+
Description
+

An input object that defines the items in a requisition list to be copied.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ requisitionListItemUids - [ID]! + An array of IDs representing products copied from one requisition list to another.
+
+
+
+
+
Example
+ 
{"requisitionListItemUids": ["4"]}
+
+
+
+
+
+
+
+ Types +
+

CopyItemsFromRequisitionListsOutput

+
+
+
+
Description
+

Output of the request to copy items to the destination requisition list.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
requisition_list - RequisitionList + The destination requisition list after the items were copied.
+
+
+
+
+
Example
+ 
{"requisition_list": RequisitionList}
+
+
+
+
+
+
+
+ Types +
+

CopyProductsBetweenWishlistsOutput

+
+
+
+
Description
+

Contains the source and target wish lists after copying products.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
destination_wishlist - Wishlist! + The destination wish list containing the copied products.
source_wishlist - Wishlist! + The wish list that the products were copied from.
user_errors - [WishListUserInputError]! + An array of errors encountered while copying products in a wish list.
+
+
+
+
+
Example
+ 
{
+  "destination_wishlist": Wishlist,
+  "source_wishlist": Wishlist,
+  "user_errors": [WishListUserInputError]
+}
+
+
+
+
+
+
+
+ Types +
+

Country

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
available_regions - [Region] + An array of regions within a particular country.
full_name_english - String + The name of the country in English.
full_name_locale - String + The name of the country in the current locale.
id - String + The unique ID for a Country object.
three_letter_abbreviation - String + The three-letter abbreviation of the country, such as USA.
two_letter_abbreviation - String + The two-letter abbreviation of the country, such as US.
+
+
+
+
+
Example
+ 
{
+  "available_regions": [Region],
+  "full_name_english": "xyz789",
+  "full_name_locale": "abc123",
+  "id": "xyz789",
+  "three_letter_abbreviation": "xyz789",
+  "two_letter_abbreviation": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CountryCodeEnum

+
+
+
+
Description
+

The list of country codes.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

AF

+ 		Afghanistan
+

AX

+ 		Åland Islands
+

AL

+ 		Albania
+

DZ

+ 		Algeria
+

AS

+ 		American Samoa
+

AD

+ 		Andorra
+

AO

+ 		Angola
+

AI

+ 		Anguilla
+

AQ

+ 		Antarctica
+

AG

+ 		Antigua & Barbuda
+

AR

+ 		Argentina
+

AM

+ 		Armenia
+

AW

+ 		Aruba
+

AU

+ 		Australia
+

AT

+ 		Austria
+

AZ

+ 		Azerbaijan
+

BS

+ 		Bahamas
+

BH

+ 		Bahrain
+

BD

+ 		Bangladesh
+

BB

+ 		Barbados
+

BY

+ 		Belarus
+

BE

+ 		Belgium
+

BZ

+ 		Belize
+

BJ

+ 		Benin
+

BM

+ 		Bermuda
+

BT

+ 		Bhutan
+

BO

+ 		Bolivia
+

BA

+ 		Bosnia & Herzegovina
+

BW

+ 		Botswana
+

BV

+ 		Bouvet Island
+

BR

+ 		Brazil
+

IO

+ 		British Indian Ocean Territory
+

VG

+ 		British Virgin Islands
+

BN

+ 		Brunei
+

BG

+ 		Bulgaria
+

BF

+ 		Burkina Faso
+

BI

+ 		Burundi
+

KH

+ 		Cambodia
+

CM

+ 		Cameroon
+

CA

+ 		Canada
+

CV

+ 		Cape Verde
+

KY

+ 		Cayman Islands
+

CF

+ 		Central African Republic
+

TD

+ 		Chad
+

CL

+ 		Chile
+

CN

+ 		China
+

CX

+ 		Christmas Island
+

CC

+ 		Cocos (Keeling) Islands
+

CO

+ 		Colombia
+

KM

+ 		Comoros
+

CG

+ 		Congo-Brazzaville
+

CD

+ 		Congo-Kinshasa
+

CK

+ 		Cook Islands
+

CR

+ 		Costa Rica
+

CI

+ 		Côte d’Ivoire
+

HR

+ 		Croatia
+

CU

+ 		Cuba
+

CY

+ 		Cyprus
+

CZ

+ 		Czech Republic
+

DK

+ 		Denmark
+

DJ

+ 		Djibouti
+

DM

+ 		Dominica
+

DO

+ 		Dominican Republic
+

EC

+ 		Ecuador
+

EG

+ 		Egypt
+

SV

+ 		El Salvador
+

GQ

+ 		Equatorial Guinea
+

ER

+ 		Eritrea
+

EE

+ 		Estonia
+

SZ

+ 		Eswatini
+

ET

+ 		Ethiopia
+

FK

+ 		Falkland Islands
+

FO

+ 		Faroe Islands
+

FJ

+ 		Fiji
+

FI

+ 		Finland
+

FR

+ 		France
+

GF

+ 		French Guiana
+

PF

+ 		French Polynesia
+

TF

+ 		French Southern Territories
+

GA

+ 		Gabon
+

GM

+ 		Gambia
+

GE

+ 		Georgia
+

DE

+ 		Germany
+

GH

+ 		Ghana
+

GI

+ 		Gibraltar
+

GR

+ 		Greece
+

GL

+ 		Greenland
+

GD

+ 		Grenada
+

GP

+ 		Guadeloupe
+

GU

+ 		Guam
+

GT

+ 		Guatemala
+

GG

+ 		Guernsey
+

GN

+ 		Guinea
+

GW

+ 		Guinea-Bissau
+

GY

+ 		Guyana
+

HT

+ 		Haiti
+

HM

+ 		Heard & McDonald Islands
+

HN

+ 		Honduras
+

HK

+ 		Hong Kong SAR China
+

HU

+ 		Hungary
+

IS

+ 		Iceland
+

IN

+ 		India
+

ID

+ 		Indonesia
+

IR

+ 		Iran
+

IQ

+ 		Iraq
+

IE

+ 		Ireland
+

IM

+ 		Isle of Man
+

IL

+ 		Israel
+

IT

+ 		Italy
+

JM

+ 		Jamaica
+

JP

+ 		Japan
+

JE

+ 		Jersey
+

JO

+ 		Jordan
+

KZ

+ 		Kazakhstan
+

KE

+ 		Kenya
+

KI

+ 		Kiribati
+

KW

+ 		Kuwait
+

KG

+ 		Kyrgyzstan
+

LA

+ 		Laos
+

LV

+ 		Latvia
+

LB

+ 		Lebanon
+

LS

+ 		Lesotho
+

LR

+ 		Liberia
+

LY

+ 		Libya
+

LI

+ 		Liechtenstein
+

LT

+ 		Lithuania
+

LU

+ 		Luxembourg
+

MO

+ 		Macau SAR China
+

MK

+ 		Macedonia
+

MG

+ 		Madagascar
+

MW

+ 		Malawi
+

MY

+ 		Malaysia
+

MV

+ 		Maldives
+

ML

+ 		Mali
+

MT

+ 		Malta
+

MH

+ 		Marshall Islands
+

MQ

+ 		Martinique
+

MR

+ 		Mauritania
+

MU

+ 		Mauritius
+

YT

+ 		Mayotte
+

MX

+ 		Mexico
+

FM

+ 		Micronesia
+

MD

+ 		Moldova
+

MC

+ 		Monaco
+

MN

+ 		Mongolia
+

ME

+ 		Montenegro
+

MS

+ 		Montserrat
+

MA

+ 		Morocco
+

MZ

+ 		Mozambique
+

MM

+ 		Myanmar (Burma)
+

NA

+ 		Namibia
+

NR

+ 		Nauru
+

NP

+ 		Nepal
+

NL

+ 		Netherlands
+

AN

+ 		Netherlands Antilles
+

NC

+ 		New Caledonia
+

NZ

+ 		New Zealand
+

NI

+ 		Nicaragua
+

NE

+ 		Niger
+

NG

+ 		Nigeria
+

NU

+ 		Niue
+

NF

+ 		Norfolk Island
+

MP

+ 		Northern Mariana Islands
+

KP

+ 		North Korea
+

NO

+ 		Norway
+

OM

+ 		Oman
+

PK

+ 		Pakistan
+

PW

+ 		Palau
+

PS

+ 		Palestinian Territories
+

PA

+ 		Panama
+

PG

+ 		Papua New Guinea
+

PY

+ 		Paraguay
+

PE

+ 		Peru
+

PH

+ 		Philippines
+

PN

+ 		Pitcairn Islands
+

PL

+ 		Poland
+

PT

+ 		Portugal
+

QA

+ 		Qatar
+

RE

+ 		Réunion
+

RO

+ 		Romania
+

RU

+ 		Russia
+

RW

+ 		Rwanda
+

WS

+ 		Samoa
+

SM

+ 		San Marino
+

ST

+ 		São Tomé & Príncipe
+

SA

+ 		Saudi Arabia
+

SN

+ 		Senegal
+

RS

+ 		Serbia
+

SC

+ 		Seychelles
+

SL

+ 		Sierra Leone
+

SG

+ 		Singapore
+

SK

+ 		Slovakia
+

SI

+ 		Slovenia
+

SB

+ 		Solomon Islands
+

SO

+ 		Somalia
+

ZA

+ 		South Africa
+

GS

+ 		South Georgia & South Sandwich Islands
+

KR

+ 		South Korea
+

ES

+ 		Spain
+

LK

+ 		Sri Lanka
+

BL

+ 		St. Barthélemy
+

SH

+ 		St. Helena
+

KN

+ 		St. Kitts & Nevis
+

LC

+ 		St. Lucia
+

MF

+ 		St. Martin
+

PM

+ 		St. Pierre & Miquelon
+

VC

+ 		St. Vincent & Grenadines
+

SD

+ 		Sudan
+

SR

+ 		Suriname
+

SJ

+ 		Svalbard & Jan Mayen
+

SE

+ 		Sweden
+

CH

+ 		Switzerland
+

SY

+ 		Syria
+

TW

+ 		Taiwan
+

TJ

+ 		Tajikistan
+

TZ

+ 		Tanzania
+

TH

+ 		Thailand
+

TL

+ 		Timor-Leste
+

TG

+ 		Togo
+

TK

+ 		Tokelau
+

TO

+ 		Tonga
+

TT

+ 		Trinidad & Tobago
+

TN

+ 		Tunisia
+

TR

+ 		Turkey
+

TM

+ 		Turkmenistan
+

TC

+ 		Turks & Caicos Islands
+

TV

+ 		Tuvalu
+

UG

+ 		Uganda
+

UA

+ 		Ukraine
+

AE

+ 		United Arab Emirates
+

GB

+ 		United Kingdom
+

US

+ 		United States
+

UY

+ 		Uruguay
+

UM

+ 		U.S. Outlying Islands
+

VI

+ 		U.S. Virgin Islands
+

UZ

+ 		Uzbekistan
+

VU

+ 		Vanuatu
+

VA

+ 		Vatican City
+

VE

+ 		Venezuela
+

VN

+ 		Vietnam
+

WF

+ 		Wallis & Futuna
+

EH

+ 		Western Sahara
+

YE

+ 		Yemen
+

ZM

+ 		Zambia
+

ZW

+ 		Zimbabwe
+
+
+
+
+
Example
+ 
"AF"
+
+
+
+
+
+
+
+ Types +
+

CreateCompanyOutput

+
+
+
+
Description
+

Contains the response to the request to create a company.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
company - Company! + The new company instance.
+
+
+
+
+
Example
+ 
{"company": Company}
+
+
+
+
+
+
+
+ Types +
+

CreateCompanyRoleOutput

+
+
+
+
Description
+

Contains the response to the request to create a company role.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
role - CompanyRole! + The new company role instance.
+
+
+
+
+
Example
+ 
{"role": CompanyRole}
+
+
+
+
+
+
+
+ Types +
+

CreateCompanyTeamOutput

+
+
+
+
Description
+

Contains the response to the request to create a company team.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
team - CompanyTeam! + The new company team instance.
+
+
+
+
+
Example
+ 
{"team": CompanyTeam}
+
+
+
+
+
+
+
+ Types +
+

CreateCompanyUserOutput

+
+
+
+
Description
+

Contains the response to the request to create a company user.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
user - Customer! + The new company user instance.
+
+
+
+
+
Example
+ 
{"user": Customer}
+
+
+
+
+
+
+
+ Types +
+

CreateCompareListInput

+
+
+
+
Description
+

Contains an array of product IDs to use for creating a compare list.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ products - [ID] + An array of product IDs to add to the compare list.
+
+
+
+
+
Example
+ 
{"products": ["4"]}
+
+
+
+
+
+
+
+ Types +
+

CreateGiftRegistryInput

+
+
+
+
Description
+

Defines a new gift registry.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ dynamic_attributes - [GiftRegistryDynamicAttributeInput] + Additional attributes specified as a code-value pair.
+ event_name - String! + The name of the event.
+ gift_registry_type_uid - ID! + The ID of the selected event type.
+ message - String! + A message describing the event.
+ privacy_settings - GiftRegistryPrivacySettings! + Indicates whether the registry is PRIVATE or PUBLIC.
+ registrants - [AddGiftRegistryRegistrantInput]! + The list of people who receive notifications about the registry.
+ shipping_address - GiftRegistryShippingAddressInput + The shipping address for all gift registry items.
+ status - GiftRegistryStatus! + Indicates whether the registry is ACTIVE or INACTIVE.
+
+
+
+
+
Example
+ 
{
+  "dynamic_attributes": [
+    GiftRegistryDynamicAttributeInput
+  ],
+  "event_name": "xyz789",
+  "gift_registry_type_uid": 4,
+  "message": "abc123",
+  "privacy_settings": "PRIVATE",
+  "registrants": [AddGiftRegistryRegistrantInput],
+  "shipping_address": GiftRegistryShippingAddressInput,
+  "status": "ACTIVE"
+}
+
+
+
+
+
+
+
+ Types +
+

CreateGiftRegistryOutput

+
+
+
+
Description
+

Contains the results of a request to create a gift registry.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
gift_registry - GiftRegistry + The newly-created gift registry.
+
+
+
+
+
Example
+ 
{"gift_registry": GiftRegistry}
+
+
+
+
+
+
+
+ Types +
+

CreateGuestCartInput

+
+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ cart_uid - ID + Optional client-generated ID
+
+
+
+
+
Example
+ 
{"cart_uid": 4}
+
+
+
+
+
+
+
+ Types +
+

CreateGuestCartOutput

+
+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart + The newly created cart.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

CreatePayflowProTokenOutput

+
+
+
+
Description
+

Contains the secure information used to authorize transaction. Applies to Payflow Pro and Payments Pro payment methods.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
response_message - String! + The RESPMSG returned by PayPal. If the result is 0, then response_message is Approved.
result - Int! + A non-zero value if any errors occurred.
result_code - Int! + The RESULT returned by PayPal. A value of 0 indicates the transaction was approved.
secure_token - String! + A secure token generated by PayPal.
secure_token_id - String! + A secure token ID generated by PayPal.
+
+
+
+
+
Example
+ 
{
+  "response_message": "xyz789",
+  "result": 123,
+  "result_code": 987,
+  "secure_token": "xyz789",
+  "secure_token_id": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

CreatePaymentOrderInput

+
+
+
+
Description
+

Contains payment order details that are used while processing the payment order

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cartId - String! + The customer cart ID
+ location - PaymentLocation! + Defines the origin location for that payment request
+ methodCode - String! + The code for the payment method used in the order
+ paymentSource - String! + The identifiable payment source for the payment method
+ vaultIntent - Boolean + Indicates whether the payment information should be vaulted
+
+
+
+
+
Example
+ 
{
+  "cartId": "xyz789",
+  "location": "PRODUCT_DETAIL",
+  "methodCode": "abc123",
+  "paymentSource": "abc123",
+  "vaultIntent": false
+}
+
+
+
+
+
+
+
+ Types +
+

CreatePaymentOrderOutput

+
+
+
+
Description
+

Contains payment order details that are used while processing the payment order

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
amount - Float + The amount of the payment order
currency_code - String + The currency of the payment order
id - String + PayPal order ID
mp_order_id - String + The order ID generated by Payment Services
status - String + The status of the payment order
+
+
+
+
+
Example
+ 
{
+  "amount": 123.45,
+  "currency_code": "xyz789",
+  "id": "xyz789",
+  "mp_order_id": "xyz789",
+  "status": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CreateProductReviewInput

+
+
+
+
Description
+

Defines a new product review.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ nickname - String! + The customer's nickname. Defaults to the customer name, if logged in.
+ ratings - [ProductReviewRatingInput]! + The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc.
+ sku - String! + The SKU of the reviewed product.
+ summary - String! + The summary (title) of the review.
+ text - String! + The review text.
+
+
+
+
+
Example
+ 
{
+  "nickname": "abc123",
+  "ratings": [ProductReviewRatingInput],
+  "sku": "xyz789",
+  "summary": "xyz789",
+  "text": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

CreateProductReviewOutput

+
+
+
+
Description
+

Contains the completed product review.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
review - ProductReview! + Product review details.
+
+
+
+
+
Example
+ 
{"review": ProductReview}
+
+
+
+
+
+
+
+ Types +
+

CreatePurchaseOrderApprovalRuleConditionAmountInput

+
+
+
+
Description
+

Specifies the amount and currency to evaluate.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ currency - CurrencyEnum! + Purchase order approval rule condition amount currency.
+ value - Float! + Purchase order approval rule condition amount value.
+
+
+
+
+
Example
+ 
{"currency": "AFN", "value": 987.65}
+
+
+
+
+
+
+
+ Types +
+

CreatePurchaseOrderApprovalRuleConditionInput

+
+
+
+
Description
+

Defines a set of conditions that apply to a rule.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ amount - CreatePurchaseOrderApprovalRuleConditionAmountInput + The amount to be compared in a purchase order approval rule. This field is mutually exclusive with condition quantity.
+ attribute - PurchaseOrderApprovalRuleType! + The type of approval rule.
+ operator - PurchaseOrderApprovalRuleConditionOperator! + Defines how to evaluate an amount or quantity in a purchase order.
+ quantity - Int + The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount.
+
+
+
+
+
Example
+ 
{
+  "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput,
+  "attribute": "GRAND_TOTAL",
+  "operator": "MORE_THAN",
+  "quantity": 123
+}
+
+
+
+
+
+
+
+ Types +
+

CreateRequisitionListInput

+
+
+
+
Description
+

An input object that identifies and describes a new requisition list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ description - String + An optional description of the requisition list.
+ name - String! + The name assigned to the requisition list.
+
+
+
+
+
Example
+ 
{
+  "description": "abc123",
+  "name": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CreateRequisitionListOutput

+
+
+
+
Description
+

Output of the request to create a requisition list.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
requisition_list - RequisitionList + The created requisition list.
+
+
+
+
+
Example
+ 
{"requisition_list": RequisitionList}
+
+
+
+
+
+
+
+ Types +
+

CreateVaultCardPaymentTokenInput

+
+
+
+
Description
+

Describe the variables needed to create a vault payment token

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ card_description - String + Description of the vaulted card
+ setup_token_id - String! + The setup token obtained by the createVaultCardSetupToken endpoint
+
+
+
+
+
Example
+ 
{
+  "card_description": "xyz789",
+  "setup_token_id": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CreateVaultCardPaymentTokenOutput

+
+
+
+
Description
+

The vault token id and information about the payment source

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
payment_source - PaymentSourceOutput! + The payment source information
vault_token_id - String! + The vault payment token information
+
+
+
+
+
Example
+ 
{
+  "payment_source": PaymentSourceOutput,
+  "vault_token_id": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CreateVaultCardSetupTokenInput

+
+
+
+
Description
+

Describe the variables needed to create a vault card setup token

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ setup_token - VaultSetupTokenInput! + The setup token information
+ three_ds_mode - ThreeDSMode + The 3DS mode
+
+
+
+
+
Example
+ 
{
+  "setup_token": VaultSetupTokenInput,
+  "three_ds_mode": "OFF"
+}
+
+
+
+
+
+
+
+ Types +
+

CreateVaultCardSetupTokenOutput

+
+
+
+
Description
+

The setup token id information

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
setup_token - String! + The setup token id
+
+
+
+
+
Example
+ 
{"setup_token": "abc123"}
+
+
+
+
+
+
+
+ Types +
+

CreateWishlistInput

+
+
+
+
Description
+

Defines the name and visibility of a new wish list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ name - String! + The name of the new wish list.
+ visibility - WishlistVisibilityEnum! + Indicates whether the wish list is public or private.
+
+
+
+
+
Example
+ 
{"name": "xyz789", "visibility": "PUBLIC"}
+
+
+
+
+
+
+
+ Types +
+

CreateWishlistOutput

+
+
+
+
Description
+

Contains the wish list.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
wishlist - Wishlist! + The newly-created wish list
+
+
+
+
+
Example
+ 
{"wishlist": Wishlist}
+
+
+
+
+
+
+
+ Types +
+

CreditCardDetailsInput

+
+
+
+
Description
+

Required fields for Payflow Pro and Payments Pro credit card payments.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cc_exp_month - Int! + The credit card expiration month.
+ cc_exp_year - Int! + The credit card expiration year.
+ cc_last_4 - Int! + The last 4 digits of the credit card.
+ cc_type - String! + The credit card type.
+
+
+
+
+
Example
+ 
{
+  "cc_exp_month": 987,
+  "cc_exp_year": 123,
+  "cc_last_4": 123,
+  "cc_type": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CreditMemo

+
+
+
+
Description
+

Contains credit memo details.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
comments - [SalesCommentItem] + Comments on the credit memo.
id - ID! + The unique ID for a CreditMemo object.
items - [CreditMemoItemInterface] + An array containing details about refunded items.
number - String! + The sequential credit memo number.
total - CreditMemoTotal + Details about the total refunded amount.
+
+
+
+
+
Example
+ 
{
+  "comments": [SalesCommentItem],
+  "id": "4",
+  "items": [CreditMemoItemInterface],
+  "number": "xyz789",
+  "total": CreditMemoTotal
+}
+
+
+
+
+
+
+
+ Types +
+

CreditMemoItem

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
discounts - [Discount] + Details about the final discount amount for the base product, including discounts on options.
id - ID! + The unique ID for a CreditMemoItemInterface object.
order_item - OrderItemInterface + The order item the credit memo is applied to.
product_name - String + The name of the base product.
product_sale_price - Money! + The sale price for the base product, including selected options.
product_sku - String! + The SKU of the base product.
quantity_refunded - Float + The number of refunded items.
+
+
+
+
+
Example
+ 
{
+  "discounts": [Discount],
+  "id": "4",
+  "order_item": OrderItemInterface,
+  "product_name": "xyz789",
+  "product_sale_price": Money,
+  "product_sku": "abc123",
+  "quantity_refunded": 987.65
+}
+
+
+
+
+
+
+
+ Types +
+

CreditMemoItemInterface

+
+
+
+
Description
+

Credit memo item details.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
discounts - [Discount] + Details about the final discount amount for the base product, including discounts on options.
id - ID! + The unique ID for a CreditMemoItemInterface object.
order_item - OrderItemInterface + The order item the credit memo is applied to.
product_name - String + The name of the base product.
product_sale_price - Money! + The sale price for the base product, including selected options.
product_sku - String! + The SKU of the base product.
quantity_refunded - Float + The number of refunded items.
+
+
+
Possible Types
+ + + + + + + + + + + + + + + + + + + + +
CreditMemoItemInterface Types
+

DownloadableCreditMemoItem

+
+

BundleCreditMemoItem

+
+

GiftCardCreditMemoItem

+
+

CreditMemoItem

+
+
+
+
+
+
Example
+ 
{
+  "discounts": [Discount],
+  "id": "4",
+  "order_item": OrderItemInterface,
+  "product_name": "xyz789",
+  "product_sale_price": Money,
+  "product_sku": "xyz789",
+  "quantity_refunded": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

CreditMemoTotal

+
+
+
+
Description
+

Contains credit memo price details.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
adjustment - Money! + An adjustment manually applied to the order.
base_grand_total - Money! + The final base grand total amount in the base currency.
discounts - [Discount] + The applied discounts to the credit memo.
grand_total - Money! + The final total amount, including shipping, discounts, and taxes.
shipping_handling - ShippingHandling + Details about the shipping and handling costs for the credit memo.
subtotal - Money! + The subtotal of the invoice, excluding shipping, discounts, and taxes.
taxes - [TaxItem] + The credit memo tax details.
total_shipping - Money! + The shipping amount for the credit memo.
total_tax - Money! + The amount of tax applied to the credit memo.
+
+
+
+
+
Example
+ 
{
+  "adjustment": Money,
+  "base_grand_total": Money,
+  "discounts": [Discount],
+  "grand_total": Money,
+  "shipping_handling": ShippingHandling,
+  "subtotal": Money,
+  "taxes": [TaxItem],
+  "total_shipping": Money,
+  "total_tax": Money
+}
+
+
+
+
+
+
+
+ Types +
+

Currency

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
available_currency_codes - [String] + An array of three-letter currency codes accepted by the store, such as USD and EUR.
base_currency_code - String + The base currency set for the store, such as USD.
base_currency_symbol - String + The symbol for the specified base currency, such as $.
default_display_currecy_code - String + + Symbol was missed. Use default_display_currency_code. +
default_display_currecy_symbol - String + + Symbol was missed. Use default_display_currency_code. +
default_display_currency_code - String + The currency that is displayed by default, such as USD.
default_display_currency_symbol - String + The currency symbol that is displayed by default, such as $.
exchange_rates - [ExchangeRate] + An array of exchange rates for currencies defined in the store.
+
+
+
+
+
Example
+ 
{
+  "available_currency_codes": ["xyz789"],
+  "base_currency_code": "xyz789",
+  "base_currency_symbol": "xyz789",
+  "default_display_currecy_code": "xyz789",
+  "default_display_currecy_symbol": "xyz789",
+  "default_display_currency_code": "xyz789",
+  "default_display_currency_symbol": "xyz789",
+  "exchange_rates": [ExchangeRate]
+}
+
+
+
+
+
+
+
+ Types +
+

CurrencyEnum

+
+
+
+
Description
+

The list of available currency codes.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

AFN

+ 		+
+

ALL

+ 		+
+

AZN

+ 		+
+

DZD

+ 		+
+

AOA

+ 		+
+

ARS

+ 		+
+

AMD

+ 		+
+

AWG

+ 		+
+

AUD

+ 		+
+

BSD

+ 		+
+

BHD

+ 		+
+

BDT

+ 		+
+

BBD

+ 		+
+

BYN

+ 		+
+

BZD

+ 		+
+

BMD

+ 		+
+

BTN

+ 		+
+

BOB

+ 		+
+

BAM

+ 		+
+

BWP

+ 		+
+

BRL

+ 		+
+

GBP

+ 		+
+

BND

+ 		+
+

BGN

+ 		+
+

BUK

+ 		+
+

BIF

+ 		+
+

KHR

+ 		+
+

CAD

+ 		+
+

CVE

+ 		+
+

CZK

+ 		+
+

KYD

+ 		+
+

GQE

+ 		+
+

CLP

+ 		+
+

CNY

+ 		+
+

COP

+ 		+
+

KMF

+ 		+
+

CDF

+ 		+
+

CRC

+ 		+
+

HRK

+ 		+
+

CUP

+ 		+
+

DKK

+ 		+
+

DJF

+ 		+
+

DOP

+ 		+
+

XCD

+ 		+
+

EGP

+ 		+
+

SVC

+ 		+
+

ERN

+ 		+
+

EEK

+ 		+
+

ETB

+ 		+
+

EUR

+ 		+
+

FKP

+ 		+
+

FJD

+ 		+
+

GMD

+ 		+
+

GEK

+ 		+
+

GEL

+ 		+
+

GHS

+ 		+
+

GIP

+ 		+
+

GTQ

+ 		+
+

GNF

+ 		+
+

GYD

+ 		+
+

HTG

+ 		+
+

HNL

+ 		+
+

HKD

+ 		+
+

HUF

+ 		+
+

ISK

+ 		+
+

INR

+ 		+
+

IDR

+ 		+
+

IRR

+ 		+
+

IQD

+ 		+
+

ILS

+ 		+
+

JMD

+ 		+
+

JPY

+ 		+
+

JOD

+ 		+
+

KZT

+ 		+
+

KES

+ 		+
+

KWD

+ 		+
+

KGS

+ 		+
+

LAK

+ 		+
+

LVL

+ 		+
+

LBP

+ 		+
+

LSL

+ 		+
+

LRD

+ 		+
+

LYD

+ 		+
+

LTL

+ 		+
+

MOP

+ 		+
+

MKD

+ 		+
+

MGA

+ 		+
+

MWK

+ 		+
+

MYR

+ 		+
+

MVR

+ 		+
+

LSM

+ 		+
+

MRO

+ 		+
+

MUR

+ 		+
+

MXN

+ 		+
+

MDL

+ 		+
+

MNT

+ 		+
+

MAD

+ 		+
+

MZN

+ 		+
+

MMK

+ 		+
+

NAD

+ 		+
+

NPR

+ 		+
+

ANG

+ 		+
+

YTL

+ 		+
+

NZD

+ 		+
+

NIC

+ 		+
+

NGN

+ 		+
+

KPW

+ 		+
+

NOK

+ 		+
+

OMR

+ 		+
+

PKR

+ 		+
+

PAB

+ 		+
+

PGK

+ 		+
+

PYG

+ 		+
+

PEN

+ 		+
+

PHP

+ 		+
+

PLN

+ 		+
+

QAR

+ 		+
+

RHD

+ 		+
+

RON

+ 		+
+

RUB

+ 		+
+

RWF

+ 		+
+

SHP

+ 		+
+

STD

+ 		+
+

SAR

+ 		+
+

RSD

+ 		+
+

SCR

+ 		+
+

SLL

+ 		+
+

SGD

+ 		+
+

SKK

+ 		+
+

SBD

+ 		+
+

SOS

+ 		+
+

ZAR

+ 		+
+

KRW

+ 		+
+

LKR

+ 		+
+

SDG

+ 		+
+

SRD

+ 		+
+

SZL

+ 		+
+

SEK

+ 		+
+

CHF

+ 		+
+

SYP

+ 		+
+

TWD

+ 		+
+

TJS

+ 		+
+

TZS

+ 		+
+

THB

+ 		+
+

TOP

+ 		+
+

TTD

+ 		+
+

TND

+ 		+
+

TMM

+ 		+
+

USD

+ 		+
+

UGX

+ 		+
+

UAH

+ 		+
+

AED

+ 		+
+

UYU

+ 		+
+

UZS

+ 		+
+

VUV

+ 		+
+

VEB

+ 		+
+

VEF

+ 		+
+

VND

+ 		+
+

CHE

+ 		+
+

CHW

+ 		+
+

XOF

+ 		+
+

WST

+ 		+
+

YER

+ 		+
+

ZMK

+ 		+
+

ZWD

+ 		+
+

TRY

+ 		+
+

AZM

+ 		+
+

ROL

+ 		+
+

TRL

+ 		+
+

XPF

+ 		+
+
+
+
+
+
Example
+ 
"AFN"
+
+
+
+
+
+
+
+ Types +
+

CustomAttributeMetadata

+
+
+
+
Description
+

Defines an array of custom attributes.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
items - [Attribute] + An array of attributes.
+
+
+
+
+
Example
+ 
{"items": [Attribute]}
+
+
+
+
+
+
+
+ Types +
+

CustomAttributeMetadataInterface

+
+
+
+
Description
+

An interface containing fields that define the EAV attribute.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
code - ID! + The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
default_value - String + Default attribute value.
entity_type - AttributeEntityTypeEnum! + The type of entity that defines the attribute.
frontend_class - String + The frontend class of the attribute.
frontend_input - AttributeFrontendInputEnum + The frontend input type of the attribute.
is_required - Boolean! + Whether the attribute value is required.
is_unique - Boolean! + Whether the attribute value must be unique.
label - String + The label assigned to the attribute.
options - [CustomAttributeOptionInterface]! + Attribute options.
+
+
+
Possible Types
+ + + + + + + + + + + + + + + + + + + + +
CustomAttributeMetadataInterface Types
+

AttributeMetadata

+
+

CatalogAttributeMetadata

+
+

CustomerAttributeMetadata

+
+

ReturnItemAttributeMetadata

+
+
+
+
+
+
Example
+ 
{
+  "code": 4,
+  "default_value": "abc123",
+  "entity_type": "CATALOG_PRODUCT",
+  "frontend_class": "abc123",
+  "frontend_input": "BOOLEAN",
+  "is_required": true,
+  "is_unique": true,
+  "label": "xyz789",
+  "options": [CustomAttributeOptionInterface]
+}
+
+
+
+
+
+
+
+ Types +
+

CustomAttributeOptionInterface

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
is_default - Boolean! + Is the option value default.
label - String! + The label assigned to the attribute option.
value - String! + The attribute option value.
+
+
+
Possible Types
+ + + + + + + + + + + +
CustomAttributeOptionInterface Types
+

AttributeOptionMetadata

+
+
+
+
+
+
Example
+ 
{
+  "is_default": false,
+  "label": "xyz789",
+  "value": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

Customer

+
+
+
+
Description
+

Defines the customer name, addresses, and other details.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
addresses - [CustomerAddress] + An array containing the customer's shipping and billing addresses.
addressesV2 - CustomerAddresses + An array containing the customer's shipping and billing addresses.
+
+
Arguments
+
+
+
currentPage - Int +
+

Specifies which page of results to return. The default value is 1.

+
+
+
pageSize - Int +
+

Specifies the maximum number of results to return at once. The default value is 5.

+
+
+
+
allow_remote_shopping_assistance - Boolean! + Indicates whether the customer has enabled remote shopping assistance.
companies - UserCompaniesOutput! + An object that contains a list of companies user is assigned to.
+
+
Arguments
+
+
+
input - UserCompaniesInput +
+
+
+
+
compare_list - CompareList + The contents of the customer's compare list.
confirmation_status - ConfirmationStatusEnum! + The customer's confirmation status.
created_at - String + Timestamp indicating when the account was created.
custom_attributes - [AttributeValueInterface] + Customer's custom attributes.
+
+
Arguments
+
+
+
attributeCodes - [ID!] +
+
+
+
+
date_of_birth - String + The customer's date of birth.
default_billing - String + The ID assigned to the billing address.
default_shipping - String + The ID assigned to the shipping address.
dob - String + The customer's date of birth. Use date_of_birth instead. +
email - String + The customer's email address. Required.
firstname - String + The customer's first name.
gender - Int + The customer's gender (Male - 1, Female - 2).
gift_registries - [GiftRegistry] + Details about all of the customer's gift registries.
gift_registry - GiftRegistry + Details about a specific gift registry.
+
+
Arguments
+
+
+
giftRegistryUid - ID! +
+
+
+
+
group - CustomerGroupStorefront + Customer group assigned to the customer
group_id - Int + + Customer group should not be exposed in the storefront scenarios. +
id - ID! + The unique ID assigned to the customer.
is_subscribed - Boolean + Indicates whether the customer is subscribed to the company's newsletter.
job_title - String + The job title of a company user.
lastname - String + The customer's family name.
middlename - String + The customer's middle name.
orders - CustomerOrders + +
+
+
Arguments
+
+
+
filter - CustomerOrdersFilterInput +
+

Defines the filter to use for searching customer orders.

+
+
+
currentPage - Int +
+

Specifies which page of results to return. The default value is 1.

+
+
+
pageSize - Int +
+

Specifies the maximum number of results to return at once. The default value is 20.

+
+
+
sort - CustomerOrderSortInput +
+

Specifies which field to sort on, and whether to return the results in ascending or descending order.

+
+
+
scope - ScopeTypeEnum +
+

Specifies the scope to search for customer orders. The Store request header identifies the customer's store view code. The default value of STORE limits the search to the value specified in the header. Specify WEBSITE to expand the search to include all customer orders assigned to the website that is defined in the header, or specify GLOBAL to include all customer orders across all websites and stores.

+
+
+
+
prefix - String + An honorific, such as Dr., Mr., or Mrs.
purchase_order - PurchaseOrder + Purchase order details.
+
+
Arguments
+
+
+
uid - ID! +
+
+
+
+
purchase_order_approval_rule - PurchaseOrderApprovalRule + Details about a single purchase order approval rule.
+
+
Arguments
+
+
+
uid - ID! +
+
+
+
+
purchase_order_approval_rule_metadata - PurchaseOrderApprovalRuleMetadata + Purchase order approval rule metadata that can be used for rule edit form rendering.
purchase_order_approval_rules - PurchaseOrderApprovalRules + A list of purchase order approval rules visible to the customer.
+
+
Arguments
+
+
+
currentPage - Int +
+
+
+
pageSize - Int +
+
+
+
+
purchase_orders - PurchaseOrders + A list of purchase orders visible to the customer.
+
+
Arguments
+
+
+
filter - PurchaseOrdersFilterInput +
+
+
+
currentPage - Int +
+
+
+
pageSize - Int +
+
+
+
+
purchase_orders_enabled - Boolean! + Indicates whether purchase order functionality is enabled for the current customer. Global and company-level settings are factored into the result.
requisition_lists - RequisitionLists + An object that contains the customer's requisition lists.
+
+
Arguments
+
+
+
pageSize - Int +
+

The maximum number of results to return at once. The default value is 20.

+
+
+
currentPage - Int +
+

The page of results to return. The default value is 1.

+
+
+
filter - RequisitionListFilterInput +
+

The filter to use to limit the number of requisition lists to return.

+
+
+
+
return - Return + Details about the specified return request from the unique ID for a Return object.
+
+
Arguments
+
+
+
uid - ID! +
+
+
+
+
returns - Returns + Information about the customer's return requests.
+
+
Arguments
+
+
+
pageSize - Int +
+

The maximum number of results to return at once. The default is 20.

+
+
+
currentPage - Int +
+

The page of results to return. The default is 1.

+
+
+
+
reviews - ProductReviews! + Contains the customer's product reviews.
+
+
Arguments
+
+
+
pageSize - Int +
+

The maximum number of results to return at once. The default value is 20.

+
+
+
currentPage - Int +
+

The page of results to return. The default value is 1.

+
+
+
+
reward_points - RewardPoints + Customer reward points details.
role - CompanyRole + The role name and permissions assigned to the company user.
segments - [CustomerSegmentStorefront] + Customer segments associated with the current customer
status - CompanyUserStatusEnum + Indicates whether the company user is ACTIVE or INACTIVE.
store_credit - CustomerStoreCredit + Store credit information applied for the logged in customer.
structure_id - ID! + ID of the company structure
suffix - String + A value such as Sr., Jr., or III.
taxvat - String + The customer's Value-added tax (VAT) number (for corporate customers).
team - CompanyTeam + The team the company user is assigned to.
telephone - String + The phone number of the company user.
wishlist - Wishlist! + Return a customer's wish lists. Use Customer.wishlists or Customer.wishlist_v2 instead. +
wishlist_v2 - Wishlist + Retrieve the wish list identified by the unique ID for a Wishlist object.
+
+
Arguments
+
+
+
id - ID! +
+
+
+
+
wishlists - [Wishlist]! + An array of wishlists. In Magento Open Source, customers are limited to one wish list. The number of wish lists is configurable for Adobe Commerce.
+
+
Arguments
+
+
+
pageSize - Int +
+

Specifies the maximum number of results to return at once. This attribute is optional.

+
+
+
currentPage - Int +
+

Specifies which page of results to return. The default value is 1.

+
+
+
+
+
+
+
+
+
Example
+ 
{
+  "addresses": [CustomerAddress],
+  "addressesV2": CustomerAddresses,
+  "allow_remote_shopping_assistance": false,
+  "companies": UserCompaniesOutput,
+  "compare_list": CompareList,
+  "confirmation_status": "ACCOUNT_CONFIRMED",
+  "created_at": "abc123",
+  "custom_attributes": [AttributeValueInterface],
+  "date_of_birth": "xyz789",
+  "default_billing": "xyz789",
+  "default_shipping": "abc123",
+  "dob": "xyz789",
+  "email": "abc123",
+  "firstname": "abc123",
+  "gender": 123,
+  "gift_registries": [GiftRegistry],
+  "gift_registry": GiftRegistry,
+  "group": CustomerGroupStorefront,
+  "group_id": 123,
+  "id": "4",
+  "is_subscribed": false,
+  "job_title": "abc123",
+  "lastname": "abc123",
+  "middlename": "xyz789",
+  "orders": CustomerOrders,
+  "prefix": "xyz789",
+  "purchase_order": PurchaseOrder,
+  "purchase_order_approval_rule": PurchaseOrderApprovalRule,
+  "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
+  "purchase_order_approval_rules": PurchaseOrderApprovalRules,
+  "purchase_orders": PurchaseOrders,
+  "purchase_orders_enabled": false,
+  "requisition_lists": RequisitionLists,
+  "return": Return,
+  "returns": Returns,
+  "reviews": ProductReviews,
+  "reward_points": RewardPoints,
+  "role": CompanyRole,
+  "segments": [CustomerSegmentStorefront],
+  "status": "ACTIVE",
+  "store_credit": CustomerStoreCredit,
+  "structure_id": 4,
+  "suffix": "abc123",
+  "taxvat": "xyz789",
+  "team": CompanyTeam,
+  "telephone": "xyz789",
+  "wishlist": Wishlist,
+  "wishlist_v2": Wishlist,
+  "wishlists": [Wishlist]
+}
+
+
+
+
+
+
+
+ Types +
+

CustomerAddress

+
+
+
+
Description
+

Contains detailed information about a customer's billing or shipping address.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
city - String + The customer's city or town.
company - String + The customer's company.
country_code - CountryCodeEnum + The customer's country.
country_id - String + The customer's country. Use country_code instead. +
custom_attributes - [CustomerAddressAttribute] + + Use custom_attributesV2 instead. +
custom_attributesV2 - [AttributeValueInterface]! + Custom attributes assigned to the customer address.
+
+
Arguments
+
+
+
attributeCodes - [ID!] +
+
+
+
+
customer_id - Int + The customer ID customer_id is not needed as part of CustomerAddress. The id is a unique identifier for the addresses. +
default_billing - Boolean + Indicates whether the address is the customer's default billing address.
default_shipping - Boolean + Indicates whether the address is the customer's default shipping address.
extension_attributes - [CustomerAddressAttribute] + Contains any extension attributes for the address.
fax - String + The customer's fax number.
firstname - String + The first name of the person associated with the shipping/billing address.
id - Int + The ID of a CustomerAddress object. Use uid instead. +
lastname - String + The family name of the person associated with the shipping/billing address.
middlename - String + The middle name of the person associated with the shipping/billing address.
postcode - String + The customer's ZIP or postal code.
prefix - String + An honorific, such as Dr., Mr., or Mrs.
region - CustomerAddressRegion + An object containing the region name, region code, and region ID.
region_id - Int + The unique ID for a pre-defined region.
street - [String] + An array of strings that define the street number and name.
suffix - String + A value such as Sr., Jr., or III.
telephone - String + The customer's telephone number.
uid - ID + The unique ID for a CustomerAddress object.
vat_id - String + The customer's Value-added tax (VAT) number (for corporate customers).
+
+
+
+
+
Example
+ 
{
+  "city": "xyz789",
+  "company": "xyz789",
+  "country_code": "AF",
+  "country_id": "abc123",
+  "custom_attributes": [CustomerAddressAttribute],
+  "custom_attributesV2": [AttributeValueInterface],
+  "customer_id": 987,
+  "default_billing": true,
+  "default_shipping": true,
+  "extension_attributes": [CustomerAddressAttribute],
+  "fax": "xyz789",
+  "firstname": "abc123",
+  "id": 987,
+  "lastname": "xyz789",
+  "middlename": "abc123",
+  "postcode": "abc123",
+  "prefix": "abc123",
+  "region": CustomerAddressRegion,
+  "region_id": 987,
+  "street": ["xyz789"],
+  "suffix": "xyz789",
+  "telephone": "abc123",
+  "uid": 4,
+  "vat_id": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

CustomerAddressAttribute

+
+
+
+
Description
+

Specifies the attribute code and value of a customer address attribute.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
attribute_code - String + The name assigned to the customer address attribute.
value - String + The value assigned to the customer address attribute.
+
+
+
+
+
Example
+ 
{
+  "attribute_code": "abc123",
+  "value": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CustomerAddressAttributeInput

+
+
+
+
Description
+

Specifies the attribute code and value of a customer attribute.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ attribute_code - String! + The name assigned to the attribute.
+ value - String! + The value assigned to the attribute.
+
+
+
+
+
Example
+ 
{
+  "attribute_code": "xyz789",
+  "value": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CustomerAddressInput

+
+
+
+
Description
+

Contains details about a billing or shipping address.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ city - String + The customer's city or town.
+ company - String + The customer's company.
+ country_code - CountryCodeEnum + The two-letter code representing the customer's country.
+ country_id - CountryCodeEnum + +
+ custom_attributes - [CustomerAddressAttributeInput] + +
+ custom_attributesV2 - [AttributeValueInput] + Custom attributes assigned to the customer address.
+ default_billing - Boolean + Indicates whether the address is the default billing address.
+ default_shipping - Boolean + Indicates whether the address is the default shipping address.
+ fax - String + The customer's fax number.
+ firstname - String + The first name of the person associated with the billing/shipping address.
+ lastname - String + The family name of the person associated with the billing/shipping address.
+ middlename - String + The middle name of the person associated with the billing/shipping address.
+ postcode - String + The customer's ZIP or postal code.
+ prefix - String + An honorific, such as Dr., Mr., or Mrs.
+ region - CustomerAddressRegionInput + An object containing the region name, region code, and region ID.
+ street - [String] + An array of strings that define the street number and name.
+ suffix - String + A value such as Sr., Jr., or III.
+ telephone - String + The customer's telephone number.
+ vat_id - String + The customer's Tax/VAT number (for corporate customers).
+
+
+
+
+
Example
+ 
{
+  "city": "abc123",
+  "company": "abc123",
+  "country_code": "AF",
+  "country_id": "AF",
+  "custom_attributes": [CustomerAddressAttributeInput],
+  "custom_attributesV2": [AttributeValueInput],
+  "default_billing": false,
+  "default_shipping": false,
+  "fax": "xyz789",
+  "firstname": "xyz789",
+  "lastname": "abc123",
+  "middlename": "abc123",
+  "postcode": "xyz789",
+  "prefix": "xyz789",
+  "region": CustomerAddressRegionInput,
+  "street": ["xyz789"],
+  "suffix": "xyz789",
+  "telephone": "abc123",
+  "vat_id": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

CustomerAddressRegion

+
+
+
+
Description
+

Defines the customer's state or province.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
region - String + The state or province name.
region_code - String + The address region code.
region_id - Int + The unique ID for a pre-defined region.
+
+
+
+
+
Example
+ 
{
+  "region": "abc123",
+  "region_code": "abc123",
+  "region_id": 987
+}
+
+
+
+
+
+
+
+ Types +
+

CustomerAddressRegionInput

+
+
+
+
Description
+

Defines the customer's state or province.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ region - String + The state or province name.
+ region_code - String + The address region code.
+ region_id - Int + The unique ID for a pre-defined region.
+
+
+
+
+
Example
+ 
{
+  "region": "abc123",
+  "region_code": "abc123",
+  "region_id": 987
+}
+
+
+
+
+
+
+
+ Types +
+

CustomerAddresses

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items - [CustomerAddress] + An array containing the customer's shipping and billing addresses.
page_info - SearchResultPageInfo + Contains pagination metadata.
total_count - Int + The total count of customer addresses.
+
+
+
+
+
Example
+ 
{
+  "items": [CustomerAddress],
+  "page_info": SearchResultPageInfo,
+  "total_count": 987
+}
+
+
+
+
+
+
+
+ Types +
+

CustomerAttributeMetadata

+
+
+
+
Description
+

Customer attribute metadata.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
code - ID! + The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
default_value - String + Default attribute value.
entity_type - AttributeEntityTypeEnum! + The type of entity that defines the attribute.
frontend_class - String + The frontend class of the attribute.
frontend_input - AttributeFrontendInputEnum + The frontend input type of the attribute.
input_filter - InputFilterEnum + The template used for the input of the attribute (e.g., 'date').
is_required - Boolean! + Whether the attribute value is required.
is_unique - Boolean! + Whether the attribute value must be unique.
label - String + The label assigned to the attribute.
multiline_count - Int + The number of lines of the attribute value.
options - [CustomAttributeOptionInterface]! + Attribute options.
sort_order - Int + The position of the attribute in the form.
validate_rules - [ValidationRule] + The validation rules of the attribute value.
+
+
+
+
+
Example
+ 
{
+  "code": "4",
+  "default_value": "xyz789",
+  "entity_type": "CATALOG_PRODUCT",
+  "frontend_class": "xyz789",
+  "frontend_input": "BOOLEAN",
+  "input_filter": "NONE",
+  "is_required": true,
+  "is_unique": true,
+  "label": "abc123",
+  "multiline_count": 123,
+  "options": [CustomAttributeOptionInterface],
+  "sort_order": 987,
+  "validate_rules": [ValidationRule]
+}
+
+
+
+
+
+
+
+ Types +
+

CustomerCreateInput

+
+
+
+
Description
+

An input object for creating a customer.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ allow_remote_shopping_assistance - Boolean + Indicates whether the customer has enabled remote shopping assistance.
+ custom_attributes - [AttributeValueInput] + The customer's custom attributes.
+ date_of_birth - String + The customer's date of birth.
+ dob - String + +
+ email - String! + The customer's email address.
+ firstname - String! + The customer's first name.
+ gender - Int + The customer's gender (Male - 1, Female - 2).
+ is_subscribed - Boolean + Indicates whether the customer is subscribed to the company's newsletter.
+ lastname - String! + The customer's family name.
+ middlename - String + The customer's middle name.
+ password - String + The customer's password.
+ prefix - String + An honorific, such as Dr., Mr., or Mrs.
+ suffix - String + A value such as Sr., Jr., or III.
+ taxvat - String + The customer's Tax/VAT number (for corporate customers).
+
+
+
+
+
Example
+ 
{
+  "allow_remote_shopping_assistance": false,
+  "custom_attributes": [AttributeValueInput],
+  "date_of_birth": "xyz789",
+  "dob": "abc123",
+  "email": "xyz789",
+  "firstname": "abc123",
+  "gender": 987,
+  "is_subscribed": false,
+  "lastname": "xyz789",
+  "middlename": "xyz789",
+  "password": "abc123",
+  "prefix": "abc123",
+  "suffix": "abc123",
+  "taxvat": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CustomerDownloadableProduct

+
+
+
+
Description
+

Contains details about a single downloadable product.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
date - String + The date and time the purchase was made.
download_url - String + The fully qualified URL to the download file.
order_increment_id - String + The unique ID assigned to the item.
remaining_downloads - String + The remaining number of times the customer can download the product.
status - String + Indicates when the product becomes available for download. Options are Pending and Invoiced.
+
+
+
+
+
Example
+ 
{
+  "date": "abc123",
+  "download_url": "xyz789",
+  "order_increment_id": "abc123",
+  "remaining_downloads": "abc123",
+  "status": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CustomerDownloadableProducts

+
+
+
+
Description
+

Contains a list of downloadable products.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
items - [CustomerDownloadableProduct] + An array of purchased downloadable items.
+
+
+
+
+
Example
+ 
{"items": [CustomerDownloadableProduct]}
+
+
+
+
+
+
+
+ Types +
+

CustomerGroupStorefront

+
+
+
+
Description
+

Data of customer group.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
uid - ID! + The unique ID for a CustomerGroup object.
+
+
+
+
+
Example
+ 
{"uid": 4}
+
+
+
+
+
+
+
+ Types +
+

CustomerInput

+
+
+
+
Description
+

An input object that assigns or updates customer attributes.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ date_of_birth - String + The customer's date of birth.
+ dob - String + +
+ email - String + The customer's email address. Required when creating a customer.
+ firstname - String + The customer's first name.
+ gender - Int + The customer's gender (Male - 1, Female - 2).
+ is_subscribed - Boolean + Indicates whether the customer is subscribed to the company's newsletter.
+ lastname - String + The customer's family name.
+ middlename - String + The customer's middle name.
+ password - String + The customer's password.
+ prefix - String + An honorific, such as Dr., Mr., or Mrs.
+ suffix - String + A value such as Sr., Jr., or III.
+ taxvat - String + The customer's Tax/VAT number (for corporate customers).
+
+
+
+
+
Example
+ 
{
+  "date_of_birth": "xyz789",
+  "dob": "abc123",
+  "email": "abc123",
+  "firstname": "abc123",
+  "gender": 987,
+  "is_subscribed": true,
+  "lastname": "xyz789",
+  "middlename": "xyz789",
+  "password": "abc123",
+  "prefix": "abc123",
+  "suffix": "xyz789",
+  "taxvat": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CustomerOrder

+
+
+
+
Description
+

Contains details about each of the customer's orders.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
applied_coupons - [AppliedCoupon]! + Coupons applied to the order.
applied_gift_cards - [ApplyGiftCardToOrder] + An array of gift cards applied to the order.
available_actions - [OrderActionType]! + List of available order actions.
billing_address - OrderAddress + The billing address for the order.
carrier - String + The shipping carrier for the order delivery.
comments - [SalesCommentItem] + Comments about the order.
created_at - String + + Use the order_date field instead. +
credit_memos - [CreditMemo] + A list of credit memos.
customer_info - OrderCustomerInfo! + Returns customer information from order.
email - String + Order customer email.
gift_message - GiftMessage + The entered gift message for the order
gift_receipt_included - Boolean! + Indicates whether the customer requested a gift receipt for the order.
gift_wrapping - GiftWrapping + The selected gift wrapping for the order.
grand_total - Float + + Use the totals.grand_total field instead. +
id - ID! + The unique ID for a CustomerOrder object.
increment_id - String + + Use the id field instead. +
invoices - [Invoice]! + A list of invoices for the order.
is_virtual - Boolean! + + TRUE if the order is virtual +
items - [OrderItemInterface] + An array containing the items purchased in this order.
items_eligible_for_return - [OrderItemInterface] + A list of order items eligible to be in a return request.
number - String! + The order number.
order_date - String! + The date the order was placed.
order_number - String! + + Use the number field instead. +
order_status_change_date - String! + The date the order status was last updated.
payment_methods - [OrderPaymentMethod] + Payment details for the order.
printed_card_included - Boolean! + Indicates whether the customer requested a printed card for the order.
returns - Returns + Return requests associated with this order.
+
+
Arguments
+
+
+
pageSize - Int +
+

The maximum number of results to return at once. The default is 20.

+
+
+
currentPage - Int +
+

The page of results to return. The default is 1.

+
+
+
+
shipments - [OrderShipment] + A list of shipments for the order.
shipping_address - OrderAddress + The shipping address for the order.
shipping_method - String + The delivery method for the order.
status - String! + The current status of the order.
token - String! + The token that can be used to retrieve the order using order query.
total - OrderTotal + Details about the calculated totals for this order.
+
+
+
+
+
Example
+ 
{
+  "applied_coupons": [AppliedCoupon],
+  "applied_gift_cards": [ApplyGiftCardToOrder],
+  "available_actions": ["REORDER"],
+  "billing_address": OrderAddress,
+  "carrier": "xyz789",
+  "comments": [SalesCommentItem],
+  "created_at": "xyz789",
+  "credit_memos": [CreditMemo],
+  "customer_info": OrderCustomerInfo,
+  "email": "xyz789",
+  "gift_message": GiftMessage,
+  "gift_receipt_included": false,
+  "gift_wrapping": GiftWrapping,
+  "grand_total": 123.45,
+  "id": 4,
+  "increment_id": "xyz789",
+  "invoices": [Invoice],
+  "is_virtual": false,
+  "items": [OrderItemInterface],
+  "items_eligible_for_return": [OrderItemInterface],
+  "number": "abc123",
+  "order_date": "abc123",
+  "order_number": "abc123",
+  "order_status_change_date": "xyz789",
+  "payment_methods": [OrderPaymentMethod],
+  "printed_card_included": true,
+  "returns": Returns,
+  "shipments": [OrderShipment],
+  "shipping_address": OrderAddress,
+  "shipping_method": "abc123",
+  "status": "abc123",
+  "token": "abc123",
+  "total": OrderTotal
+}
+
+
+
+
+
+
+
+ Types +
+

CustomerOrderSortInput

+
+
+
+
Description
+

CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ sort_direction - SortEnum! + This enumeration indicates whether to return results in ascending or descending order
+ sort_field - CustomerOrderSortableField! + Specifies the field to use for sorting
+
+
+
+
+
Example
+ 
{"sort_direction": "ASC", "sort_field": "NUMBER"}
+
+
+
+
+
+
+
+ Types +
+

CustomerOrderSortableField

+
+
+
+
Description
+

Specifies the field to use for sorting

+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

NUMBER

+ 		Sorts customer orders by number
+

CREATED_AT

+ 		Sorts customer orders by created_at field
+
+
+
+
+
Example
+ 
"NUMBER"
+
+
+
+
+
+
+
+ Types +
+

CustomerOrders

+
+
+
+
Description
+

The collection of orders that match the conditions defined in the filter.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
date_of_first_order - String + Date of the first order placed in the store
items - [CustomerOrder]! + An array of customer orders.
page_info - SearchResultPageInfo + Contains pagination metadata.
total_count - Int + The total count of customer orders.
+
+
+
+
+
Example
+ 
{
+  "date_of_first_order": "abc123",
+  "items": [CustomerOrder],
+  "page_info": SearchResultPageInfo,
+  "total_count": 123
+}
+
+
+
+
+
+
+
+ Types +
+

CustomerOrdersFilterInput

+
+
+
+
Description
+

Identifies the filter to use for filtering orders.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ grand_total - FilterRangeTypeInput + Filters by order base grand total value.
+ number - FilterStringTypeInput + Filters by order number.
+ order_date - FilterRangeTypeInput + Filters by order created_at time.
+ status - FilterEqualTypeInput + Filters by order status.
+
+
+
+
+
Example
+ 
{
+  "grand_total": FilterRangeTypeInput,
+  "number": FilterStringTypeInput,
+  "order_date": FilterRangeTypeInput,
+  "status": FilterEqualTypeInput
+}
+
+
+
+
+
+
+
+ Types +
+

CustomerOutput

+
+
+
+
Description
+

Contains details about a newly-created or updated customer.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
customer - Customer! + Customer details after creating or updating a customer.
+
+
+
+
+
Example
+ 
{"customer": Customer}
+
+
+
+
+
+
+
+ Types +
+

CustomerPaymentTokens

+
+
+
+
Description
+

Contains payment tokens stored in the customer's vault.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
items - [PaymentToken]! + An array of payment tokens.
+
+
+
+
+
Example
+ 
{"items": [PaymentToken]}
+
+
+
+
+
+
+
+ Types +
+

CustomerSegmentStorefront

+
+
+
+
Description
+

Customer segment details

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
uid - ID! + The unique ID for a CustomerSegment object.
+
+
+
+
+
Example
+ 
{"uid": 4}
+
+
+
+
+
+
+
+ Types +
+

CustomerStoreCredit

+
+
+
+
Description
+

Contains store credit information with balance and history.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
balance_history - CustomerStoreCreditHistory + Contains the customer's store credit balance history. If the history or store credit feature is disabled, then a null value will be returned.
+
+
Arguments
+
+
+
pageSize - Int +
+

The maximum number of results to return at once. The default is 20.

+
+
+
currentPage - Int +
+

The page of results to return. This value is optional. The default is 1.

+
+
+
+
current_balance - Money + The current balance of store credit.
enabled - Boolean + Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned.
+
+
+
+
+
Example
+ 
{
+  "balance_history": CustomerStoreCreditHistory,
+  "current_balance": Money,
+  "enabled": false
+}
+
+
+
+
+
+
+
+ Types +
+

CustomerStoreCreditHistory

+
+
+
+
Description
+

Lists changes to the amount of store credit available to the customer.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items - [CustomerStoreCreditHistoryItem] + An array containing information about changes to the store credit available to the customer.
page_info - SearchResultPageInfo + Metadata for pagination rendering.
total_count - Int + The number of items returned.
+
+
+
+
+
Example
+ 
{
+  "items": [CustomerStoreCreditHistoryItem],
+  "page_info": SearchResultPageInfo,
+  "total_count": 987
+}
+
+
+
+
+
+
+
+ Types +
+

CustomerStoreCreditHistoryItem

+
+
+
+
Description
+

Contains store credit history information.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
action - String + The action that was made on the store credit.
actual_balance - Money + The store credit available to the customer as a result of this action.
balance_change - Money + The amount added to or subtracted from the store credit as a result of this action.
date_time_changed - String + The date and time when the store credit change was made.
+
+
+
+
+
Example
+ 
{
+  "action": "xyz789",
+  "actual_balance": Money,
+  "balance_change": Money,
+  "date_time_changed": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CustomerToken

+
+
+
+
Description
+

Contains a customer authorization token.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
token - String + The customer authorization token.
+
+
+
+
+
Example
+ 
{"token": "abc123"}
+
+
+
+
+
+
+
+ Types +
+

CustomerUpdateInput

+
+
+
+
Description
+

An input object for updating a customer.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ allow_remote_shopping_assistance - Boolean + Indicates whether the customer has enabled remote shopping assistance.
+ custom_attributes - [AttributeValueInput] + The customer's custom attributes.
+ date_of_birth - String + The customer's date of birth.
+ dob - String + +
+ firstname - String + The customer's first name.
+ gender - Int + The customer's gender (Male - 1, Female - 2).
+ is_subscribed - Boolean + Indicates whether the customer is subscribed to the company's newsletter.
+ lastname - String + The customer's family name.
+ middlename - String + The customer's middle name.
+ prefix - String + An honorific, such as Dr., Mr., or Mrs.
+ suffix - String + A value such as Sr., Jr., or III.
+ taxvat - String + The customer's Tax/VAT number (for corporate customers).
+
+
+
+
+
Example
+ 
{
+  "allow_remote_shopping_assistance": false,
+  "custom_attributes": [AttributeValueInput],
+  "date_of_birth": "abc123",
+  "dob": "abc123",
+  "firstname": "xyz789",
+  "gender": 123,
+  "is_subscribed": false,
+  "lastname": "abc123",
+  "middlename": "xyz789",
+  "prefix": "xyz789",
+  "suffix": "xyz789",
+  "taxvat": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CustomizableAreaOption

+
+
+
+
Description
+

Contains information about a text area that is defined as part of a customizable option.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
option_id - Int + Option ID. Use uid instead +
product_sku - String + The Stock Keeping Unit of the base product.
required - Boolean + Indicates whether the option is required.
sort_order - Int + The order in which the option is displayed.
title - String + The display name for this option.
uid - ID! + The unique ID for a CustomizableOptionInterface object.
value - CustomizableAreaValue + An object that defines a text area.
+
+
+
+
+
Example
+ 
{
+  "option_id": 123,
+  "product_sku": "abc123",
+  "required": true,
+  "sort_order": 123,
+  "title": "xyz789",
+  "uid": "4",
+  "value": CustomizableAreaValue
+}
+
+
+
+
+
+
+
+ Types +
+

CustomizableAreaValue

+
+
+
+
Description
+

Defines the price and sku of a product whose page contains a customized text area.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
max_characters - Int + The maximum number of characters that can be entered for this customizable option.
price - Float + The price assigned to this option.
price_type - PriceTypeEnum + FIXED, PERCENT, or DYNAMIC.
sku - String + The Stock Keeping Unit for this option.
uid - ID! + The unique ID for a CustomizableAreaValue object.
+
+
+
+
+
Example
+ 
{
+  "max_characters": 987,
+  "price": 123.45,
+  "price_type": "FIXED",
+  "sku": "abc123",
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

CustomizableCheckboxOption

+
+
+
+
Description
+

Contains information about a set of checkbox values that are defined as part of a customizable option.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
option_id - Int + Option ID. Use uid instead +
required - Boolean + Indicates whether the option is required.
sort_order - Int + The order in which the option is displayed.
title - String + The display name for this option.
uid - ID! + The unique ID for a CustomizableOptionInterface object.
value - [CustomizableCheckboxValue] + An array that defines a set of checkbox values.
+
+
+
+
+
Example
+ 
{
+  "option_id": 123,
+  "required": true,
+  "sort_order": 123,
+  "title": "abc123",
+  "uid": "4",
+  "value": [CustomizableCheckboxValue]
+}
+
+
+
+
+
+
+
+ Types +
+

CustomizableCheckboxValue

+
+
+
+
Description
+

Defines the price and sku of a product whose page contains a customized set of checkbox values.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
option_type_id - Int + The ID assigned to the value.
price - Float + The price assigned to this option.
price_type - PriceTypeEnum + FIXED, PERCENT, or DYNAMIC.
sku - String + The Stock Keeping Unit for this option.
sort_order - Int + The order in which the checkbox value is displayed.
title - String + The display name for this option.
uid - ID! + The unique ID for a CustomizableCheckboxValue object.
+
+
+
+
+
Example
+ 
{
+  "option_type_id": 123,
+  "price": 123.45,
+  "price_type": "FIXED",
+  "sku": "xyz789",
+  "sort_order": 123,
+  "title": "abc123",
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

CustomizableDateOption

+
+
+
+
Description
+

Contains information about a date picker that is defined as part of a customizable option.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
option_id - Int + Option ID. Use uid instead +
product_sku - String + The Stock Keeping Unit of the base product.
required - Boolean + Indicates whether the option is required.
sort_order - Int + The order in which the option is displayed.
title - String + The display name for this option.
uid - ID! + The unique ID for a CustomizableOptionInterface object.
value - CustomizableDateValue + An object that defines a date field in a customizable option.
+
+
+
+
+
Example
+ 
{
+  "option_id": 987,
+  "product_sku": "xyz789",
+  "required": true,
+  "sort_order": 123,
+  "title": "xyz789",
+  "uid": "4",
+  "value": CustomizableDateValue
+}
+
+
+
+
+
+
+
+ Types +
+

CustomizableDateTypeEnum

+
+
+
+
Description
+

Defines the customizable date type.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

DATE

+ 		+
+

DATE_TIME

+ 		+
+

TIME

+ 		+
+
+
+
+
+
Example
+ 
"DATE"
+
+
+
+
+
+
+
+ Types +
+

CustomizableDateValue

+
+
+
+
Description
+

Defines the price and sku of a product whose page contains a customized date picker.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
price - Float + The price assigned to this option.
price_type - PriceTypeEnum + FIXED, PERCENT, or DYNAMIC.
sku - String + The Stock Keeping Unit for this option.
type - CustomizableDateTypeEnum + DATE, DATE_TIME or TIME
uid - ID! + The unique ID for a CustomizableDateValue object.
+
+
+
+
+
Example
+ 
{
+  "price": 123.45,
+  "price_type": "FIXED",
+  "sku": "abc123",
+  "type": "DATE",
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

CustomizableDropDownOption

+
+
+
+
Description
+

Contains information about a drop down menu that is defined as part of a customizable option.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
option_id - Int + Option ID. Use uid instead +
required - Boolean + Indicates whether the option is required.
sort_order - Int + The order in which the option is displayed.
title - String + The display name for this option.
uid - ID! + The unique ID for a CustomizableOptionInterface object.
value - [CustomizableDropDownValue] + An array that defines the set of options for a drop down menu.
+
+
+
+
+
Example
+ 
{
+  "option_id": 987,
+  "required": false,
+  "sort_order": 123,
+  "title": "xyz789",
+  "uid": 4,
+  "value": [CustomizableDropDownValue]
+}
+
+
+
+
+
+
+
+ Types +
+

CustomizableDropDownValue

+
+
+
+
Description
+

Defines the price and sku of a product whose page contains a customized drop down menu.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
option_type_id - Int + The ID assigned to the value.
price - Float + The price assigned to this option.
price_type - PriceTypeEnum + FIXED, PERCENT, or DYNAMIC.
sku - String + The Stock Keeping Unit for this option.
sort_order - Int + The order in which the option is displayed.
title - String + The display name for this option.
uid - ID! + The unique ID for a CustomizableDropDownValue object.
+
+
+
+
+
Example
+ 
{
+  "option_type_id": 987,
+  "price": 123.45,
+  "price_type": "FIXED",
+  "sku": "xyz789",
+  "sort_order": 987,
+  "title": "abc123",
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

CustomizableFieldOption

+
+
+
+
Description
+

Contains information about a text field that is defined as part of a customizable option.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
option_id - Int + Option ID. Use uid instead +
product_sku - String + The Stock Keeping Unit of the base product.
required - Boolean + Indicates whether the option is required.
sort_order - Int + The order in which the option is displayed.
title - String + The display name for this option.
uid - ID! + The unique ID for a CustomizableOptionInterface object.
value - CustomizableFieldValue + An object that defines a text field.
+
+
+
+
+
Example
+ 
{
+  "option_id": 987,
+  "product_sku": "abc123",
+  "required": false,
+  "sort_order": 123,
+  "title": "xyz789",
+  "uid": 4,
+  "value": CustomizableFieldValue
+}
+
+
+
+
+
+
+
+ Types +
+

CustomizableFieldValue

+
+
+
+
Description
+

Defines the price and sku of a product whose page contains a customized text field.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
max_characters - Int + The maximum number of characters that can be entered for this customizable option.
price - Float + The price of the custom value.
price_type - PriceTypeEnum + FIXED, PERCENT, or DYNAMIC.
sku - String + The Stock Keeping Unit for this option.
uid - ID! + The unique ID for a CustomizableFieldValue object.
+
+
+
+
+
Example
+ 
{
+  "max_characters": 987,
+  "price": 123.45,
+  "price_type": "FIXED",
+  "sku": "abc123",
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

CustomizableFileOption

+
+
+
+
Description
+

Contains information about a file picker that is defined as part of a customizable option.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
option_id - Int + Option ID. Use uid instead +
product_sku - String + The Stock Keeping Unit of the base product.
required - Boolean + Indicates whether the option is required.
sort_order - Int + The order in which the option is displayed.
title - String + The display name for this option.
uid - ID! + The unique ID for a CustomizableOptionInterface object.
value - CustomizableFileValue + An object that defines a file value.
+
+
+
+
+
Example
+ 
{
+  "option_id": 987,
+  "product_sku": "xyz789",
+  "required": true,
+  "sort_order": 123,
+  "title": "abc123",
+  "uid": 4,
+  "value": CustomizableFileValue
+}
+
+
+
+
+
+
+
+ Types +
+

CustomizableFileValue

+
+
+
+
Description
+

Defines the price and sku of a product whose page contains a customized file picker.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
file_extension - String + The file extension to accept.
image_size_x - Int + The maximum width of an image.
image_size_y - Int + The maximum height of an image.
price - Float + The price assigned to this option.
price_type - PriceTypeEnum + FIXED, PERCENT, or DYNAMIC.
sku - String + The Stock Keeping Unit for this option.
uid - ID! + The unique ID for a CustomizableFileValue object.
+
+
+
+
+
Example
+ 
{
+  "file_extension": "xyz789",
+  "image_size_x": 987,
+  "image_size_y": 987,
+  "price": 123.45,
+  "price_type": "FIXED",
+  "sku": "abc123",
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

CustomizableMultipleOption

+
+
+
+
Description
+

Contains information about a multiselect that is defined as part of a customizable option.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
option_id - Int + Option ID. Use uid instead +
required - Boolean + Indicates whether the option is required.
sort_order - Int + The order in which the option is displayed.
title - String + The display name for this option.
uid - ID! + The unique ID for a CustomizableOptionInterface object.
value - [CustomizableMultipleValue] + An array that defines the set of options for a multiselect.
+
+
+
+
+
Example
+ 
{
+  "option_id": 123,
+  "required": false,
+  "sort_order": 987,
+  "title": "xyz789",
+  "uid": "4",
+  "value": [CustomizableMultipleValue]
+}
+
+
+
+
+
+
+
+ Types +
+

CustomizableMultipleValue

+
+
+
+
Description
+

Defines the price and sku of a product whose page contains a customized multiselect.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
option_type_id - Int + The ID assigned to the value.
price - Float + The price assigned to this option.
price_type - PriceTypeEnum + FIXED, PERCENT, or DYNAMIC.
sku - String + The Stock Keeping Unit for this option.
sort_order - Int + The order in which the option is displayed.
title - String + The display name for this option.
uid - ID! + The unique ID for a CustomizableMultipleValue object.
+
+
+
+
+
Example
+ 
{
+  "option_type_id": 123,
+  "price": 123.45,
+  "price_type": "FIXED",
+  "sku": "abc123",
+  "sort_order": 987,
+  "title": "abc123",
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

CustomizableOptionInput

+
+
+
+
Description
+

Defines a customizable option.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ id - Int + The customizable option ID of the product.
+ uid - ID + The unique ID for a CartItemInterface object.
+ value_string - String! + The string value of the option.
+
+
+
+
+
Example
+ 
{
+  "id": 123,
+  "uid": 4,
+  "value_string": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

CustomizableOptionInterface

+
+
+
+
Description
+

Contains basic information about a customizable option. It can be implemented by several types of configurable options.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
option_id - Int + Option ID. Use uid instead +
required - Boolean + Indicates whether the option is required.
sort_order - Int + The order in which the option is displayed.
title - String + The display name for this option.
uid - ID! + The unique ID for a CustomizableOptionInterface object.
+
+
+
Possible Types
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CustomizableOptionInterface Types
+

CustomizableAreaOption

+
+

CustomizableDateOption

+
+

CustomizableDropDownOption

+
+

CustomizableMultipleOption

+
+

CustomizableFieldOption

+
+

CustomizableFileOption

+
+

CustomizableRadioOption

+
+

CustomizableCheckboxOption

+
+
+
+
+
+
Example
+ 
{
+  "option_id": 123,
+  "required": true,
+  "sort_order": 123,
+  "title": "abc123",
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

CustomizableProductInterface

+
+
+
+
Description
+

Contains information about customizable product options.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
options - [CustomizableOptionInterface] + An array of options for a customizable product.
+
+
+
Possible Types
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
CustomizableProductInterface Types
+

VirtualProduct

+
+

SimpleProduct

+
+

ConfigurableProduct

+
+

DownloadableProduct

+
+

BundleProduct

+
+

GiftCardProduct

+
+
+
+
+
+
Example
+ 
{"options": [CustomizableOptionInterface]}
+
+
+
+
+
+
+
+ Types +
+

CustomizableRadioOption

+
+
+
+
Description
+

Contains information about a set of radio buttons that are defined as part of a customizable option.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
option_id - Int + Option ID. Use uid instead +
required - Boolean + Indicates whether the option is required.
sort_order - Int + The order in which the option is displayed.
title - String + The display name for this option.
uid - ID! + The unique ID for a CustomizableOptionInterface object.
value - [CustomizableRadioValue] + An array that defines a set of radio buttons.
+
+
+
+
+
Example
+ 
{
+  "option_id": 987,
+  "required": false,
+  "sort_order": 987,
+  "title": "xyz789",
+  "uid": 4,
+  "value": [CustomizableRadioValue]
+}
+
+
+
+
+
+
+
+ Types +
+

CustomizableRadioValue

+
+
+
+
Description
+

Defines the price and sku of a product whose page contains a customized set of radio buttons.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
option_type_id - Int + The ID assigned to the value.
price - Float + The price assigned to this option.
price_type - PriceTypeEnum + FIXED, PERCENT, or DYNAMIC.
sku - String + The Stock Keeping Unit for this option.
sort_order - Int + The order in which the radio button is displayed.
title - String + The display name for this option.
uid - ID! + The unique ID for a CustomizableRadioValue object.
+
+
+
+
+
Example
+ 
{
+  "option_type_id": 123,
+  "price": 987.65,
+  "price_type": "FIXED",
+  "sku": "abc123",
+  "sort_order": 987,
+  "title": "abc123",
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

DeleteCompanyRoleOutput

+
+
+
+
Description
+

Contains the response to the request to delete the company role.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
success - Boolean! + SIndicates whether the company role has been deleted successfully.
+
+
+
+
+
Example
+ 
{"success": true}
+
+
+
+
+
+
+
+ Types +
+

DeleteCompanyTeamOutput

+
+
+
+
Description
+

Contains the status of the request to delete a company team.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
success - Boolean! + Indicates whether the delete operation succeeded.
+
+
+
+
+
Example
+ 
{"success": true}
+
+
+
+
+
+
+
+ Types +
+

DeleteCompanyUserOutput

+
+
+
+
Description
+

Contains the response to the request to delete the company user.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
success - Boolean! + Indicates whether the company user has been deactivated successfully.
+
+
+
+
+
Example
+ 
{"success": true}
+
+
+
+
+
+
+
+ Types +
+

DeleteCompareListOutput

+
+
+
+
Description
+

Contains the results of the request to delete a compare list.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
result - Boolean! + Indicates whether the compare list was successfully deleted.
+
+
+
+
+
Example
+ 
{"result": false}
+
+
+
+
+
+
+
+ Types +
+

DeleteNegotiableQuoteError

+
+
+
+
Types
+ + + + + + + + + + + + + + + + + +
Union Types
+

NegotiableQuoteInvalidStateError

+
+

NoSuchEntityUidError

+
+

InternalError

+
+
+
+
+
+
Example
+ 
NegotiableQuoteInvalidStateError
+
+
+
+
+
+
+
+ Types +
+

DeleteNegotiableQuoteOperationFailure

+
+
+
+
Description
+

Contains details about a failed delete operation on a negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
errors - [DeleteNegotiableQuoteError]! + +
quote_uid - ID! + The unique ID of a NegotiableQuote object.
+
+
+
+
+
Example
+ 
{
+  "errors": [NegotiableQuoteInvalidStateError],
+  "quote_uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

DeleteNegotiableQuoteOperationResult

+
+
+
+
Types
+ + + + + + + + + + + + + + +
Union Types
+

NegotiableQuoteUidOperationSuccess

+
+

DeleteNegotiableQuoteOperationFailure

+
+
+
+
+
+
Example
+ 
NegotiableQuoteUidOperationSuccess
+
+
+
+
+
+
+
+ Types +
+

DeleteNegotiableQuoteTemplateInput

+
+
+
+
Description
+

Specifies the quote template id of the quote template to delete

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ template_id - ID! + The unique ID of a NegotiableQuoteTemplate object.
+
+
+
+
+
Example
+ 
{"template_id": 4}
+
+
+
+
+
+
+
+ Types +
+

DeleteNegotiableQuotesInput

+
+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ quote_uids - [ID]! + A list of unique IDs for NegotiableQuote objects to delete.
+
+
+
+
+
Example
+ 
{"quote_uids": ["4"]}
+
+
+
+
+
+
+
+ Types +
+

DeleteNegotiableQuotesOutput

+
+
+
+
Description
+

Contains a list of undeleted negotiable quotes the company user can view.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
negotiable_quotes - NegotiableQuotesOutput + A list of negotiable quotes that the customer can view
+
+
Arguments
+
+
+
filter - NegotiableQuoteFilterInput +
+

The filter to use to determine which negotiable quotes to delete.

+
+
+
pageSize - Int +
+

The maximum number of results to return at once. The default value is 20.

+
+
+
currentPage - Int +
+

The page of results to return. The default value is 1.

+
+
+
sort - NegotiableQuoteSortInput +
+

The field to use for sorting results.

+
+
+
+
operation_results - [DeleteNegotiableQuoteOperationResult]! + An array of deleted negotiable quote UIDs and details about any errors.
result_status - BatchMutationStatus! + The status of the request to delete one or more negotiable quotes.
+
+
+
+
+
Example
+ 
{
+  "negotiable_quotes": NegotiableQuotesOutput,
+  "operation_results": [
+    NegotiableQuoteUidOperationSuccess
+  ],
+  "result_status": "SUCCESS"
+}
+
+
+
+
+
+
+
+ Types +
+

DeletePaymentTokenOutput

+
+
+
+
Description
+

Indicates whether the request succeeded and returns the remaining customer payment tokens.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
customerPaymentTokens - CustomerPaymentTokens + A container for the customer's remaining payment tokens.
result - Boolean! + Indicates whether the request succeeded.
+
+
+
+
+
Example
+ 
{
+  "customerPaymentTokens": CustomerPaymentTokens,
+  "result": true
+}
+
+
+
+
+
+
+
+ Types +
+

DeletePurchaseOrderApprovalRuleError

+
+
+
+
Description
+

Contains details about an error that occurred when deleting an approval rule .

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
message - String + The text of the error message.
type - DeletePurchaseOrderApprovalRuleErrorType + The error type.
+
+
+
+
+
Example
+ 
{"message": "xyz789", "type": "UNDEFINED"}
+
+
+
+
+
+
+
+ Types +
+

DeletePurchaseOrderApprovalRuleErrorType

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

UNDEFINED

+ 		+
+

NOT_FOUND

+ 		+
+
+
+
+
+
Example
+ 
"UNDEFINED"
+
+
+
+
+
+
+
+ Types +
+

DeletePurchaseOrderApprovalRuleInput

+
+
+
+
Description
+

Specifies the IDs of the approval rules to delete.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ approval_rule_uids - [ID]! + An array of purchase order approval rule IDs.
+
+
+
+
+
Example
+ 
{"approval_rule_uids": [4]}
+
+
+
+
+
+
+
+ Types +
+

DeletePurchaseOrderApprovalRuleOutput

+
+
+
+
Description
+

Contains any errors encountered while attempting to delete approval rules.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
errors - [DeletePurchaseOrderApprovalRuleError]! + An array of error messages encountered while performing the operation.
+
+
+
+
+
Example
+ 
{"errors": [DeletePurchaseOrderApprovalRuleError]}
+
+
+
+
+
+
+
+ Types +
+

DeleteRequisitionListItemsOutput

+
+
+
+
Description
+

Output of the request to remove items from the requisition list.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
requisition_list - RequisitionList + The requisition list after removing items.
+
+
+
+
+
Example
+ 
{"requisition_list": RequisitionList}
+
+
+
+
+
+
+
+ Types +
+

DeleteRequisitionListOutput

+
+
+
+
Description
+

Indicates whether the request to delete the requisition list was successful.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
requisition_lists - RequisitionLists + The customer's requisition lists after deleting a requisition list.
status - Boolean! + Indicates whether the request to delete the requisition list was successful.
+
+
+
+
+
Example
+ 
{"requisition_lists": RequisitionLists, "status": false}
+
+
+
+
+
+
+
+ Types +
+

DeleteWishlistOutput

+
+
+
+
Description
+

Contains the status of the request to delete a wish list and an array of the customer's remaining wish lists.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
status - Boolean! + Indicates whether the wish list was deleted.
wishlists - [Wishlist]! + A list of undeleted wish lists.
+
+
+
+
+
Example
+ 
{"status": true, "wishlists": [Wishlist]}
+
+
+
+
+
+
+
+ Types +
+

Discount

+
+
+
+
Description
+

Specifies the discount type and value for quote line item.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
amount - Money! + The amount of the discount.
applied_to - CartDiscountType! + The type of the entity the discount is applied to.
coupon - AppliedCoupon + The coupon related to the discount.
is_discounting_locked - Boolean + Is quote discounting locked for line item.
label - String! + A description of the discount.
type - String + Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL.
value - Float + Quote line item discount value.
+
+
+
+
+
Example
+ 
{
+  "amount": Money,
+  "applied_to": "ITEM",
+  "coupon": AppliedCoupon,
+  "is_discounting_locked": false,
+  "label": "abc123",
+  "type": "xyz789",
+  "value": 987.65
+}
+
+
+
+
+
+
+
+ Types +
+

DownloadableCartItem

+
+
+
+
Description
+

An implementation for downloadable product cart items.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
customizable_options - [SelectedCustomizableOption]! + An array containing the customizable options the shopper selected.
discount - [Discount] + Contains discount for quote line item.
errors - [CartItemError] + An array of errors encountered while loading the cart item
id - String! + + Use uid instead. +
is_available - Boolean! + True if requested quantity is less than available stock, false otherwise.
links - [DownloadableProductLinks] + An array containing information about the links for the downloadable product added to the cart.
max_qty - Float + Line item max qty in quote template
min_qty - Float + Line item min qty in quote template
not_available_message - String + Message to display when the product is not available with this selected option.
note_from_buyer - [ItemNote] + The buyer's quote line item note.
note_from_seller - [ItemNote] + The seller's quote line item note.
prices - CartItemPrices + Contains details about the price of the item, including taxes and discounts.
product - ProductInterface! + Details about an item in the cart.
quantity - Float! + The quantity of this item in the cart.
samples - [DownloadableProductSamples] + An array containing information about samples of the selected downloadable product.
uid - ID! + The unique ID for a CartItemInterface object.
+
+
+
+
+
Example
+ 
{
+  "customizable_options": [SelectedCustomizableOption],
+  "discount": [Discount],
+  "errors": [CartItemError],
+  "id": "xyz789",
+  "is_available": false,
+  "links": [DownloadableProductLinks],
+  "max_qty": 987.65,
+  "min_qty": 987.65,
+  "not_available_message": "xyz789",
+  "note_from_buyer": [ItemNote],
+  "note_from_seller": [ItemNote],
+  "prices": CartItemPrices,
+  "product": ProductInterface,
+  "quantity": 123.45,
+  "samples": [DownloadableProductSamples],
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

DownloadableCreditMemoItem

+
+
+
+
Description
+

Defines downloadable product options for CreditMemoItemInterface.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
discounts - [Discount] + Details about the final discount amount for the base product, including discounts on options.
downloadable_links - [DownloadableItemsLinks] + A list of downloadable links that are refunded from the downloadable product.
id - ID! + The unique ID for a CreditMemoItemInterface object.
order_item - OrderItemInterface + The order item the credit memo is applied to.
product_name - String + The name of the base product.
product_sale_price - Money! + The sale price for the base product, including selected options.
product_sku - String! + The SKU of the base product.
quantity_refunded - Float + The number of refunded items.
+
+
+
+
+
Example
+ 
{
+  "discounts": [Discount],
+  "downloadable_links": [DownloadableItemsLinks],
+  "id": "4",
+  "order_item": OrderItemInterface,
+  "product_name": "xyz789",
+  "product_sale_price": Money,
+  "product_sku": "xyz789",
+  "quantity_refunded": 987.65
+}
+
+
+
+
+
+
+
+ Types +
+

DownloadableFileTypeEnum

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

FILE

+ 		+ sample_url serves to get the downloadable sample +
+

URL

+ 		+ sample_url serves to get the downloadable sample +
+
+
+
+
+
Example
+ 
"FILE"
+
+
+
+
+
+
+
+ Types +
+

DownloadableInvoiceItem

+
+
+
+
Description
+

Defines downloadable product options for InvoiceItemInterface.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
discounts - [Discount] + Information about the final discount amount for the base product, including discounts on options.
downloadable_links - [DownloadableItemsLinks] + A list of downloadable links that are invoiced from the downloadable product.
id - ID! + The unique ID for an InvoiceItemInterface object.
order_item - OrderItemInterface + Details about an individual order item.
product_name - String + The name of the base product.
product_sale_price - Money! + The sale price for the base product including selected options.
product_sku - String! + The SKU of the base product.
quantity_invoiced - Float + The number of invoiced items.
+
+
+
+
+
Example
+ 
{
+  "discounts": [Discount],
+  "downloadable_links": [DownloadableItemsLinks],
+  "id": 4,
+  "order_item": OrderItemInterface,
+  "product_name": "abc123",
+  "product_sale_price": Money,
+  "product_sku": "abc123",
+  "quantity_invoiced": 987.65
+}
+
+
+
+
+
+ +
+
+ Types +
+

DownloadableOrderItem

+
+
+
+
Description
+

Defines downloadable product options for OrderItemInterface.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
discounts - [Discount] + The final discount information for the product.
downloadable_links - [DownloadableItemsLinks] + A list of downloadable links that are ordered from the downloadable product.
eligible_for_return - Boolean + Indicates whether the order item is eligible to be in a return request.
entered_options - [OrderItemOption] + The entered option for the base product, such as a logo or image.
gift_message - GiftMessage + The selected gift message for the order item
gift_wrapping - GiftWrapping + The selected gift wrapping for the order item.
id - ID! + The unique ID for an OrderItemInterface object.
prices - OrderItemPrices + Contains details about the price of the item, including taxes and discounts.
product - ProductInterface + The ProductInterface object, which contains details about the base product
product_name - String + The name of the base product.
product_sale_price - Money! + The sale price of the base product, including selected options.
product_sku - String! + The SKU of the base product.
product_type - String + The type of product, such as simple, configurable, etc.
product_url_key - String + URL key of the base product.
quantity_canceled - Float + The number of canceled items.
quantity_invoiced - Float + The number of invoiced items.
quantity_ordered - Float + The number of units ordered for this item.
quantity_refunded - Float + The number of refunded items.
quantity_return_requested - Float + The requested return quantity of the item.
quantity_returned - Float + The number of returned items.
quantity_shipped - Float + The number of shipped items.
selected_options - [OrderItemOption] + The selected options for the base product, such as color or size.
status - String + The status of the order item.
+
+
+
+
+
Example
+ 
{
+  "discounts": [Discount],
+  "downloadable_links": [DownloadableItemsLinks],
+  "eligible_for_return": true,
+  "entered_options": [OrderItemOption],
+  "gift_message": GiftMessage,
+  "gift_wrapping": GiftWrapping,
+  "id": 4,
+  "prices": OrderItemPrices,
+  "product": ProductInterface,
+  "product_name": "xyz789",
+  "product_sale_price": Money,
+  "product_sku": "xyz789",
+  "product_type": "abc123",
+  "product_url_key": "xyz789",
+  "quantity_canceled": 123.45,
+  "quantity_invoiced": 123.45,
+  "quantity_ordered": 123.45,
+  "quantity_refunded": 123.45,
+  "quantity_return_requested": 123.45,
+  "quantity_returned": 987.65,
+  "quantity_shipped": 987.65,
+  "selected_options": [OrderItemOption],
+  "status": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

DownloadableProduct

+
+
+
+
Description
+

Defines a product that the shopper downloads.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
activity - String + + Use the custom_attributes field instead. +
attribute_set_id - Int + The attribute set assigned to the product. The field should not be used on the storefront. +
canonical_url - String + The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface] + The categories assigned to a product.
category_gear - String + + Use the custom_attributes field instead. +
climate - String + + Use the custom_attributes field instead. +
collar - String + + Use the custom_attributes field instead. +
color - Int + + Use the custom_attributes field instead. +
country_of_manufacture - String + The product's country of origin.
created_at - String + Timestamp indicating when the product was created. The field should not be used on the storefront. +
crosssell_products - [ProductInterface] + An array of cross-sell products.
custom_attributesV2 - ProductCustomAttributes + Product custom attributes.
+
+
Arguments
+
+
+
filters - AttributeFilterInput +
+
+
+
+
description - ComplexTextValue + Detailed information about the product. The value can include simple HTML tags.
downloadable_product_links - [DownloadableProductLinks] + An array containing information about the links for this downloadable product.
downloadable_product_samples - [DownloadableProductSamples] + An array containing information about samples of this downloadable product.
eco_collection - Int + + Use the custom_attributes field instead. +
erin_recommends - Int + + Use the custom_attributes field instead. +
features_bags - String + + Use the custom_attributes field instead. +
format - Int + + Use the custom_attributes field instead. +
gender - String + + Use the custom_attributes field instead. +
gift_message_available - Boolean! + Returns a value indicating gift message availability for the product.
gift_wrapping_available - Boolean! + Returns a value indicating gift wrapping availability for the product.
gift_wrapping_price - Money + Returns value and currency indicating gift wrapping price for the product.
id - Int + The ID number assigned to the product. Use the uid field instead. +
image - ProductImage + The relative path to the main image on the product page.
is_returnable - String + Indicates whether the product can be returned.
links_purchased_separately - Int + A value of 1 indicates that each link in the array must be purchased separately.
links_title - String + The heading above the list of downloadable products.
manufacturer - Int + A number representing the product's manufacturer. Use the custom_attributes field instead. +
material - String + + Use the custom_attributes field instead. +
max_sale_qty - Float + Maximum Qty Allowed in Shopping Cart
media_gallery - [MediaGalleryInterface] + An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry] + An array of MediaGalleryEntry objects. Use media_gallery instead. +
meta_description - String + A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String + A comma-separated list of keywords that are visible only to search engines.
meta_title - String + A string that is displayed in the title bar and tab of the browser and in search results lists.
min_sale_qty - Float + Minimum Qty Allowed in Shopping Cart
name - String + The product name. Customers use this name to identify the product.
new - Int + + Use the custom_attributes field instead. +
new_from_date - String + The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String + The end date for new product listings.
only_x_left_in_stock - Float + Product stock only x left count
options - [CustomizableOptionInterface] + An array of options for a customizable product.
options_container - String + If the product has multiple options, determines where they appear on the product page.
pattern - String + + Use the custom_attributes field instead. +
performance_fabric - Int + + Use the custom_attributes field instead. +
price - ProductPrices + Indicates the price of an item. Use price_range for product price information. +
price_range - PriceRange! + The range of prices for the product
price_tiers - [TierPrice] + An array of TierPrice objects.
product_links - [ProductLinksInterface] + An array of ProductLinks objects.
purpose - Int + + Use the custom_attributes field instead. +
quantity - Float + Amount of available stock
rating_summary - Float! + The average of all the ratings given to the product.
redirect_code - Int! + Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface] + An array of related products.
relative_url - String + The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int! + The total count of all the reviews given to the product.
reviews - ProductReviews! + The list of products reviews.
+
+
Arguments
+
+
+
pageSize - Int +
+

The maximum number of results to return at once. The default is 20.

+
+
+
currentPage - Int +
+

The page of results to return. The default is 1.

+
+
+
+
sale - Int + + Use the custom_attributes field instead. +
short_description - ComplexTextValue + A short description of the product. Its use depends on the theme.
size - Int + + Use the custom_attributes field instead. +
sku - String + A number or code assigned to a product to identify the product, options, price, and manufacturer.
sleeve - String + + Use the custom_attributes field instead. +
small_image - ProductImage + The relative path to the small image, which is used on catalog pages.
special_from_date - String + The beginning date that a product has a special price. The field should not be used on the storefront. +
special_price - Float + The discounted price of the product.
special_to_date - String + The end date for a product with a special price.
staged - Boolean! + Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus + Stock status of the product
strap_bags - String + + Use the custom_attributes field instead. +
style_bags - String + + Use the custom_attributes field instead. +
style_bottom - String + + Use the custom_attributes field instead. +
style_general - String + + Use the custom_attributes field instead. +
swatch_image - String + The file name of a swatch image.
thumbnail - ProductImage + The relative path to the product's thumbnail image.
tier_price - Float + The price when tier pricing is in effect and the items purchased threshold has been reached. Use price_tiers for product tier price information. +
tier_prices - [ProductTierPrices] + An array of ProductTierPrices objects. Use price_tiers for product tier price information. +
type - UrlRewriteEntityTypeEnum + One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String + One of simple, virtual, bundle, downloadable, grouped, or configurable. Use __typename instead. +
uid - ID! + The unique ID for a ProductInterface object.
updated_at - String + Timestamp indicating when the product was updated. The field should not be used on the storefront. +
upsell_products - [ProductInterface] + An array of up-sell products.
url_key - String + The part of the URL that identifies the product
url_path - String + + Use product's canonical_url or url rewrites instead +
url_rewrites - [UrlRewrite] + URL rewrites list
url_suffix - String + The part of the product URL that is appended after the url key
websites - [Website] + An array of websites in which the product is available. The field should not be used on the storefront. +
+
+
+
+
+
Example
+ 
{
+  "activity": "abc123",
+  "attribute_set_id": 987,
+  "canonical_url": "xyz789",
+  "categories": [CategoryInterface],
+  "category_gear": "xyz789",
+  "climate": "abc123",
+  "collar": "xyz789",
+  "color": 123,
+  "country_of_manufacture": "xyz789",
+  "created_at": "abc123",
+  "crosssell_products": [ProductInterface],
+  "custom_attributesV2": ProductCustomAttributes,
+  "description": ComplexTextValue,
+  "downloadable_product_links": [
+    DownloadableProductLinks
+  ],
+  "downloadable_product_samples": [
+    DownloadableProductSamples
+  ],
+  "eco_collection": 123,
+  "erin_recommends": 123,
+  "features_bags": "xyz789",
+  "format": 987,
+  "gender": "xyz789",
+  "gift_message_available": true,
+  "gift_wrapping_available": true,
+  "gift_wrapping_price": Money,
+  "id": 987,
+  "image": ProductImage,
+  "is_returnable": "xyz789",
+  "links_purchased_separately": 123,
+  "links_title": "abc123",
+  "manufacturer": 987,
+  "material": "abc123",
+  "max_sale_qty": 987.65,
+  "media_gallery": [MediaGalleryInterface],
+  "media_gallery_entries": [MediaGalleryEntry],
+  "meta_description": "xyz789",
+  "meta_keyword": "xyz789",
+  "meta_title": "abc123",
+  "min_sale_qty": 123.45,
+  "name": "xyz789",
+  "new": 123,
+  "new_from_date": "abc123",
+  "new_to_date": "abc123",
+  "only_x_left_in_stock": 987.65,
+  "options": [CustomizableOptionInterface],
+  "options_container": "xyz789",
+  "pattern": "xyz789",
+  "performance_fabric": 987,
+  "price": ProductPrices,
+  "price_range": PriceRange,
+  "price_tiers": [TierPrice],
+  "product_links": [ProductLinksInterface],
+  "purpose": 987,
+  "quantity": 987.65,
+  "rating_summary": 987.65,
+  "redirect_code": 123,
+  "related_products": [ProductInterface],
+  "relative_url": "xyz789",
+  "review_count": 987,
+  "reviews": ProductReviews,
+  "sale": 987,
+  "short_description": ComplexTextValue,
+  "size": 987,
+  "sku": "abc123",
+  "sleeve": "abc123",
+  "small_image": ProductImage,
+  "special_from_date": "abc123",
+  "special_price": 123.45,
+  "special_to_date": "xyz789",
+  "staged": false,
+  "stock_status": "IN_STOCK",
+  "strap_bags": "abc123",
+  "style_bags": "xyz789",
+  "style_bottom": "abc123",
+  "style_general": "abc123",
+  "swatch_image": "abc123",
+  "thumbnail": ProductImage,
+  "tier_price": 123.45,
+  "tier_prices": [ProductTierPrices],
+  "type": "CMS_PAGE",
+  "type_id": "abc123",
+  "uid": "4",
+  "updated_at": "xyz789",
+  "upsell_products": [ProductInterface],
+  "url_key": "xyz789",
+  "url_path": "abc123",
+  "url_rewrites": [UrlRewrite],
+  "url_suffix": "abc123",
+  "websites": [Website]
+}
+
+
+
+
+
+
+
+ Types +
+

DownloadableProductCartItemInput

+
+
+
+
Description
+

Defines a single downloadable product.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ customizable_options - [CustomizableOptionInput] + The ID and value of the option.
+ data - CartItemInput! + The quantity and SKU of the downloadable product.
+ downloadable_product_links - [DownloadableProductLinksInput] + An array of objects containing the link_id of the downloadable product link.
+
+
+
+
+
Example
+ 
{
+  "customizable_options": [CustomizableOptionInput],
+  "data": CartItemInput,
+  "downloadable_product_links": [
+    DownloadableProductLinksInput
+  ]
+}
+
+
+
+
+
+ +
+
+ Types +
+

DownloadableProductLinksInput

+
+
+
+
Description
+

Contains the link ID for the downloadable product.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ link_id - Int! + The unique ID of the downloadable product link.
+
+
+
+
+
Example
+ 
{"link_id": 987}
+
+
+
+
+
+
+
+ Types +
+

DownloadableProductSamples

+
+
+
+
Description
+

Defines characteristics of a downloadable product.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
id - Int + + This information should not be exposed on frontend. +
sample_file - String + + sample_url serves to get the downloadable sample +
sample_type - DownloadableFileTypeEnum + + sample_url serves to get the downloadable sample +
sample_url - String + The full URL to the downloadable sample.
sort_order - Int + A number indicating the sort order.
title - String + The display name of the sample.
+
+
+
+
+
Example
+ 
{
+  "id": 123,
+  "sample_file": "abc123",
+  "sample_type": "FILE",
+  "sample_url": "abc123",
+  "sort_order": 987,
+  "title": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

DownloadableRequisitionListItem

+
+
+
+
Description
+

Contains details about downloadable products added to a requisition list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
customizable_options - [SelectedCustomizableOption]! + Selected custom options for an item in the requisition list.
links - [DownloadableProductLinks] + An array of links for downloadable products in the requisition list.
product - ProductInterface! + Details about a requisition list item.
quantity - Float! + The quantity of the product added to the requisition list.
samples - [DownloadableProductSamples] + An array of links to downloadable product samples.
uid - ID! + The unique ID of an item in a requisition list.
+
+
+
+
+
Example
+ 
{
+  "customizable_options": [SelectedCustomizableOption],
+  "links": [DownloadableProductLinks],
+  "product": ProductInterface,
+  "quantity": 987.65,
+  "samples": [DownloadableProductSamples],
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

DownloadableWishlistItem

+
+
+
+
Description
+

A downloadable product wish list item.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
added_at - String! + The date and time the item was added to the wish list.
customizable_options - [SelectedCustomizableOption]! + Custom options selected for the wish list item.
description - String + The description of the item.
id - ID! + The unique ID for a WishlistItemInterface object.
links_v2 - [DownloadableProductLinks] + An array containing information about the selected links.
product - ProductInterface + Product details of the wish list item.
quantity - Float! + The quantity of this wish list item.
samples - [DownloadableProductSamples] + An array containing information about the selected samples.
+
+
+
+
+
Example
+ 
{
+  "added_at": "xyz789",
+  "customizable_options": [SelectedCustomizableOption],
+  "description": "xyz789",
+  "id": "4",
+  "links_v2": [DownloadableProductLinks],
+  "product": ProductInterface,
+  "quantity": 987.65,
+  "samples": [DownloadableProductSamples]
+}
+
+
+
+
+
+
+
+ Types +
+

DuplicateNegotiableQuoteInput

+
+
+
+
Description
+

Identifies a quote to be duplicated

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ duplicated_quote_uid - ID! + ID for the newly duplicated quote.
+ quote_uid - ID! + ID of the quote to be duplicated.
+
+
+
+
+
Example
+ 
{
+  "duplicated_quote_uid": "4",
+  "quote_uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

DuplicateNegotiableQuoteOutput

+
+
+
+
Description
+

Contains the newly created negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
quote - NegotiableQuote + Negotiable Quote resulting from duplication operation.
+
+
+
+
+
Example
+ 
{"quote": NegotiableQuote}
+
+
+
+
+
+
+
+ Types +
+

DynamicBlock

+
+
+
+
Description
+

Contains a single dynamic block.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
content - ComplexTextValue! + The renderable HTML code of the dynamic block.
uid - ID! + The unique ID of a DynamicBlock object.
+
+
+
+
+
Example
+ 
{"content": ComplexTextValue, "uid": 4}
+
+
+
+
+
+
+
+ Types +
+

DynamicBlockLocationEnum

+
+
+
+
Description
+

Indicates the locations the dynamic block can be placed. If this field is not specified, the query returns all locations.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

CONTENT

+ 		+
+

HEADER

+ 		+
+

FOOTER

+ 		+
+

LEFT

+ 		+
+

RIGHT

+ 		+
+
+
+
+
+
Example
+ 
"CONTENT"
+
+
+
+
+
+
+
+ Types +
+

DynamicBlockTypeEnum

+
+
+
+
Description
+

Indicates the selected Dynamic Blocks Rotator inline widget.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

SPECIFIED

+ 		+
+

CART_PRICE_RULE_RELATED

+ 		+
+

CATALOG_PRICE_RULE_RELATED

+ 		+
+
+
+
+
+
Example
+ 
"SPECIFIED"
+
+
+
+
+
+
+
+ Types +
+

DynamicBlocks

+
+
+
+
Description
+

Contains an array of dynamic blocks.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items - [DynamicBlock]! + An array containing individual dynamic blocks.
page_info - SearchResultPageInfo + Metadata for pagination rendering.
total_count - Int! + The number of returned dynamic blocks.
+
+
+
+
+
Example
+ 
{
+  "items": [DynamicBlock],
+  "page_info": SearchResultPageInfo,
+  "total_count": 123
+}
+
+
+
+
+
+
+
+ Types +
+

DynamicBlocksFilterInput

+
+
+
+
Description
+

Defines the dynamic block filter. The filter can identify the block type, location and IDs to return.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ dynamic_block_uids - [ID] + An array of dynamic block UIDs to filter on.
+ locations - [DynamicBlockLocationEnum] + An array indicating the locations the dynamic block can be placed.
+ type - DynamicBlockTypeEnum! + A value indicating the type of dynamic block to filter on.
+
+
+
+
+
Example
+ 
{
+  "dynamic_block_uids": ["4"],
+  "locations": ["CONTENT"],
+  "type": "SPECIFIED"
+}
+
+
+
+
+
+
+
+ Types +
+

EnteredCustomAttributeInput

+
+
+
+
Description
+

Contains details about a custom text attribute that the buyer entered.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ attribute_code - String! + A string that identifies the entered custom attribute.
+ value - String! + The text or other entered value.
+
+
+
+
+
Example
+ 
{
+  "attribute_code": "xyz789",
+  "value": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

EnteredOptionInput

+
+
+
+
Description
+

Defines a customer-entered option.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ uid - ID! + The unique ID for a CustomizableOptionInterface object, such as a CustomizableFieldOption, CustomizableFileOption, or CustomizableAreaOption object.
+ value - String! + Text the customer entered.
+
+
+
+
+
Example
+ 
{"uid": 4, "value": "abc123"}
+
+
+
+
+
+
+
+ Types +
+

EntityUrl

+
+
+
+
Description
+

Contains the uid, relative_url, and type attributes.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
canonical_url - String + + Use relative_url instead. +
entity_uid - ID + The unique ID for a ProductInterface, CategoryInterface, CmsPage, or similar object associated with the specified URL. This could be a product, category, or CMS page UID.
id - Int + The ID assigned to the object associated with the specified url. This could be a product ID, category ID, or page ID. Use entity_uid instead. +
redirectCode - Int + Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
relative_url - String + The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
type - UrlRewriteEntityTypeEnum + One of PRODUCT, CATEGORY, or CMS_PAGE.
+
+
+
+
+
Example
+ 
{
+  "canonical_url": "xyz789",
+  "entity_uid": 4,
+  "id": 123,
+  "redirectCode": 123,
+  "relative_url": "xyz789",
+  "type": "CMS_PAGE"
+}
+
+
+
+
+
+
+
+ Types +
+

Error

+
+
+
+
Description
+

An error encountered while adding an item to the the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
code - CartUserInputErrorType! + A cart-specific error code.
message - String! + A localized error message.
+
+
+
Possible Types
+ + + + + + + + + + + + + + +
Error Types
+

CartUserInputError

+
+

InsufficientStockError

+
+
+
+
+
+
Example
+ 
{
+  "code": "PRODUCT_NOT_FOUND",
+  "message": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

ErrorInterface

+
+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
message - String! + The returned error message.
+
+
+
Possible Types
+ + + + + + + + + + + + + + + + + +
ErrorInterface Types
+

NoSuchEntityUidError

+
+

InternalError

+
+

NegotiableQuoteInvalidStateError

+
+
+
+
+
+
Example
+ 
{"message": "xyz789"}
+
+
+
+
+
+
+
+ Types +
+

EstimateAddressInput

+
+
+
+
Description
+

Contains details about an address.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ country_code - CountryCodeEnum! + The two-letter code representing the customer's country.
+ postcode - String + The customer's ZIP or postal code.
+ region - CustomerAddressRegionInput + An object containing the region name, region code, and region ID.
+
+
+
+
+
Example
+ 
{
+  "country_code": "AF",
+  "postcode": "xyz789",
+  "region": CustomerAddressRegionInput
+}
+
+
+
+
+
+
+
+ Types +
+

EstimateTotalsInput

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ address - EstimateAddressInput! + Customer's address to estimate totals.
+ cart_id - String! + The unique ID of the cart to query.
+ shipping_method - ShippingMethodInput + Selected shipping method to estimate totals.
+
+
+
+
+
Example
+ 
{
+  "address": EstimateAddressInput,
+  "cart_id": "abc123",
+  "shipping_method": ShippingMethodInput
+}
+
+
+
+
+
+
+
+ Types +
+

EstimateTotalsOutput

+
+
+
+
Description
+

Estimate totals output.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart + Cart after totals estimation
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

ExchangeExternalCustomerTokenInput

+
+
+
+
Description
+

Contains details about external customer.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ customer - CustomerCreateInput! + An input object that defines the customer characteristics to update.
+
+
+
+
+
Example
+ 
{"customer": CustomerCreateInput}
+
+
+
+
+
+
+
+ Types +
+

ExchangeExternalCustomerTokenOutput

+
+
+
+
Description
+

Contains customer token for external customer.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
customer - Customer! + Return detailed information about a customer account.
token - String! + The customer authorization token.
+
+
+
+
+
Example
+ 
{
+  "customer": Customer,
+  "token": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

ExchangeRate

+
+
+
+
Description
+

Lists the exchange rate.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
currency_to - String + Specifies the store’s default currency to exchange to.
rate - Float + The exchange rate for the store’s default currency.
+
+
+
+
+
Example
+ 
{"currency_to": "xyz789", "rate": 987.65}
+
+
+
+
+
+
+
+ Types +
+

FastlaneConfig

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
code - String + The payment method code as defined in the payment gateway
is_visible - Boolean + Indicates whether the payment method is displayed
payment_intent - String + Defines the payment intent (Authorize or Capture
payment_source - String + The payment source for the payment method
sdk_params - [SDKParams] + The PayPal parameters required to load the JS SDK
sort_order - String + The relative order the payment method is displayed on the checkout page
three_ds_mode - ThreeDSMode + 3DS mode
title - String + The name displayed for the payment method
+
+
+
+
+
Example
+ 
{
+  "code": "xyz789",
+  "is_visible": false,
+  "payment_intent": "abc123",
+  "payment_source": "abc123",
+  "sdk_params": [SDKParams],
+  "sort_order": "abc123",
+  "three_ds_mode": "OFF",
+  "title": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

FastlaneMethodInput

+
+
+
+
Description
+

Fastlane Payment inputs

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ payment_source - String + The payment source for the payment method
+ paypal_fastlane_token - String + The single use token from Fastlane
+
+
+
+
+
Example
+ 
{
+  "payment_source": "abc123",
+  "paypal_fastlane_token": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

FilterEqualTypeInput

+
+
+
+
Description
+

Defines a filter that matches the input exactly.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ eq - String + Use this attribute to exactly match the specified string. For example, to filter on a specific category ID, specify a value such as 5.
+ in - [String] + Use this attribute to filter on an array of values. For example, to filter on category IDs 4, 5, and 6, specify a value of ["4", "5", "6"].
+
+
+
+
+
Example
+ 
{
+  "eq": "abc123",
+  "in": ["xyz789"]
+}
+
+
+
+
+
+
+
+ Types +
+

FilterMatchTypeEnum

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

FULL

+ 		+
+

PARTIAL

+ 		+
+
+
+
+
+
Example
+ 
"FULL"
+
+
+
+
+
+
+
+ Types +
+

FilterMatchTypeInput

+
+
+
+
Description
+

Defines a filter that performs a fuzzy search.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ match - String + Use this attribute to fuzzy match the specified string. For example, to filter on a specific SKU, specify a value such as 24-MB01.
+ match_type - FilterMatchTypeEnum + Filter match type for fine-tuned results. Possible values FULL or PARTIAL. If match_type is not provided, returned results will default to FULL match.
+
+
+
+
+
Example
+ 
{"match": "abc123", "match_type": "FULL"}
+
+
+
+
+
+
+
+ Types +
+

FilterRangeTypeInput

+
+
+
+
Description
+

Defines a filter that matches a range of values, such as prices or dates.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ from - String + Use this attribute to specify the lowest possible value in the range.
+ to - String + Use this attribute to specify the highest possible value in the range.
+
+
+
+
+
Example
+ 
{
+  "from": "abc123",
+  "to": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

FilterStringTypeInput

+
+
+
+
Description
+

Defines a filter for an input string.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ eq - String + Filters items that are exactly the same as the specified string.
+ in - [String] + Filters items that are exactly the same as entries specified in an array of strings.
+ match - String + Defines a filter that performs a fuzzy search using the specified string.
+
+
+
+
+
Example
+ 
{
+  "eq": "xyz789",
+  "in": ["abc123"],
+  "match": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

FilterTypeInput

+
+
+
+
Description
+

Defines the comparison operators that can be used in a filter.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ eq - String + Equals.
+ finset - [String] + +
+ from - String + From. Must be used with the to field.
+ gt - String + Greater than.
+ gteq - String + Greater than or equal to.
+ in - [String] + In. The value can contain a set of comma-separated values.
+ like - String + Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters.
+ lt - String + Less than.
+ lteq - String + Less than or equal to.
+ moreq - String + More than or equal to.
+ neq - String + Not equal to.
+ nin - [String] + Not in. The value can contain a set of comma-separated values.
+ notnull - String + Not null.
+ null - String + Is null.
+ to - String + To. Must be used with the from field.
+
+
+
+
+
Example
+ 
{
+  "eq": "abc123",
+  "finset": ["abc123"],
+  "from": "abc123",
+  "gt": "xyz789",
+  "gteq": "abc123",
+  "in": ["xyz789"],
+  "like": "xyz789",
+  "lt": "abc123",
+  "lteq": "xyz789",
+  "moreq": "abc123",
+  "neq": "xyz789",
+  "nin": ["abc123"],
+  "notnull": "abc123",
+  "null": "xyz789",
+  "to": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

FixedProductTax

+
+
+
+
Description
+

A single FPT that can be applied to a product price.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
amount - Money + The amount of the Fixed Product Tax.
label - String + The display label assigned to the Fixed Product Tax.
+
+
+
+
+
Example
+ 
{
+  "amount": Money,
+  "label": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

FixedProductTaxDisplaySettings

+
+
+
+
Description
+

Lists display settings for the Fixed Product Tax.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

INCLUDE_FPT_WITHOUT_DETAILS

+ 		The displayed price includes the FPT amount without displaying the ProductPrice.fixed_product_taxes values. This value corresponds to 'Including FPT only'.
+

INCLUDE_FPT_WITH_DETAILS

+ 		The displayed price includes the FPT amount while displaying the values of ProductPrice.fixed_product_taxes separately. This value corresponds to 'Including FPT and FPT description'.
+

EXCLUDE_FPT_AND_INCLUDE_WITH_DETAILS

+ 		The displayed price does not include the FPT amount. The values of ProductPrice.fixed_product_taxes and the price including the FPT are displayed separately. This value corresponds to 'Excluding FPT, Including FPT description and final price.'
+

EXCLUDE_FPT_WITHOUT_DETAILS

+ 		The displayed price does not include the FPT amount. The values from ProductPrice.fixed_product_taxes are not displayed. This value corresponds to 'Excluding FPT'.
+

FPT_DISABLED

+ 		The FPT feature is not enabled. You can omit ProductPrice.fixed_product_taxes from your query.
+
+
+
+
+
Example
+ 
"INCLUDE_FPT_WITHOUT_DETAILS"
+
+
+
+
+
+
+
+ Types +
+

Float

+
+
+
+
Description
+

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

+
+
+
+
+
Example
+ 
987.65
+
+
+
+
+
+
+
+ Types +
+

GenerateCustomerTokenAsAdminInput

+
+
+
+
Description
+

Identifies which customer requires remote shopping assistance.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ customer_email - String! + The email address of the customer requesting remote shopping assistance.
+
+
+
+
+
Example
+ 
{"customer_email": "xyz789"}
+
+
+
+
+
+
+
+ Types +
+

GenerateCustomerTokenAsAdminOutput

+
+
+
+
Description
+

Contains the generated customer token.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
customer_token - String! + The generated customer token.
+
+
+
+
+
Example
+ 
{"customer_token": "xyz789"}
+
+
+
+
+
+
+
+ Types +
+

GenerateNegotiableQuoteFromTemplateInput

+
+
+
+
Description
+

Specifies the template id, from which to generate quote from.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ template_id - ID! + The unique ID of a NegotiableQuoteTemplate object.
+
+
+
+
+
Example
+ 
{"template_id": 4}
+
+
+
+
+
+
+
+ Types +
+

GenerateNegotiableQuoteFromTemplateOutput

+
+
+
+
Description
+

Contains the generated negotiable quote id.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
negotiable_quote_uid - ID! + The unique ID of a generated NegotiableQuote object.
+
+
+
+
+
Example
+ 
{"negotiable_quote_uid": 4}
+
+
+
+
+
+
+
+ Types +
+

GetPaymentSDKOutput

+
+
+
+
Description
+

Gets the payment SDK URLs and values

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
sdkParams - [PaymentSDKParamsItem] + The payment SDK parameters
+
+
+
+
+
Example
+ 
{"sdkParams": [PaymentSDKParamsItem]}
+
+
+
+
+
+
+
+ Types +
+

GiftCardAccount

+
+
+
+
Description
+

Contains details about the gift card account.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
balance - Money + The balance remaining on the gift card.
code - String + The gift card account code.
expiration_date - String + The expiration date of the gift card.
+
+
+
+
+
Example
+ 
{
+  "balance": Money,
+  "code": "abc123",
+  "expiration_date": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

GiftCardAccountInput

+
+
+
+
Description
+

Contains the gift card code.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ gift_card_code - String! + The applied gift card code.
+
+
+
+
+
Example
+ 
{"gift_card_code": "xyz789"}
+
+
+
+
+
+
+
+ Types +
+

GiftCardAmounts

+
+
+
+
Description
+

Contains the value of a gift card, the website that generated the card, and related information.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
attribute_id - Int + An internal attribute ID.
uid - ID! + The unique ID for a GiftCardAmounts object.
value - Float + The value of the gift card.
value_id - Int + An ID that is assigned to each unique gift card amount. Use uid instead +
website_id - Int + The ID of the website that generated the gift card.
website_value - Float + The value of the gift card.
+
+
+
+
+
Example
+ 
{
+  "attribute_id": 987,
+  "uid": 4,
+  "value": 987.65,
+  "value_id": 987,
+  "website_id": 123,
+  "website_value": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

GiftCardCartItem

+
+
+
+
Description
+

Contains details about a gift card that has been added to a cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
amount - Money! + The amount and currency of the gift card.
available_gift_wrapping - [GiftWrapping]! + The list of available gift wrapping options for the cart item.
customizable_options - [SelectedCustomizableOption]! + An array of customizations applied to the gift card.
discount - [Discount] + Contains discount for quote line item.
errors - [CartItemError] + An array of errors encountered while loading the cart item
gift_message - GiftMessage + The entered gift message data for the gift card cart item
gift_wrapping - GiftWrapping + The selected gift wrapping option for the cart item.
id - String! + + Use uid instead. +
is_available - Boolean! + True if requested quantity is less than available stock, false otherwise.
max_qty - Float + Line item max qty in quote template
message - String + The message from the sender to the recipient.
min_qty - Float + Line item min qty in quote template
not_available_message - String + Message to display when the product is not available with this selected option.
note_from_buyer - [ItemNote] + The buyer's quote line item note.
note_from_seller - [ItemNote] + The seller's quote line item note.
prices - CartItemPrices + Contains details about the price of the item, including taxes and discounts.
product - ProductInterface! + Details about an item in the cart.
quantity - Float! + The quantity of this item in the cart.
recipient_email - String + The email address of the person receiving the gift card.
recipient_name - String! + The name of the person receiving the gift card.
sender_email - String + The email address of the sender.
sender_name - String! + The name of the sender.
uid - ID! + The unique ID for a CartItemInterface object.
+
+
+
+
+
Example
+ 
{
+  "amount": Money,
+  "available_gift_wrapping": [GiftWrapping],
+  "customizable_options": [SelectedCustomizableOption],
+  "discount": [Discount],
+  "errors": [CartItemError],
+  "gift_message": GiftMessage,
+  "gift_wrapping": GiftWrapping,
+  "id": "abc123",
+  "is_available": true,
+  "max_qty": 123.45,
+  "message": "xyz789",
+  "min_qty": 123.45,
+  "not_available_message": "xyz789",
+  "note_from_buyer": [ItemNote],
+  "note_from_seller": [ItemNote],
+  "prices": CartItemPrices,
+  "product": ProductInterface,
+  "quantity": 123.45,
+  "recipient_email": "xyz789",
+  "recipient_name": "abc123",
+  "sender_email": "xyz789",
+  "sender_name": "xyz789",
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

GiftCardCreditMemoItem

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
discounts - [Discount] + Details about the final discount amount for the base product, including discounts on options.
gift_card - GiftCardItem + Selected gift card properties for a credit memo item.
id - ID! + The unique ID for a CreditMemoItemInterface object.
order_item - OrderItemInterface + The order item the credit memo is applied to.
product_name - String + The name of the base product.
product_sale_price - Money! + The sale price for the base product, including selected options.
product_sku - String! + The SKU of the base product.
quantity_refunded - Float + The number of refunded items.
+
+
+
+
+
Example
+ 
{
+  "discounts": [Discount],
+  "gift_card": GiftCardItem,
+  "id": "4",
+  "order_item": OrderItemInterface,
+  "product_name": "abc123",
+  "product_sale_price": Money,
+  "product_sku": "abc123",
+  "quantity_refunded": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

GiftCardInvoiceItem

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
discounts - [Discount] + Information about the final discount amount for the base product, including discounts on options.
gift_card - GiftCardItem + Selected gift card properties for an invoice item.
id - ID! + The unique ID for an InvoiceItemInterface object.
order_item - OrderItemInterface + Details about an individual order item.
product_name - String + The name of the base product.
product_sale_price - Money! + The sale price for the base product including selected options.
product_sku - String! + The SKU of the base product.
quantity_invoiced - Float + The number of invoiced items.
+
+
+
+
+
Example
+ 
{
+  "discounts": [Discount],
+  "gift_card": GiftCardItem,
+  "id": "4",
+  "order_item": OrderItemInterface,
+  "product_name": "abc123",
+  "product_sale_price": Money,
+  "product_sku": "abc123",
+  "quantity_invoiced": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

GiftCardItem

+
+
+
+
Description
+

Contains details about a gift card.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
message - String + The message from the sender to the recipient.
recipient_email - String + The email address of the receiver of a virtual gift card.
recipient_name - String + The name of the receiver of a physical or virtual gift card.
sender_email - String + The email address of the sender of a virtual gift card.
sender_name - String + The name of the sender of a physical or virtual gift card.
+
+
+
+
+
Example
+ 
{
+  "message": "abc123",
+  "recipient_email": "xyz789",
+  "recipient_name": "abc123",
+  "sender_email": "xyz789",
+  "sender_name": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

GiftCardOptions

+
+
+
+
Description
+

Contains details about the sender, recipient, and amount of a gift card.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
amount - Money + The amount and currency of the gift card.
custom_giftcard_amount - Money + The custom amount and currency of the gift card.
message - String + A message to the recipient.
recipient_email - String + The email address of the person receiving the gift card.
recipient_name - String + The name of the person receiving the gift card.
sender_email - String + The email address of the person sending the gift card.
sender_name - String + The name of the person sending the gift card.
+
+
+
+
+
Example
+ 
{
+  "amount": Money,
+  "custom_giftcard_amount": Money,
+  "message": "abc123",
+  "recipient_email": "abc123",
+  "recipient_name": "abc123",
+  "sender_email": "abc123",
+  "sender_name": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

GiftCardOrderItem

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
discounts - [Discount] + The final discount information for the product.
eligible_for_return - Boolean + Indicates whether the order item is eligible to be in a return request.
entered_options - [OrderItemOption] + The entered option for the base product, such as a logo or image.
gift_card - GiftCardItem + Selected gift card properties for an order item.
gift_message - GiftMessage + The selected gift message for the order item
gift_wrapping - GiftWrapping + The selected gift wrapping for the order item.
id - ID! + The unique ID for an OrderItemInterface object.
prices - OrderItemPrices + Contains details about the price of the item, including taxes and discounts.
product - ProductInterface + The ProductInterface object, which contains details about the base product
product_name - String + The name of the base product.
product_sale_price - Money! + The sale price of the base product, including selected options.
product_sku - String! + The SKU of the base product.
product_type - String + The type of product, such as simple, configurable, etc.
product_url_key - String + URL key of the base product.
quantity_canceled - Float + The number of canceled items.
quantity_invoiced - Float + The number of invoiced items.
quantity_ordered - Float + The number of units ordered for this item.
quantity_refunded - Float + The number of refunded items.
quantity_return_requested - Float + The requested return quantity of the item.
quantity_returned - Float + The number of returned items.
quantity_shipped - Float + The number of shipped items.
selected_options - [OrderItemOption] + The selected options for the base product, such as color or size.
status - String + The status of the order item.
+
+
+
+
+
Example
+ 
{
+  "discounts": [Discount],
+  "eligible_for_return": true,
+  "entered_options": [OrderItemOption],
+  "gift_card": GiftCardItem,
+  "gift_message": GiftMessage,
+  "gift_wrapping": GiftWrapping,
+  "id": 4,
+  "prices": OrderItemPrices,
+  "product": ProductInterface,
+  "product_name": "xyz789",
+  "product_sale_price": Money,
+  "product_sku": "abc123",
+  "product_type": "xyz789",
+  "product_url_key": "xyz789",
+  "quantity_canceled": 123.45,
+  "quantity_invoiced": 987.65,
+  "quantity_ordered": 987.65,
+  "quantity_refunded": 123.45,
+  "quantity_return_requested": 987.65,
+  "quantity_returned": 987.65,
+  "quantity_shipped": 123.45,
+  "selected_options": [OrderItemOption],
+  "status": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

GiftCardProduct

+
+
+
+
Description
+

Defines properties of a gift card.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
activity - String + + Use the custom_attributes field instead. +
allow_message - Boolean + Indicates whether the customer can provide a message to accompany the gift card.
allow_open_amount - Boolean + Indicates whether shoppers have the ability to set the value of the gift card.
attribute_set_id - Int + The attribute set assigned to the product. The field should not be used on the storefront. +
canonical_url - String + The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface] + The categories assigned to a product.
category_gear - String + + Use the custom_attributes field instead. +
climate - String + + Use the custom_attributes field instead. +
collar - String + + Use the custom_attributes field instead. +
color - Int + + Use the custom_attributes field instead. +
country_of_manufacture - String + The product's country of origin.
created_at - String + Timestamp indicating when the product was created. The field should not be used on the storefront. +
crosssell_products - [ProductInterface] + An array of cross-sell products.
custom_attributesV2 - ProductCustomAttributes + Product custom attributes.
+
+
Arguments
+
+
+
filters - AttributeFilterInput +
+
+
+
+
description - ComplexTextValue + Detailed information about the product. The value can include simple HTML tags.
eco_collection - Int + + Use the custom_attributes field instead. +
erin_recommends - Int + + Use the custom_attributes field instead. +
features_bags - String + + Use the custom_attributes field instead. +
format - Int + + Use the custom_attributes field instead. +
gender - String + + Use the custom_attributes field instead. +
gift_card_options - [CustomizableOptionInterface]! + An array of customizable gift card options.
gift_message_available - Boolean! + Returns a value indicating gift message availability for the product.
gift_wrapping_available - Boolean! + Returns a value indicating gift wrapping availability for the product.
gift_wrapping_price - Money + Returns value and currency indicating gift wrapping price for the product.
giftcard_amounts - [GiftCardAmounts] + An array that contains information about the values and ID of a gift card.
giftcard_type - GiftCardTypeEnum + An enumeration that specifies the type of gift card.
id - Int + The ID number assigned to the product. Use the uid field instead. +
image - ProductImage + The relative path to the main image on the product page.
is_redeemable - Boolean + Indicates whether the customer can redeem the value on the card for cash.
is_returnable - String + Indicates whether the product can be returned.
lifetime - Int + The number of days after purchase until the gift card expires. A null value means there is no limit.
manufacturer - Int + A number representing the product's manufacturer. Use the custom_attributes field instead. +
material - String + + Use the custom_attributes field instead. +
max_sale_qty - Float + Maximum Qty Allowed in Shopping Cart
media_gallery - [MediaGalleryInterface] + An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry] + An array of MediaGalleryEntry objects. Use media_gallery instead. +
message_max_length - Int + The maximum number of characters the gift message can contain.
meta_description - String + A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String + A comma-separated list of keywords that are visible only to search engines.
meta_title - String + A string that is displayed in the title bar and tab of the browser and in search results lists.
min_sale_qty - Float + Minimum Qty Allowed in Shopping Cart
name - String + The product name. Customers use this name to identify the product.
new - Int + + Use the custom_attributes field instead. +
new_from_date - String + The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String + The end date for new product listings.
only_x_left_in_stock - Float + Product stock only x left count
open_amount_max - Float + The maximum acceptable value of an open amount gift card.
open_amount_min - Float + The minimum acceptable value of an open amount gift card.
options - [CustomizableOptionInterface] + An array of options for a customizable product.
options_container - String + If the product has multiple options, determines where they appear on the product page.
pattern - String + + Use the custom_attributes field instead. +
performance_fabric - Int + + Use the custom_attributes field instead. +
price - ProductPrices + Indicates the price of an item. Use price_range for product price information. +
price_range - PriceRange! + The range of prices for the product
price_tiers - [TierPrice] + An array of TierPrice objects.
product_links - [ProductLinksInterface] + An array of ProductLinks objects.
purpose - Int + + Use the custom_attributes field instead. +
quantity - Float + Amount of available stock
rating_summary - Float! + The average of all the ratings given to the product.
redirect_code - Int! + Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface] + An array of related products.
relative_url - String + The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int! + The total count of all the reviews given to the product.
reviews - ProductReviews! + The list of products reviews.
+
+
Arguments
+
+
+
pageSize - Int +
+

The maximum number of results to return at once. The default is 20.

+
+
+
currentPage - Int +
+

The page of results to return. The default is 1.

+
+
+
+
sale - Int + + Use the custom_attributes field instead. +
short_description - ComplexTextValue + A short description of the product. Its use depends on the theme.
size - Int + + Use the custom_attributes field instead. +
sku - String + A number or code assigned to a product to identify the product, options, price, and manufacturer.
sleeve - String + + Use the custom_attributes field instead. +
small_image - ProductImage + The relative path to the small image, which is used on catalog pages.
special_from_date - String + The beginning date that a product has a special price. The field should not be used on the storefront. +
special_price - Float + The discounted price of the product.
special_to_date - String + The end date for a product with a special price.
staged - Boolean! + Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus + Stock status of the product
strap_bags - String + + Use the custom_attributes field instead. +
style_bags - String + + Use the custom_attributes field instead. +
style_bottom - String + + Use the custom_attributes field instead. +
style_general - String + + Use the custom_attributes field instead. +
swatch_image - String + The file name of a swatch image.
thumbnail - ProductImage + The relative path to the product's thumbnail image.
tier_price - Float + The price when tier pricing is in effect and the items purchased threshold has been reached. Use price_tiers for product tier price information. +
tier_prices - [ProductTierPrices] + An array of ProductTierPrices objects. Use price_tiers for product tier price information. +
type - UrlRewriteEntityTypeEnum + One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String + One of simple, virtual, bundle, downloadable, grouped, or configurable. Use __typename instead. +
uid - ID! + The unique ID for a ProductInterface object.
updated_at - String + Timestamp indicating when the product was updated. The field should not be used on the storefront. +
upsell_products - [ProductInterface] + An array of up-sell products.
url_key - String + The part of the URL that identifies the product
url_path - String + + Use product's canonical_url or url rewrites instead +
url_rewrites - [UrlRewrite] + URL rewrites list
url_suffix - String + The part of the product URL that is appended after the url key
websites - [Website] + An array of websites in which the product is available. The field should not be used on the storefront. +
weight - Float + The weight of the item, in units defined by the store.
+
+
+
+
+
Example
+ 
{
+  "activity": "xyz789",
+  "allow_message": false,
+  "allow_open_amount": false,
+  "attribute_set_id": 123,
+  "canonical_url": "xyz789",
+  "categories": [CategoryInterface],
+  "category_gear": "abc123",
+  "climate": "abc123",
+  "collar": "abc123",
+  "color": 123,
+  "country_of_manufacture": "abc123",
+  "created_at": "xyz789",
+  "crosssell_products": [ProductInterface],
+  "custom_attributesV2": ProductCustomAttributes,
+  "description": ComplexTextValue,
+  "eco_collection": 123,
+  "erin_recommends": 987,
+  "features_bags": "abc123",
+  "format": 123,
+  "gender": "abc123",
+  "gift_card_options": [CustomizableOptionInterface],
+  "gift_message_available": false,
+  "gift_wrapping_available": false,
+  "gift_wrapping_price": Money,
+  "giftcard_amounts": [GiftCardAmounts],
+  "giftcard_type": "VIRTUAL",
+  "id": 987,
+  "image": ProductImage,
+  "is_redeemable": false,
+  "is_returnable": "xyz789",
+  "lifetime": 987,
+  "manufacturer": 987,
+  "material": "xyz789",
+  "max_sale_qty": 987.65,
+  "media_gallery": [MediaGalleryInterface],
+  "media_gallery_entries": [MediaGalleryEntry],
+  "message_max_length": 123,
+  "meta_description": "xyz789",
+  "meta_keyword": "xyz789",
+  "meta_title": "abc123",
+  "min_sale_qty": 123.45,
+  "name": "xyz789",
+  "new": 123,
+  "new_from_date": "xyz789",
+  "new_to_date": "xyz789",
+  "only_x_left_in_stock": 987.65,
+  "open_amount_max": 987.65,
+  "open_amount_min": 123.45,
+  "options": [CustomizableOptionInterface],
+  "options_container": "abc123",
+  "pattern": "xyz789",
+  "performance_fabric": 987,
+  "price": ProductPrices,
+  "price_range": PriceRange,
+  "price_tiers": [TierPrice],
+  "product_links": [ProductLinksInterface],
+  "purpose": 123,
+  "quantity": 123.45,
+  "rating_summary": 987.65,
+  "redirect_code": 123,
+  "related_products": [ProductInterface],
+  "relative_url": "abc123",
+  "review_count": 987,
+  "reviews": ProductReviews,
+  "sale": 123,
+  "short_description": ComplexTextValue,
+  "size": 123,
+  "sku": "xyz789",
+  "sleeve": "xyz789",
+  "small_image": ProductImage,
+  "special_from_date": "abc123",
+  "special_price": 987.65,
+  "special_to_date": "abc123",
+  "staged": true,
+  "stock_status": "IN_STOCK",
+  "strap_bags": "xyz789",
+  "style_bags": "abc123",
+  "style_bottom": "abc123",
+  "style_general": "abc123",
+  "swatch_image": "xyz789",
+  "thumbnail": ProductImage,
+  "tier_price": 123.45,
+  "tier_prices": [ProductTierPrices],
+  "type": "CMS_PAGE",
+  "type_id": "xyz789",
+  "uid": 4,
+  "updated_at": "abc123",
+  "upsell_products": [ProductInterface],
+  "url_key": "abc123",
+  "url_path": "xyz789",
+  "url_rewrites": [UrlRewrite],
+  "url_suffix": "xyz789",
+  "websites": [Website],
+  "weight": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

GiftCardRequisitionListItem

+
+
+
+
Description
+

Contains details about gift cards added to a requisition list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
customizable_options - [SelectedCustomizableOption]! + Selected custom options for an item in the requisition list.
gift_card_options - GiftCardOptions! + An array that defines gift card properties.
product - ProductInterface! + Details about a requisition list item.
quantity - Float! + The amount added.
uid - ID! + The unique ID for the requisition list item.
+
+
+
+
+
Example
+ 
{
+  "customizable_options": [SelectedCustomizableOption],
+  "gift_card_options": GiftCardOptions,
+  "product": ProductInterface,
+  "quantity": 123.45,
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

GiftCardShipmentItem

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
gift_card - GiftCardItem + Selected gift card properties for a shipment item.
id - ID! + The unique ID for a ShipmentItemInterface object.
order_item - OrderItemInterface + The order item associated with the shipment item.
product_name - String + The name of the base product.
product_sale_price - Money! + The sale price for the base product.
product_sku - String! + The SKU of the base product.
quantity_shipped - Float! + The number of shipped items.
+
+
+
+
+
Example
+ 
{
+  "gift_card": GiftCardItem,
+  "id": "4",
+  "order_item": OrderItemInterface,
+  "product_name": "abc123",
+  "product_sale_price": Money,
+  "product_sku": "xyz789",
+  "quantity_shipped": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

GiftCardTypeEnum

+
+
+
+
Description
+

Specifies the gift card type.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

VIRTUAL

+ 		+
+

PHYSICAL

+ 		+
+

COMBINED

+ 		+
+
+
+
+
+
Example
+ 
"VIRTUAL"
+
+
+
+
+
+
+
+ Types +
+

GiftCardWishlistItem

+
+
+
+
Description
+

A single gift card added to a wish list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
added_at - String! + The date and time the item was added to the wish list.
customizable_options - [SelectedCustomizableOption]! + Custom options selected for the wish list item.
description - String + The description of the item.
gift_card_options - GiftCardOptions! + Details about a gift card.
id - ID! + The unique ID for a WishlistItemInterface object.
product - ProductInterface + Product details of the wish list item.
quantity - Float! + The quantity of this wish list item.
+
+
+
+
+
Example
+ 
{
+  "added_at": "abc123",
+  "customizable_options": [SelectedCustomizableOption],
+  "description": "abc123",
+  "gift_card_options": GiftCardOptions,
+  "id": 4,
+  "product": ProductInterface,
+  "quantity": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

GiftCartAttributeValue

+
+
+
+
Description
+

Gift card custom attribute value containing array data.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
code - ID! + The attribute code.
options - [String]! + Array of gift card attribute option values.
+
+
+
+
+
Example
+ 
{
+  "code": "4",
+  "options": ["abc123"]
+}
+
+
+
+
+
+
+
+ Types +
+

GiftMessage

+
+
+
+
Description
+

Contains the text of a gift message, its sender, and recipient

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
from - String! + Sender name
message - String! + Gift message text
to - String! + Recipient name
+
+
+
+
+
Example
+ 
{
+  "from": "xyz789",
+  "message": "abc123",
+  "to": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

GiftMessageInput

+
+
+
+
Description
+

Defines a gift message.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ from - String! + The name of the sender.
+ message - String! + The text of the gift message.
+ to - String! + The name of the recepient.
+
+
+
+
+
Example
+ 
{
+  "from": "abc123",
+  "message": "xyz789",
+  "to": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

GiftOptionsPrices

+
+
+
+
Description
+

Contains prices for gift wrapping options.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
gift_wrapping_for_items - Money + Price of the gift wrapping for all individual order items.
gift_wrapping_for_items_incl_tax - Money + Price of the gift wrapping for all individual order items including tax.
gift_wrapping_for_order - Money + Price of the gift wrapping for the whole order.
gift_wrapping_for_order_incl_tax - Money + Price of the gift wrapping for the whole order including tax.
printed_card - Money + Price for the printed card.
printed_card_incl_tax - Money + Price for the printed card including tax.
+
+
+
+
+
Example
+ 
{
+  "gift_wrapping_for_items": Money,
+  "gift_wrapping_for_items_incl_tax": Money,
+  "gift_wrapping_for_order": Money,
+  "gift_wrapping_for_order_incl_tax": Money,
+  "printed_card": Money,
+  "printed_card_incl_tax": Money
+}
+
+
+
+
+
+
+
+ Types +
+

GiftRegistry

+
+
+
+
Description
+

Contains details about a gift registry.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
created_at - String! + The date on which the gift registry was created. Only the registry owner can access this attribute.
dynamic_attributes - [GiftRegistryDynamicAttribute] + An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair.
event_name - String! + The name of the event.
items - [GiftRegistryItemInterface] + An array of products added to the gift registry.
message - String! + The message text the customer entered to describe the event.
owner_name - String! + The customer who created the gift registry.
privacy_settings - GiftRegistryPrivacySettings! + An enum that states whether the gift registry is PRIVATE or PUBLIC. Only the registry owner can access this attribute.
registrants - [GiftRegistryRegistrant] + Contains details about each registrant for the event.
shipping_address - CustomerAddress + Contains the customer's shipping address. Only the registry owner can access this attribute.
status - GiftRegistryStatus! + An enum that states whether the gift registry is ACTIVE or INACTIVE. Only the registry owner can access this attribute.
type - GiftRegistryType + The type of gift registry.
uid - ID! + The unique ID assigned to the gift registry.
+
+
+
+
+
Example
+ 
{
+  "created_at": "xyz789",
+  "dynamic_attributes": [GiftRegistryDynamicAttribute],
+  "event_name": "abc123",
+  "items": [GiftRegistryItemInterface],
+  "message": "xyz789",
+  "owner_name": "abc123",
+  "privacy_settings": "PRIVATE",
+  "registrants": [GiftRegistryRegistrant],
+  "shipping_address": CustomerAddress,
+  "status": "ACTIVE",
+  "type": GiftRegistryType,
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

GiftRegistryDynamicAttribute

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
code - ID! + The internal ID of the dynamic attribute.
group - GiftRegistryDynamicAttributeGroup! + Indicates which group the dynamic attribute is a member of.
label - String! + The display name of the dynamic attribute.
value - String! + A corresponding value for the code.
+
+
+
+
+
Example
+ 
{
+  "code": 4,
+  "group": "EVENT_INFORMATION",
+  "label": "xyz789",
+  "value": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

GiftRegistryDynamicAttributeGroup

+
+
+
+
Description
+

Defines the group type of a gift registry dynamic attribute.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

EVENT_INFORMATION

+ 		+
+

PRIVACY_SETTINGS

+ 		+
+

REGISTRANT

+ 		+
+

GENERAL_INFORMATION

+ 		+
+

DETAILED_INFORMATION

+ 		+
+

SHIPPING_ADDRESS

+ 		+
+
+
+
+
+
Example
+ 
"EVENT_INFORMATION"
+
+
+
+
+
+
+
+ Types +
+

GiftRegistryDynamicAttributeInput

+
+
+
+
Description
+

Defines a dynamic attribute.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ code - ID! + A unique key for an additional attribute of the event.
+ value - String! + A string that describes a dynamic attribute.
+
+
+
+
+
Example
+ 
{
+  "code": "4",
+  "value": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

GiftRegistryDynamicAttributeInterface

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
code - ID! + The internal ID of the dynamic attribute.
label - String! + The display name of the dynamic attribute.
value - String! + A corresponding value for the code.
+
+
+
Possible Types
+ + + + + + + + + + + + + + +
GiftRegistryDynamicAttributeInterface Types
+

GiftRegistryRegistrantDynamicAttribute

+
+

GiftRegistryDynamicAttribute

+
+
+
+
+
+
Example
+ 
{
+  "code": 4,
+  "label": "abc123",
+  "value": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

GiftRegistryDynamicAttributeMetadata

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
attribute_group - String! + Indicates which group the dynamic attribute a member of.
code - ID! + The internal ID of the dynamic attribute.
input_type - String! + The selected input type for this dynamic attribute. The value can be one of several static or custom types.
is_required - Boolean! + Indicates whether the dynamic attribute is required.
label - String! + The display name of the dynamic attribute.
sort_order - Int + The order in which to display the dynamic attribute.
+
+
+
+
+
Example
+ 
{
+  "attribute_group": "xyz789",
+  "code": 4,
+  "input_type": "xyz789",
+  "is_required": false,
+  "label": "abc123",
+  "sort_order": 987
+}
+
+
+
+
+
+
+
+ Types +
+

GiftRegistryDynamicAttributeMetadataInterface

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
attribute_group - String! + Indicates which group the dynamic attribute a member of.
code - ID! + The internal ID of the dynamic attribute.
input_type - String! + The selected input type for this dynamic attribute. The value can be one of several static or custom types.
is_required - Boolean! + Indicates whether the dynamic attribute is required.
label - String! + The display name of the dynamic attribute.
sort_order - Int + The order in which to display the dynamic attribute.
+
+
+
Possible Types
+ + + + + + + + + + + +
GiftRegistryDynamicAttributeMetadataInterface Types
+

GiftRegistryDynamicAttributeMetadata

+
+
+
+
+
+
Example
+ 
{
+  "attribute_group": "xyz789",
+  "code": "4",
+  "input_type": "abc123",
+  "is_required": false,
+  "label": "abc123",
+  "sort_order": 987
+}
+
+
+
+
+
+
+
+ Types +
+

GiftRegistryItem

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
created_at - String! + The date the product was added to the gift registry.
note - String + A brief message about the gift registry item.
product - ProductInterface + Details about the gift registry item.
quantity - Float! + The requested quantity of the product.
quantity_fulfilled - Float! + The fulfilled quantity of the product.
uid - ID! + The unique ID of a gift registry item.
+
+
+
+
+
Example
+ 
{
+  "created_at": "abc123",
+  "note": "abc123",
+  "product": ProductInterface,
+  "quantity": 123.45,
+  "quantity_fulfilled": 123.45,
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

GiftRegistryItemInterface

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
created_at - String! + The date the product was added to the gift registry.
note - String + A brief message about the gift registry item.
product - ProductInterface + Details about the gift registry item.
quantity - Float! + The requested quantity of the product.
quantity_fulfilled - Float! + The fulfilled quantity of the product.
uid - ID! + The unique ID of a gift registry item.
+
+
+
Possible Types
+ + + + + + + + + + + +
GiftRegistryItemInterface Types
+

GiftRegistryItem

+
+
+
+
+
+
Example
+ 
{
+  "created_at": "abc123",
+  "note": "xyz789",
+  "product": ProductInterface,
+  "quantity": 123.45,
+  "quantity_fulfilled": 123.45,
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

GiftRegistryItemUserErrorInterface

+
+
+
+
Description
+

Contains the status and any errors that encountered with the customer's gift register item.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
status - Boolean! + Indicates whether the attempt to move the cart items to the gift registry was successful.
user_errors - [GiftRegistryItemsUserError]! + An array of errors encountered while moving items from the cart to the gift registry.
+
+
+
Possible Types
+ + + + + + + + + + + +
GiftRegistryItemUserErrorInterface Types
+

MoveCartItemsToGiftRegistryOutput

+
+
+
+
+
+
Example
+ 
{
+  "status": true,
+  "user_errors": [GiftRegistryItemsUserError]
+}
+
+
+
+
+
+
+
+ Types +
+

GiftRegistryItemsUserError

+
+
+
+
Description
+

Contains details about an error that occurred when processing a gift registry item.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
code - GiftRegistryItemsUserErrorType! + An error code that describes the error encountered.
gift_registry_item_uid - ID + The unique ID of the gift registry item containing an error.
gift_registry_uid - ID + The unique ID of the GiftRegistry object containing an error.
message - String! + A localized error message.
product_uid - ID + The unique ID of the product containing an error.
+
+
+
+
+
Example
+ 
{
+  "code": "OUT_OF_STOCK",
+  "gift_registry_item_uid": 4,
+  "gift_registry_uid": 4,
+  "message": "xyz789",
+  "product_uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

GiftRegistryItemsUserErrorType

+
+
+
+
Description
+

Defines the error type.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

OUT_OF_STOCK

+ 		Used for handling out of stock products.
+

NOT_FOUND

+ 		Used for exceptions like EntityNotFound.
+

UNDEFINED

+ 		Used for other exceptions, such as database connection failures.
+
+
+
+
+
Example
+ 
"OUT_OF_STOCK"
+
+
+
+
+
+
+
+ Types +
+

GiftRegistryOutputInterface

+
+
+
+
Description
+

Contains the customer's gift registry.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
gift_registry - GiftRegistry + The gift registry.
+
+
+
Possible Types
+ + + + + + + + + + + +
GiftRegistryOutputInterface Types
+

MoveCartItemsToGiftRegistryOutput

+
+
+
+
+
+
Example
+ 
{"gift_registry": GiftRegistry}
+
+
+
+
+
+
+
+ Types +
+

GiftRegistryPrivacySettings

+
+
+
+
Description
+

Defines the privacy setting of the gift registry.

+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

PRIVATE

+ 		+
+

PUBLIC

+ 		+
+
+
+
+
+
Example
+ 
"PRIVATE"
+
+
+
+
+
+
+
+ Types +
+

GiftRegistryRegistrant

+
+
+
+
Description
+

Contains details about a registrant.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
dynamic_attributes - [GiftRegistryRegistrantDynamicAttribute] + An array of dynamic attributes assigned to the registrant.
email - String! + The email address of the registrant. Only the registry owner can access this attribute.
firstname - String! + The first name of the registrant.
lastname - String! + The last name of the registrant.
uid - ID! + The unique ID assigned to the registrant.
+
+
+
+
+
Example
+ 
{
+  "dynamic_attributes": [
+    GiftRegistryRegistrantDynamicAttribute
+  ],
+  "email": "abc123",
+  "firstname": "abc123",
+  "lastname": "xyz789",
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

GiftRegistryRegistrantDynamicAttribute

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
code - ID! + The internal ID of the dynamic attribute.
label - String! + The display name of the dynamic attribute.
value - String! + A corresponding value for the code.
+
+
+
+
+
Example
+ 
{
+  "code": "4",
+  "label": "abc123",
+  "value": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

GiftRegistrySearchResult

+
+
+
+
Description
+

Contains the results of a gift registry search.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
event_date - String + The date of the event.
event_title - String! + The title given to the event.
gift_registry_uid - ID! + The URL key of the gift registry.
location - String + The location of the event.
name - String! + The name of the gift registry owner.
type - String + The type of event being held.
+
+
+
+
+
Example
+ 
{
+  "event_date": "abc123",
+  "event_title": "xyz789",
+  "gift_registry_uid": 4,
+  "location": "xyz789",
+  "name": "xyz789",
+  "type": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

GiftRegistryShippingAddressInput

+
+
+
+
Description
+

Defines a shipping address for a gift registry. Specify either address_data or the address_id. If both are provided, validation will fail.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ address_data - CustomerAddressInput + Defines the shipping address for this gift registry.
+ address_id - ID + The ID assigned to this customer address.
+ customer_address_uid - ID + The unique ID assigned to this customer address.
+
+
+
+
+
Example
+ 
{
+  "address_data": CustomerAddressInput,
+  "address_id": 4,
+  "customer_address_uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

GiftRegistryStatus

+
+
+
+
Description
+

Defines the status of the gift registry.

+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

ACTIVE

+ 		+
+

INACTIVE

+ 		+
+
+
+
+
+
Example
+ 
"ACTIVE"
+
+
+
+
+
+
+
+ Types +
+

GiftRegistryType

+
+
+
+
Description
+

Contains details about a gift registry type.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
dynamic_attributes_metadata - [GiftRegistryDynamicAttributeMetadataInterface] + An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair.
label - String! + The label assigned to the gift registry type on the Admin.
uid - ID! + The unique ID assigned to the gift registry type.
+
+
+
+
+
Example
+ 
{
+  "dynamic_attributes_metadata": [
+    GiftRegistryDynamicAttributeMetadataInterface
+  ],
+  "label": "xyz789",
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

GiftWrapping

+
+
+
+
Description
+

Contains details about the selected or available gift wrapping options.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
design - String! + The name of the gift wrapping design.
id - ID! + The unique ID for a GiftWrapping object. Use uid instead +
image - GiftWrappingImage + The preview image for a gift wrapping option.
price - Money! + The gift wrapping price.
uid - ID! + The unique ID for a GiftWrapping object.
+
+
+
+
+
Example
+ 
{
+  "design": "xyz789",
+  "id": "4",
+  "image": GiftWrappingImage,
+  "price": Money,
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

GiftWrappingImage

+
+
+
+
Description
+

Points to an image associated with a gift wrapping option.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
label - String! + The gift wrapping preview image label.
url - String! + The gift wrapping preview image URL.
+
+
+
+
+
Example
+ 
{
+  "label": "xyz789",
+  "url": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

GooglePayButtonStyles

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
color - String + The button color
height - Int + The button height in pixels
type - String + The button type
+
+
+
+
+
Example
+ 
{
+  "color": "abc123",
+  "height": 123,
+  "type": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

GooglePayConfig

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
button_styles - GooglePayButtonStyles + The styles for the GooglePay Button configuration
code - String + The payment method code as defined in the payment gateway
is_visible - Boolean + Indicates whether the payment method is displayed
payment_intent - String + Defines the payment intent (Authorize or Capture
payment_source - String + The payment source for the payment method
sdk_params - [SDKParams] + The PayPal parameters required to load the JS SDK
sort_order - String + The relative order the payment method is displayed on the checkout page
three_ds_mode - ThreeDSMode + 3DS mode
title - String + The name displayed for the payment method
+
+
+
+
+
Example
+ 
{
+  "button_styles": GooglePayButtonStyles,
+  "code": "abc123",
+  "is_visible": true,
+  "payment_intent": "abc123",
+  "payment_source": "abc123",
+  "sdk_params": [SDKParams],
+  "sort_order": "xyz789",
+  "three_ds_mode": "OFF",
+  "title": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

GooglePayMethodInput

+
+
+
+
Description
+

Google Pay inputs

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ payment_source - String + The payment source for the payment method
+ payments_order_id - String + The payment services order ID
+ paypal_order_id - String + PayPal order ID
+
+
+
+
+
Example
+ 
{
+  "payment_source": "xyz789",
+  "payments_order_id": "xyz789",
+  "paypal_order_id": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

GroupedProduct

+
+
+
+
Description
+

Defines a grouped product, which consists of simple standalone products that are presented as a group.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
activity - String + + Use the custom_attributes field instead. +
attribute_set_id - Int + The attribute set assigned to the product. The field should not be used on the storefront. +
canonical_url - String + The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface] + The categories assigned to a product.
category_gear - String + + Use the custom_attributes field instead. +
climate - String + + Use the custom_attributes field instead. +
collar - String + + Use the custom_attributes field instead. +
color - Int + + Use the custom_attributes field instead. +
country_of_manufacture - String + The product's country of origin.
created_at - String + Timestamp indicating when the product was created. The field should not be used on the storefront. +
crosssell_products - [ProductInterface] + An array of cross-sell products.
custom_attributesV2 - ProductCustomAttributes + Product custom attributes.
+
+
Arguments
+
+
+
filters - AttributeFilterInput +
+
+
+
+
description - ComplexTextValue + Detailed information about the product. The value can include simple HTML tags.
eco_collection - Int + + Use the custom_attributes field instead. +
erin_recommends - Int + + Use the custom_attributes field instead. +
features_bags - String + + Use the custom_attributes field instead. +
format - Int + + Use the custom_attributes field instead. +
gender - String + + Use the custom_attributes field instead. +
gift_message_available - Boolean! + Returns a value indicating gift message availability for the product.
gift_wrapping_available - Boolean! + Returns a value indicating gift wrapping availability for the product.
gift_wrapping_price - Money + Returns value and currency indicating gift wrapping price for the product.
id - Int + The ID number assigned to the product. Use the uid field instead. +
image - ProductImage + The relative path to the main image on the product page.
is_returnable - String + Indicates whether the product can be returned.
items - [GroupedProductItem] + An array containing grouped product items.
manufacturer - Int + A number representing the product's manufacturer. Use the custom_attributes field instead. +
material - String + + Use the custom_attributes field instead. +
max_sale_qty - Float + Maximum Qty Allowed in Shopping Cart
media_gallery - [MediaGalleryInterface] + An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry] + An array of MediaGalleryEntry objects. Use media_gallery instead. +
meta_description - String + A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String + A comma-separated list of keywords that are visible only to search engines.
meta_title - String + A string that is displayed in the title bar and tab of the browser and in search results lists.
min_sale_qty - Float + Minimum Qty Allowed in Shopping Cart
name - String + The product name. Customers use this name to identify the product.
new - Int + + Use the custom_attributes field instead. +
new_from_date - String + The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String + The end date for new product listings.
only_x_left_in_stock - Float + Product stock only x left count
options_container - String + If the product has multiple options, determines where they appear on the product page.
pattern - String + + Use the custom_attributes field instead. +
performance_fabric - Int + + Use the custom_attributes field instead. +
price - ProductPrices + Indicates the price of an item. Use price_range for product price information. +
price_range - PriceRange! + The range of prices for the product
price_tiers - [TierPrice] + An array of TierPrice objects.
product_links - [ProductLinksInterface] + An array of ProductLinks objects.
purpose - Int + + Use the custom_attributes field instead. +
quantity - Float + Amount of available stock
rating_summary - Float! + The average of all the ratings given to the product.
redirect_code - Int! + Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface] + An array of related products.
relative_url - String + The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int! + The total count of all the reviews given to the product.
reviews - ProductReviews! + The list of products reviews.
+
+
Arguments
+
+
+
pageSize - Int +
+

The maximum number of results to return at once. The default is 20.

+
+
+
currentPage - Int +
+

The page of results to return. The default is 1.

+
+
+
+
sale - Int + + Use the custom_attributes field instead. +
short_description - ComplexTextValue + A short description of the product. Its use depends on the theme.
size - Int + + Use the custom_attributes field instead. +
sku - String + A number or code assigned to a product to identify the product, options, price, and manufacturer.
sleeve - String + + Use the custom_attributes field instead. +
small_image - ProductImage + The relative path to the small image, which is used on catalog pages.
special_from_date - String + The beginning date that a product has a special price. The field should not be used on the storefront. +
special_price - Float + The discounted price of the product.
special_to_date - String + The end date for a product with a special price.
staged - Boolean! + Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus + Stock status of the product
strap_bags - String + + Use the custom_attributes field instead. +
style_bags - String + + Use the custom_attributes field instead. +
style_bottom - String + + Use the custom_attributes field instead. +
style_general - String + + Use the custom_attributes field instead. +
swatch_image - String + The file name of a swatch image.
thumbnail - ProductImage + The relative path to the product's thumbnail image.
tier_price - Float + The price when tier pricing is in effect and the items purchased threshold has been reached. Use price_tiers for product tier price information. +
tier_prices - [ProductTierPrices] + An array of ProductTierPrices objects. Use price_tiers for product tier price information. +
type - UrlRewriteEntityTypeEnum + One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String + One of simple, virtual, bundle, downloadable, grouped, or configurable. Use __typename instead. +
uid - ID! + The unique ID for a ProductInterface object.
updated_at - String + Timestamp indicating when the product was updated. The field should not be used on the storefront. +
upsell_products - [ProductInterface] + An array of up-sell products.
url_key - String + The part of the URL that identifies the product
url_path - String + + Use product's canonical_url or url rewrites instead +
url_rewrites - [UrlRewrite] + URL rewrites list
url_suffix - String + The part of the product URL that is appended after the url key
websites - [Website] + An array of websites in which the product is available. The field should not be used on the storefront. +
weight - Float + The weight of the item, in units defined by the store.
+
+
+
+
+
Example
+ 
{
+  "activity": "abc123",
+  "attribute_set_id": 123,
+  "canonical_url": "xyz789",
+  "categories": [CategoryInterface],
+  "category_gear": "xyz789",
+  "climate": "abc123",
+  "collar": "abc123",
+  "color": 987,
+  "country_of_manufacture": "xyz789",
+  "created_at": "abc123",
+  "crosssell_products": [ProductInterface],
+  "custom_attributesV2": ProductCustomAttributes,
+  "description": ComplexTextValue,
+  "eco_collection": 987,
+  "erin_recommends": 987,
+  "features_bags": "xyz789",
+  "format": 123,
+  "gender": "xyz789",
+  "gift_message_available": true,
+  "gift_wrapping_available": false,
+  "gift_wrapping_price": Money,
+  "id": 987,
+  "image": ProductImage,
+  "is_returnable": "abc123",
+  "items": [GroupedProductItem],
+  "manufacturer": 123,
+  "material": "xyz789",
+  "max_sale_qty": 987.65,
+  "media_gallery": [MediaGalleryInterface],
+  "media_gallery_entries": [MediaGalleryEntry],
+  "meta_description": "abc123",
+  "meta_keyword": "xyz789",
+  "meta_title": "xyz789",
+  "min_sale_qty": 987.65,
+  "name": "abc123",
+  "new": 123,
+  "new_from_date": "xyz789",
+  "new_to_date": "xyz789",
+  "only_x_left_in_stock": 123.45,
+  "options_container": "xyz789",
+  "pattern": "abc123",
+  "performance_fabric": 987,
+  "price": ProductPrices,
+  "price_range": PriceRange,
+  "price_tiers": [TierPrice],
+  "product_links": [ProductLinksInterface],
+  "purpose": 987,
+  "quantity": 987.65,
+  "rating_summary": 987.65,
+  "redirect_code": 123,
+  "related_products": [ProductInterface],
+  "relative_url": "abc123",
+  "review_count": 987,
+  "reviews": ProductReviews,
+  "sale": 987,
+  "short_description": ComplexTextValue,
+  "size": 123,
+  "sku": "xyz789",
+  "sleeve": "abc123",
+  "small_image": ProductImage,
+  "special_from_date": "xyz789",
+  "special_price": 987.65,
+  "special_to_date": "xyz789",
+  "staged": false,
+  "stock_status": "IN_STOCK",
+  "strap_bags": "abc123",
+  "style_bags": "abc123",
+  "style_bottom": "abc123",
+  "style_general": "xyz789",
+  "swatch_image": "xyz789",
+  "thumbnail": ProductImage,
+  "tier_price": 987.65,
+  "tier_prices": [ProductTierPrices],
+  "type": "CMS_PAGE",
+  "type_id": "xyz789",
+  "uid": 4,
+  "updated_at": "xyz789",
+  "upsell_products": [ProductInterface],
+  "url_key": "xyz789",
+  "url_path": "abc123",
+  "url_rewrites": [UrlRewrite],
+  "url_suffix": "abc123",
+  "websites": [Website],
+  "weight": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

GroupedProductItem

+
+
+
+
Description
+

Contains information about an individual grouped product item.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
position - Int + The relative position of this item compared to the other group items.
product - ProductInterface + Details about this product option.
qty - Float + The quantity of this grouped product item.
+
+
+
+
+
Example
+ 
{
+  "position": 987,
+  "product": ProductInterface,
+  "qty": 987.65
+}
+
+
+
+
+
+
+
+ Types +
+

GroupedProductWishlistItem

+
+
+
+
Description
+

A grouped product wish list item.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
added_at - String! + The date and time the item was added to the wish list.
customizable_options - [SelectedCustomizableOption]! + Custom options selected for the wish list item.
description - String + The description of the item.
id - ID! + The unique ID for a WishlistItemInterface object.
product - ProductInterface + Product details of the wish list item.
quantity - Float! + The quantity of this wish list item.
+
+
+
+
+
Example
+ 
{
+  "added_at": "abc123",
+  "customizable_options": [SelectedCustomizableOption],
+  "description": "xyz789",
+  "id": 4,
+  "product": ProductInterface,
+  "quantity": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

GuestOrderCancelInput

+
+
+
+
Description
+

Input to retrieve a guest order based on token.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ reason - String! + Cancellation reason.
+ token - String! + Order token.
+
+
+
+
+
Example
+ 
{
+  "reason": "abc123",
+  "token": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

GuestOrderInformationInput

+
+
+
+
Description
+

Input to retrieve an order based on details.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ email - String! + Order billing address email.
+ lastname - String! + Order billing address lastname.
+ number - String! + Order number.
+
+
+
+
+
Example
+ 
{
+  "email": "xyz789",
+  "lastname": "xyz789",
+  "number": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

HostedFieldsConfig

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
cc_vault_code - String + Vault payment method code
code - String + The payment method code as defined in the payment gateway
is_vault_enabled - Boolean + Card vault enabled
is_visible - Boolean + Indicates whether the payment method is displayed
payment_intent - String + Defines the payment intent (Authorize or Capture
payment_source - String + The payment source for the payment method
requires_card_details - Boolean + Card and bin details required
sdk_params - [SDKParams] + The PayPal parameters required to load the JS SDK
sort_order - String + The relative order the payment method is displayed on the checkout page
three_ds - Boolean + Whether 3DS is activated; true if 3DS mode is not OFF. Use 'three_ds_mode' instead. +
three_ds_mode - ThreeDSMode + 3DS mode
title - String + The name displayed for the payment method
+
+
+
+
+
Example
+ 
{
+  "cc_vault_code": "abc123",
+  "code": "abc123",
+  "is_vault_enabled": true,
+  "is_visible": true,
+  "payment_intent": "abc123",
+  "payment_source": "abc123",
+  "requires_card_details": true,
+  "sdk_params": [SDKParams],
+  "sort_order": "xyz789",
+  "three_ds": true,
+  "three_ds_mode": "OFF",
+  "title": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

HostedFieldsInput

+
+
+
+
Description
+

Hosted Fields payment inputs

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cardBin - String + Card bin number
+ cardExpiryMonth - String + Expiration month of the card
+ cardExpiryYear - String + Expiration year of the card
+ cardLast4 - String + Last four digits of the card
+ holderName - String + Name on the card
+ is_active_payment_token_enabler - Boolean + Indicates whether details about the shopper's credit/debit card should be tokenized for later usage. Required only if Vault is enabled for the Payment Services payment integration.
+ payment_source - String + The payment source for the payment method
+ payments_order_id - String + The payment services order ID
+ paypal_order_id - String + PayPal order ID
+
+
+
+
+
Example
+ 
{
+  "cardBin": "abc123",
+  "cardExpiryMonth": "xyz789",
+  "cardExpiryYear": "xyz789",
+  "cardLast4": "xyz789",
+  "holderName": "abc123",
+  "is_active_payment_token_enabler": false,
+  "payment_source": "abc123",
+  "payments_order_id": "xyz789",
+  "paypal_order_id": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

HostedProInput

+
+
+
+
Description
+

Contains a set of relative URLs that PayPal uses in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Payments Pro Hosted Solution payment method.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cancel_url - String! + The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. For example, if the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.
+ return_url - String! + The relative URL of the final confirmation page that PayPal redirects to upon payment success. For example, if the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.
+
+
+
+
+
Example
+ 
{
+  "cancel_url": "xyz789",
+  "return_url": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

HostedProUrl

+
+
+
+
Description
+

Contains the secure URL used for the Payments Pro Hosted Solution payment method.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
secure_form_url - String + The secure URL generated by PayPal.
+
+
+
+
+
Example
+ 
{"secure_form_url": "xyz789"}
+
+
+
+
+
+
+
+ Types +
+

HostedProUrlInput

+
+
+
+
Description
+

Contains the required input to request the secure URL for Payments Pro Hosted Solution payment.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID that identifies the shopper's cart.
+
+
+
+
+
Example
+ 
{"cart_id": "xyz789"}
+
+
+
+
+
+
+
+ Types +
+

HttpQueryParameter

+
+
+
+
Description
+

Contains target path parameters.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
name - String + A parameter name.
value - String + A parameter value.
+
+
+
+
+
Example
+ 
{
+  "name": "xyz789",
+  "value": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

ID

+
+
+
+
Description
+

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

+
+
+
+
+
Example
+ 
"4"
+
+
+
+
+
+
+
+ Types +
+

ImageSwatchData

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
thumbnail - String + The URL assigned to the thumbnail of the swatch image.
value - String + The value can be represented as color (HEX code), image link, or text.
+
+
+
+
+
Example
+ 
{
+  "thumbnail": "abc123",
+  "value": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

InputFilterEnum

+
+
+
+
Description
+

List of templates/filters applied to customer attribute input.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

NONE

+ 		There are no templates or filters to be applied.
+

DATE

+ 		Forces attribute input to follow the date format.
+

TRIM

+ 		Strip whitespace (or other characters) from the beginning and end of the input.
+

STRIPTAGS

+ 		Strip HTML Tags.
+

ESCAPEHTML

+ 		Escape HTML Entities.
+
+
+
+
+
Example
+ 
"NONE"
+
+
+
+
+
+
+
+ Types +
+

InsufficientStockError

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
code - CartUserInputErrorType! + A cart-specific error code.
message - String! + A localized error message.
quantity - Float + Amount of available stock
+
+
+
+
+
Example
+ 
{
+  "code": "PRODUCT_NOT_FOUND",
+  "message": "abc123",
+  "quantity": 987.65
+}
+
+
+
+
+
+
+
+ Types +
+

Int

+
+
+
+
Description
+

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

+
+
+
+
+
Example
+ 
123
+
+
+
+
+
+
+
+ Types +
+

InternalError

+
+
+
+
Description
+

Contains an error message when an internal error occurred.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
message - String! + The returned error message.
+
+
+
+
+
Example
+ 
{"message": "xyz789"}
+
+
+
+
+
+
+
+ Types +
+

Invoice

+
+
+
+
Description
+

Contains invoice details.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
comments - [SalesCommentItem] + Comments on the invoice.
id - ID! + The unique ID for a Invoice object.
items - [InvoiceItemInterface] + Invoiced product details.
number - String! + Sequential invoice number.
total - InvoiceTotal + Invoice total amount details.
+
+
+
+
+
Example
+ 
{
+  "comments": [SalesCommentItem],
+  "id": 4,
+  "items": [InvoiceItemInterface],
+  "number": "abc123",
+  "total": InvoiceTotal
+}
+
+
+
+
+
+
+
+ Types +
+

InvoiceItem

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
discounts - [Discount] + Information about the final discount amount for the base product, including discounts on options.
id - ID! + The unique ID for an InvoiceItemInterface object.
order_item - OrderItemInterface + Details about an individual order item.
product_name - String + The name of the base product.
product_sale_price - Money! + The sale price for the base product including selected options.
product_sku - String! + The SKU of the base product.
quantity_invoiced - Float + The number of invoiced items.
+
+
+
+
+
Example
+ 
{
+  "discounts": [Discount],
+  "id": "4",
+  "order_item": OrderItemInterface,
+  "product_name": "abc123",
+  "product_sale_price": Money,
+  "product_sku": "xyz789",
+  "quantity_invoiced": 987.65
+}
+
+
+
+
+
+
+
+ Types +
+

InvoiceItemInterface

+
+
+
+
Description
+

Contains detailes about invoiced items.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
discounts - [Discount] + Information about the final discount amount for the base product, including discounts on options.
id - ID! + The unique ID for an InvoiceItemInterface object.
order_item - OrderItemInterface + Details about an individual order item.
product_name - String + The name of the base product.
product_sale_price - Money! + The sale price for the base product including selected options.
product_sku - String! + The SKU of the base product.
quantity_invoiced - Float + The number of invoiced items.
+
+
+
Possible Types
+ + + + + + + + + + + + + + + + + + + + +
InvoiceItemInterface Types
+

DownloadableInvoiceItem

+
+

BundleInvoiceItem

+
+

GiftCardInvoiceItem

+
+

InvoiceItem

+
+
+
+
+
+
Example
+ 
{
+  "discounts": [Discount],
+  "id": 4,
+  "order_item": OrderItemInterface,
+  "product_name": "abc123",
+  "product_sale_price": Money,
+  "product_sku": "xyz789",
+  "quantity_invoiced": 987.65
+}
+
+
+
+
+
+
+
+ Types +
+

InvoiceTotal

+
+
+
+
Description
+

Contains price details from an invoice.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
base_grand_total - Money! + The final base grand total amount in the base currency.
discounts - [Discount] + The applied discounts to the invoice.
grand_total - Money! + The final total amount, including shipping, discounts, and taxes.
shipping_handling - ShippingHandling + Details about the shipping and handling costs for the invoice.
subtotal - Money! + The subtotal of the invoice, excluding shipping, discounts, and taxes.
taxes - [TaxItem] + The invoice tax details.
total_shipping - Money! + The shipping amount for the invoice.
total_tax - Money! + The amount of tax applied to the invoice.
+
+
+
+
+
Example
+ 
{
+  "base_grand_total": Money,
+  "discounts": [Discount],
+  "grand_total": Money,
+  "shipping_handling": ShippingHandling,
+  "subtotal": Money,
+  "taxes": [TaxItem],
+  "total_shipping": Money,
+  "total_tax": Money
+}
+
+
+
+
+
+
+
+ Types +
+

IsCompanyAdminEmailAvailableOutput

+
+
+
+
Description
+

Contains the response of a company admin email validation query.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
is_email_available - Boolean! + Indicates whether the specified email address can be used to create a company administrator.
+
+
+
+
+
Example
+ 
{"is_email_available": true}
+
+
+
+
+
+
+
+ Types +
+

IsCompanyEmailAvailableOutput

+
+
+
+
Description
+

Contains the response of a company email validation query.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
is_email_available - Boolean! + Indicates whether the specified email address can be used to create a company.
+
+
+
+
+
Example
+ 
{"is_email_available": true}
+
+
+
+
+
+
+
+ Types +
+

IsCompanyRoleNameAvailableOutput

+
+
+
+
Description
+

Contains the response of a role name validation query.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
is_role_name_available - Boolean! + Indicates whether the specified company role name is available.
+
+
+
+
+
Example
+ 
{"is_role_name_available": true}
+
+
+
+
+
+
+
+ Types +
+

IsCompanyUserEmailAvailableOutput

+
+
+
+
Description
+

Contains the response of a company user email validation query.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
is_email_available - Boolean! + Indicates whether the specified email address can be used to create a company user.
+
+
+
+
+
Example
+ 
{"is_email_available": true}
+
+
+
+
+
+
+
+ Types +
+

IsEmailAvailableOutput

+
+
+
+
Description
+

Contains the result of the isEmailAvailable query.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
is_email_available - Boolean + Indicates whether the specified email address can be used to create a customer.
+
+
+
+
+
Example
+ 
{"is_email_available": true}
+
+
+
+
+
+
+
+ Types +
+

ItemNote

+
+
+
+
Description
+

The note object for quote line item.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
created_at - String + Timestamp that reflects note creation date.
creator_id - Int + ID of the user who submitted a note.
creator_type - Int + Type of teh user who submitted a note.
negotiable_quote_item_uid - ID + The unique ID of a CartItemInterface object.
note - String + Note text.
note_uid - ID + The unique ID of a ItemNote object.
+
+
+
+
+
Example
+ 
{
+  "created_at": "xyz789",
+  "creator_id": 123,
+  "creator_type": 987,
+  "negotiable_quote_item_uid": 4,
+  "note": "abc123",
+  "note_uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

ItemSelectedBundleOption

+
+
+
+
Description
+

A list of options of the selected bundle product.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
id - ID! + The unique ID for a ItemSelectedBundleOption object. Use uid instead. +
label - String! + The label of the option.
uid - ID! + The unique ID for a ItemSelectedBundleOption object.
values - [ItemSelectedBundleOptionValue] + A list of products that represent the values of the parent option.
+
+
+
+
+
Example
+ 
{
+  "id": 4,
+  "label": "abc123",
+  "uid": "4",
+  "values": [ItemSelectedBundleOptionValue]
+}
+
+
+
+
+
+
+
+ Types +
+

ItemSelectedBundleOptionValue

+
+
+
+
Description
+

A list of values for the selected bundle product.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
id - ID! + The unique ID for a ItemSelectedBundleOptionValue object. Use uid instead. +
price - Money! + The price of the child bundle product.
product_name - String! + The name of the child bundle product.
product_sku - String! + The SKU of the child bundle product.
quantity - Float! + The number of this bundle product that were ordered.
uid - ID! + The unique ID for a ItemSelectedBundleOptionValue object.
+
+
+
+
+
Example
+ 
{
+  "id": "4",
+  "price": Money,
+  "product_name": "abc123",
+  "product_sku": "abc123",
+  "quantity": 987.65,
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

KeyValue

+
+
+
+
Description
+

Contains a key-value pair.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
name - String + The name part of the key/value pair.
value - String + The value part of the key/value pair.
+
+
+
+
+
Example
+ 
{
+  "name": "xyz789",
+  "value": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

LayerFilter

+
+
+
+
Description
+

Contains information for rendering layered navigation.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
filter_items - [LayerFilterItemInterface] + An array of filter items. Use Aggregation.options instead. +
filter_items_count - Int + The count of filter items in filter group. Use Aggregation.count instead. +
name - String + The name of a layered navigation filter. Use Aggregation.label instead. +
request_var - String + The request variable name for a filter query. Use Aggregation.attribute_code instead. +
+
+
+
+
+
Example
+ 
{
+  "filter_items": [LayerFilterItemInterface],
+  "filter_items_count": 123,
+  "name": "xyz789",
+  "request_var": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

LayerFilterItem

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items_count - Int + The count of items per filter. Use AggregationOption.count instead. +
label - String + The label for a filter. Use AggregationOption.label instead. +
value_string - String + The value of a filter request variable to be used in query. Use AggregationOption.value instead. +
+
+
+
+
+
Example
+ 
{
+  "items_count": 123,
+  "label": "abc123",
+  "value_string": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

LayerFilterItemInterface

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items_count - Int + The count of items per filter. Use AggregationOption.count instead. +
label - String + The label for a filter. Use AggregationOption.label instead. +
value_string - String + The value of a filter request variable to be used in query. Use AggregationOption.value instead. +
+
+
+
Possible Types
+ + + + + + + + + + + + + + +
LayerFilterItemInterface Types
+

LayerFilterItem

+
+

SwatchLayerFilterItem

+
+
+
+
+
+
Example
+ 
{
+  "items_count": 123,
+  "label": "xyz789",
+  "value_string": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

LineItemNoteInput

+
+
+
+
Description
+

Sets quote item note.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ note - String + The note text to be added.
+ quote_item_uid - ID! + The unique ID of a CartLineItem object.
+ quote_uid - ID! + The unique ID of a NegotiableQuote object.
+
+
+
+
+
Example
+ 
{
+  "note": "abc123",
+  "quote_item_uid": "4",
+  "quote_uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

MediaGalleryEntry

+
+
+
+
Description
+

Defines characteristics about images and videos associated with a specific product.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
content - ProductMediaGalleryEntriesContent + Details about the content of the media gallery item.
disabled - Boolean + Indicates whether the image is hidden from view.
file - String + The path of the image on the server.
id - Int + The identifier assigned to the object. Use uid instead. +
label - String + The alt text displayed on the storefront when the user points to the image.
media_type - String + Either image or video.
position - Int + The media item's position after it has been sorted.
types - [String] + Array of image types. It can have the following values: image, small_image, thumbnail.
uid - ID! + The unique ID for a MediaGalleryEntry object.
video_content - ProductMediaGalleryEntriesVideoContent + Details about the content of a video item.
+
+
+
+
+
Example
+ 
{
+  "content": ProductMediaGalleryEntriesContent,
+  "disabled": false,
+  "file": "abc123",
+  "id": 123,
+  "label": "abc123",
+  "media_type": "xyz789",
+  "position": 123,
+  "types": ["abc123"],
+  "uid": "4",
+  "video_content": ProductMediaGalleryEntriesVideoContent
+}
+
+
+
+
+
+
+
+ Types +
+

MediaGalleryInterface

+
+
+
+
Description
+

Contains basic information about a product image or video.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
disabled - Boolean + Indicates whether the image is hidden from view.
label - String + The label of the product image or video.
position - Int + The media item's position after it has been sorted.
types - [String] + Array of image types. It can have the following values: image, small_image, thumbnail.
url - String + The URL of the product image or video.
+
+
+
Possible Types
+ + + + + + + + + + + + + + +
MediaGalleryInterface Types
+

ProductImage

+
+

ProductVideo

+
+
+
+
+
+
Example
+ 
{
+  "disabled": true,
+  "label": "abc123",
+  "position": 123,
+  "types": ["abc123"],
+  "url": "abc123"
+}
+
+
+
+
+
+ +
+
+ Types +
+

MessageStyles

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
layout - String + The message layout
logo - MessageStyleLogo + The message logo
+
+
+
+
+
Example
+ 
{
+  "layout": "abc123",
+  "logo": MessageStyleLogo
+}
+
+
+
+
+
+
+
+ Types +
+

Money

+
+
+
+
Description
+

Defines a monetary value, including a numeric value and a currency code.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
currency - CurrencyEnum + A three-letter currency code, such as USD or EUR.
value - Float + A number expressing a monetary value.
+
+
+
+
+
Example
+ 
{"currency": "AFN", "value": 987.65}
+
+
+
+
+
+
+
+ Types +
+

MoveCartItemsToGiftRegistryOutput

+
+
+
+
Description
+

Contains the customer's gift registry and any errors encountered.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
gift_registry - GiftRegistry + The gift registry.
status - Boolean! + Indicates whether the attempt to move the cart items to the gift registry was successful.
user_errors - [GiftRegistryItemsUserError]! + An array of errors encountered while moving items from the cart to the gift registry.
+
+
+
+
+
Example
+ 
{
+  "gift_registry": GiftRegistry,
+  "status": true,
+  "user_errors": [GiftRegistryItemsUserError]
+}
+
+
+
+
+
+
+
+ Types +
+

MoveItemsBetweenRequisitionListsInput

+
+
+
+
Description
+

An input object that defines the items in a requisition list to be moved.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ requisitionListItemUids - [ID]! + An array of IDs representing products moved from one requisition list to another.
+
+
+
+
+
Example
+ 
{"requisitionListItemUids": [4]}
+
+
+
+
+
+
+
+ Types +
+

MoveItemsBetweenRequisitionListsOutput

+
+
+
+
Description
+

Output of the request to move items to another requisition list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
destination_requisition_list - RequisitionList + The destination requisition list after moving items.
source_requisition_list - RequisitionList + The source requisition list after moving items.
+
+
+
+
+
Example
+ 
{
+  "destination_requisition_list": RequisitionList,
+  "source_requisition_list": RequisitionList
+}
+
+
+
+
+
+
+
+ Types +
+

MoveLineItemToRequisitionListInput

+
+
+
+
Description
+

Move Line Item to Requisition List.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ quote_item_uid - ID! + The unique ID of a CartLineItem object.
+ quote_uid - ID! + The unique ID of a NegotiableQuote object.
+ requisition_list_uid - ID! + The unique ID of a requisition list.
+
+
+
+
+
Example
+ 
{
+  "quote_item_uid": "4",
+  "quote_uid": "4",
+  "requisition_list_uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

MoveLineItemToRequisitionListOutput

+
+
+
+
Description
+

Contains the updated negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
quote - NegotiableQuote + The negotiable quote after moving item to requisition list.
+
+
+
+
+
Example
+ 
{"quote": NegotiableQuote}
+
+
+
+
+
+
+
+ Types +
+

MoveProductsBetweenWishlistsOutput

+
+
+
+
Description
+

Contains the source and target wish lists after moving products.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
destination_wishlist - Wishlist! + The destination wish list after receiving products moved from the source wish list.
source_wishlist - Wishlist! + The source wish list after moving products from it.
user_errors - [WishListUserInputError]! + An array of errors encountered while moving products to a wish list.
+
+
+
+
+
Example
+ 
{
+  "destination_wishlist": Wishlist,
+  "source_wishlist": Wishlist,
+  "user_errors": [WishListUserInputError]
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuote

+
+
+
+
Description
+

Contains details about a negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
available_payment_methods - [AvailablePaymentMethod] + An array of payment methods that can be applied to the negotiable quote.
billing_address - NegotiableQuoteBillingAddress + The billing address applied to the negotiable quote.
buyer - NegotiableQuoteUser! + The first and last name of the buyer.
comments - [NegotiableQuoteComment] + A list of comments made by the buyer and seller.
created_at - String + Timestamp indicating when the negotiable quote was created.
email - String + The email address of the company user.
history - [NegotiableQuoteHistoryEntry] + A list of status and price changes for the negotiable quote.
is_virtual - Boolean! + Indicates whether the negotiable quote contains only virtual products.
items - [CartItemInterface] + The list of items in the negotiable quote.
name - String! + The title assigned to the negotiable quote.
prices - CartPrices + A set of subtotals and totals applied to the negotiable quote.
selected_payment_method - SelectedPaymentMethod + The payment method that was applied to the negotiable quote.
shipping_addresses - [NegotiableQuoteShippingAddress]! + A list of shipping addresses applied to the negotiable quote.
status - NegotiableQuoteStatus! + The status of the negotiable quote.
total_quantity - Float! + The total number of items in the negotiable quote.
uid - ID! + The unique ID of a NegotiableQuote object.
updated_at - String + Timestamp indicating when the negotiable quote was updated.
+
+
+
+
+
Example
+ 
{
+  "available_payment_methods": [AvailablePaymentMethod],
+  "billing_address": NegotiableQuoteBillingAddress,
+  "buyer": NegotiableQuoteUser,
+  "comments": [NegotiableQuoteComment],
+  "created_at": "abc123",
+  "email": "abc123",
+  "history": [NegotiableQuoteHistoryEntry],
+  "is_virtual": false,
+  "items": [CartItemInterface],
+  "name": "abc123",
+  "prices": CartPrices,
+  "selected_payment_method": SelectedPaymentMethod,
+  "shipping_addresses": [NegotiableQuoteShippingAddress],
+  "status": "SUBMITTED",
+  "total_quantity": 123.45,
+  "uid": 4,
+  "updated_at": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteAddressCountry

+
+
+
+
Description
+

Defines the company's country.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
code - String! + The address country code.
label - String! + The display name of the region.
+
+
+
+
+
Example
+ 
{
+  "code": "abc123",
+  "label": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteAddressInput

+
+
+
+
Description
+

Defines the billing or shipping address to be applied to the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ city - String! + The city specified for the billing or shipping address.
+ company - String + The company name.
+ country_code - String! + The country code and label for the billing or shipping address.
+ firstname - String! + The first name of the company user.
+ lastname - String! + The last name of the company user.
+ postcode - String + The ZIP or postal code of the billing or shipping address.
+ region - String + A string that defines the state or province of the billing or shipping address.
+ region_id - Int + An integer that defines the state or province of the billing or shipping address.
+ save_in_address_book - Boolean + Determines whether to save the address in the customer's address book. The default value is true.
+ street - [String]! + An array containing the street for the billing or shipping address.
+ telephone - String + The telephone number for the billing or shipping address.
+
+
+
+
+
Example
+ 
{
+  "city": "abc123",
+  "company": "abc123",
+  "country_code": "abc123",
+  "firstname": "xyz789",
+  "lastname": "xyz789",
+  "postcode": "xyz789",
+  "region": "xyz789",
+  "region_id": 123,
+  "save_in_address_book": true,
+  "street": ["abc123"],
+  "telephone": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteAddressInterface

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
city - String! + The company's city or town.
company - String + The company name associated with the shipping/billing address.
country - NegotiableQuoteAddressCountry! + The company's country.
firstname - String! + The first name of the company user.
lastname - String! + The last name of the company user.
postcode - String + The company's ZIP or postal code.
region - NegotiableQuoteAddressRegion + An object containing the region name, region code, and region ID.
street - [String]! + An array of strings that define the street number and name.
telephone - String + The customer's telephone number.
+
+
+
Possible Types
+ + + + + + + + + + + + + + +
NegotiableQuoteAddressInterface Types
+

NegotiableQuoteShippingAddress

+
+

NegotiableQuoteBillingAddress

+
+
+
+
+
+
Example
+ 
{
+  "city": "abc123",
+  "company": "abc123",
+  "country": NegotiableQuoteAddressCountry,
+  "firstname": "xyz789",
+  "lastname": "abc123",
+  "postcode": "xyz789",
+  "region": NegotiableQuoteAddressRegion,
+  "street": ["xyz789"],
+  "telephone": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteAddressRegion

+
+
+
+
Description
+

Defines the company's state or province.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
code - String + The address region code.
label - String + The display name of the region.
region_id - Int + The unique ID for a pre-defined region.
+
+
+
+
+
Example
+ 
{
+  "code": "xyz789",
+  "label": "abc123",
+  "region_id": 123
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteBillingAddress

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
city - String! + The company's city or town.
company - String + The company name associated with the shipping/billing address.
country - NegotiableQuoteAddressCountry! + The company's country.
firstname - String! + The first name of the company user.
lastname - String! + The last name of the company user.
postcode - String + The company's ZIP or postal code.
region - NegotiableQuoteAddressRegion + An object containing the region name, region code, and region ID.
street - [String]! + An array of strings that define the street number and name.
telephone - String + The customer's telephone number.
+
+
+
+
+
Example
+ 
{
+  "city": "xyz789",
+  "company": "xyz789",
+  "country": NegotiableQuoteAddressCountry,
+  "firstname": "abc123",
+  "lastname": "xyz789",
+  "postcode": "abc123",
+  "region": NegotiableQuoteAddressRegion,
+  "street": ["abc123"],
+  "telephone": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteBillingAddressInput

+
+
+
+
Description
+

Defines the billing address.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ address - NegotiableQuoteAddressInput + Defines a billing address.
+ customer_address_uid - ID + The unique ID of a CustomerAddress object.
+ same_as_shipping - Boolean + Indicates whether to set the billing address to be the same as the existing shipping address on the negotiable quote.
+ use_for_shipping - Boolean + Indicates whether to set the shipping address to be the same as this billing address.
+
+
+
+
+
Example
+ 
{
+  "address": NegotiableQuoteAddressInput,
+  "customer_address_uid": 4,
+  "same_as_shipping": true,
+  "use_for_shipping": true
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteComment

+
+
+
+
Description
+

Contains a single plain text comment from either the buyer or seller.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
author - NegotiableQuoteUser! + The first and last name of the commenter.
created_at - String! + Timestamp indicating when the comment was created.
creator_type - NegotiableQuoteCommentCreatorType! + Indicates whether a buyer or seller commented.
text - String! + The plain text comment.
uid - ID! + The unique ID of a NegotiableQuoteComment object.
+
+
+
+
+
Example
+ 
{
+  "author": NegotiableQuoteUser,
+  "created_at": "xyz789",
+  "creator_type": "BUYER",
+  "text": "xyz789",
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteCommentCreatorType

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

BUYER

+ 		+
+

SELLER

+ 		+
+
+
+
+
+
Example
+ 
"BUYER"
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteCommentInput

+
+
+
+
Description
+

Contains the commend provided by the buyer.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ comment - String! + The comment provided by the buyer.
+
+
+
+
+
Example
+ 
{"comment": "abc123"}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteCustomLogChange

+
+
+
+
Description
+

Contains custom log entries added by third-party extensions.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
new_value - String! + The new entry content.
old_value - String + The previous entry in the custom log.
title - String! + The title of the custom log entry.
+
+
+
+
+
Example
+ 
{
+  "new_value": "xyz789",
+  "old_value": "xyz789",
+  "title": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteFilterInput

+
+
+
+
Description
+

Defines a filter to limit the negotiable quotes to return.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ ids - FilterEqualTypeInput + Filter by the ID of one or more negotiable quotes.
+ name - FilterMatchTypeInput + Filter by the negotiable quote name.
+
+
+
+
+
Example
+ 
{
+  "ids": FilterEqualTypeInput,
+  "name": FilterMatchTypeInput
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteHistoryChanges

+
+
+
+
Description
+

Contains a list of changes to a negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
comment_added - NegotiableQuoteHistoryCommentChange + The comment provided with a change in the negotiable quote history.
custom_changes - NegotiableQuoteCustomLogChange + Lists log entries added by third-party extensions.
expiration - NegotiableQuoteHistoryExpirationChange + The expiration date of the negotiable quote before and after a change in the quote history.
products_removed - NegotiableQuoteHistoryProductsRemovedChange + Lists products that were removed as a result of a change in the quote history.
statuses - NegotiableQuoteHistoryStatusesChange + The status before and after a change in the negotiable quote history.
total - NegotiableQuoteHistoryTotalChange + The total amount of the negotiable quote before and after a change in the quote history.
+
+
+
+
+
Example
+ 
{
+  "comment_added": NegotiableQuoteHistoryCommentChange,
+  "custom_changes": NegotiableQuoteCustomLogChange,
+  "expiration": NegotiableQuoteHistoryExpirationChange,
+  "products_removed": NegotiableQuoteHistoryProductsRemovedChange,
+  "statuses": NegotiableQuoteHistoryStatusesChange,
+  "total": NegotiableQuoteHistoryTotalChange
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteHistoryCommentChange

+
+
+
+
Description
+

Contains a comment submitted by a seller or buyer.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
comment - String! + A plain text comment submitted by a seller or buyer.
+
+
+
+
+
Example
+ 
{"comment": "abc123"}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteHistoryEntry

+
+
+
+
Description
+

Contains details about a change for a negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
author - NegotiableQuoteUser! + The person who made a change in the status of the negotiable quote.
change_type - NegotiableQuoteHistoryEntryChangeType! + An enum that describes the why the entry in the negotiable quote history changed status.
changes - NegotiableQuoteHistoryChanges + The set of changes in the negotiable quote.
created_at - String + Timestamp indicating when the negotiable quote entry was created.
uid - ID! + The unique ID of a NegotiableQuoteHistoryEntry object.
+
+
+
+
+
Example
+ 
{
+  "author": NegotiableQuoteUser,
+  "change_type": "CREATED",
+  "changes": NegotiableQuoteHistoryChanges,
+  "created_at": "abc123",
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteHistoryEntryChangeType

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

CREATED

+ 		+
+

UPDATED

+ 		+
+

CLOSED

+ 		+
+

UPDATED_BY_SYSTEM

+ 		+
+
+
+
+
+
Example
+ 
"CREATED"
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteHistoryExpirationChange

+
+
+
+
Description
+

Contains a new expiration date and the previous date.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
new_expiration - String + The expiration date after the change. The value will be 'null' if not set.
old_expiration - String + The previous expiration date. The value will be 'null' if not previously set.
+
+
+
+
+
Example
+ 
{
+  "new_expiration": "xyz789",
+  "old_expiration": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteHistoryProductsRemovedChange

+
+
+
+
Description
+

Contains lists of products that have been removed from the catalog and negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
products_removed_from_catalog - [ID] + A list of product IDs the seller removed from the catalog.
products_removed_from_quote - [ProductInterface] + A list of products removed from the negotiable quote by either the buyer or the seller.
+
+
+
+
+
Example
+ 
{
+  "products_removed_from_catalog": [4],
+  "products_removed_from_quote": [ProductInterface]
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteHistoryStatusChange

+
+
+
+
Description
+

Lists a new status change applied to a negotiable quote and the previous status.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
new_status - NegotiableQuoteStatus! + The updated status.
old_status - NegotiableQuoteStatus + The previous status. The value will be null for the first history entry in a negotiable quote.
+
+
+
+
+
Example
+ 
{"new_status": "SUBMITTED", "old_status": "SUBMITTED"}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteHistoryStatusesChange

+
+
+
+
Description
+

Contains a list of status changes that occurred for the negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
changes - [NegotiableQuoteHistoryStatusChange]! + A list of status changes.
+
+
+
+
+
Example
+ 
{"changes": [NegotiableQuoteHistoryStatusChange]}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteHistoryTotalChange

+
+
+
+
Description
+

Contains a new price and the previous price.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
new_price - Money + The total price as a result of the change.
old_price - Money + The previous total price on the negotiable quote.
+
+
+
+
+
Example
+ 
{
+  "new_price": Money,
+  "old_price": Money
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteInvalidStateError

+
+
+
+
Description
+

An error indicating that an operation was attempted on a negotiable quote in an invalid state.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
message - String! + The returned error message.
+
+
+
+
+
Example
+ 
{"message": "abc123"}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteItemQuantityInput

+
+
+
+
Description
+

Specifies the updated quantity of an item.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ quantity - Float! + The new quantity of the negotiable quote item.
+ quote_item_uid - ID! + The unique ID of a CartItemInterface object.
+
+
+
+
+
Example
+ 
{"quantity": 123.45, "quote_item_uid": 4}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuotePaymentMethodInput

+
+
+
+
Description
+

Defines the payment method to be applied to the negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ code - String! + Payment method code
+ purchase_order_number - String + The purchase order number. Optional for most payment methods.
+
+
+
+
+
Example
+ 
{
+  "code": "abc123",
+  "purchase_order_number": "abc123"
+}
+
+
+
+
+
+ +
+
+ Types +
+

NegotiableQuoteShippingAddress

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
available_shipping_methods - [AvailableShippingMethod] + An array of shipping methods available to the buyer.
city - String! + The company's city or town.
company - String + The company name associated with the shipping/billing address.
country - NegotiableQuoteAddressCountry! + The company's country.
firstname - String! + The first name of the company user.
lastname - String! + The last name of the company user.
postcode - String + The company's ZIP or postal code.
region - NegotiableQuoteAddressRegion + An object containing the region name, region code, and region ID.
selected_shipping_method - SelectedShippingMethod + The selected shipping method.
street - [String]! + An array of strings that define the street number and name.
telephone - String + The customer's telephone number.
+
+
+
+
+
Example
+ 
{
+  "available_shipping_methods": [AvailableShippingMethod],
+  "city": "abc123",
+  "company": "abc123",
+  "country": NegotiableQuoteAddressCountry,
+  "firstname": "abc123",
+  "lastname": "abc123",
+  "postcode": "abc123",
+  "region": NegotiableQuoteAddressRegion,
+  "selected_shipping_method": SelectedShippingMethod,
+  "street": ["abc123"],
+  "telephone": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteShippingAddressInput

+
+
+
+
Description
+

Defines shipping addresses for the negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ address - NegotiableQuoteAddressInput + A shipping address.
+ customer_address_uid - ID + An ID from the company user's address book that uniquely identifies the address to be used for shipping.
+ customer_notes - String + Text provided by the company user.
+
+
+
+
+
Example
+ 
{
+  "address": NegotiableQuoteAddressInput,
+  "customer_address_uid": "4",
+  "customer_notes": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteSortInput

+
+
+
+
Description
+

Defines the field to use to sort a list of negotiable quotes.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ sort_direction - SortEnum! + Whether to return results in ascending or descending order.
+ sort_field - NegotiableQuoteSortableField! + The specified sort field.
+
+
+
+
+
Example
+ 
{"sort_direction": "ASC", "sort_field": "QUOTE_NAME"}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteSortableField

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

QUOTE_NAME

+ 		Sorts negotiable quotes by name.
+

CREATED_AT

+ 		Sorts negotiable quotes by the dates they were created.
+

UPDATED_AT

+ 		Sorts negotiable quotes by the dates they were last modified.
+
+
+
+
+
Example
+ 
"QUOTE_NAME"
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteStatus

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

SUBMITTED

+ 		+
+

PENDING

+ 		+
+

UPDATED

+ 		+
+

OPEN

+ 		+
+

ORDERED

+ 		+
+

CLOSED

+ 		+
+

DECLINED

+ 		+
+

EXPIRED

+ 		+
+

DRAFT

+ 		+
+
+
+
+
+
Example
+ 
"SUBMITTED"
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteTemplate

+
+
+
+
Description
+

Contains details about a negotiable quote template.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
buyer - NegotiableQuoteUser! + The first and last name of the buyer.
comments - [NegotiableQuoteComment] + A list of comments made by the buyer and seller.
expiration_date - String! + The expiration period of the negotiable quote template.
history - [NegotiableQuoteHistoryEntry] + A list of status and price changes for the negotiable quote template.
is_min_max_qty_used - Boolean! + Indicates whether the minimum and maximum quantity settings are used.
is_virtual - Boolean! + Indicates whether the negotiable quote template contains only virtual products.
items - [CartItemInterface] + The list of items in the negotiable quote template.
max_order_commitment - Int! + Commitment for maximum orders
min_order_commitment - Int! + Commitment for minimum orders
name - String! + The title assigned to the negotiable quote template.
notifications - [QuoteTemplateNotificationMessage] + A list of notifications for the negotiable quote template.
prices - CartPrices + A set of subtotals and totals applied to the negotiable quote template.
reference_document_links - [NegotiableQuoteReferenceDocumentLink] + A list of reference document links for the negotiable quote template.
shipping_addresses - [NegotiableQuoteShippingAddress]! + A list of shipping addresses applied to the negotiable quote template.
status - String! + The status of the negotiable quote template.
template_id - ID! + The unique ID of a NegotiableQuoteTemplate object.
total_quantity - Float! + The total number of items in the negotiable quote template.
+
+
+
+
+
Example
+ 
{
+  "buyer": NegotiableQuoteUser,
+  "comments": [NegotiableQuoteComment],
+  "expiration_date": "abc123",
+  "history": [NegotiableQuoteHistoryEntry],
+  "is_min_max_qty_used": true,
+  "is_virtual": false,
+  "items": [CartItemInterface],
+  "max_order_commitment": 123,
+  "min_order_commitment": 123,
+  "name": "xyz789",
+  "notifications": [QuoteTemplateNotificationMessage],
+  "prices": CartPrices,
+  "reference_document_links": [
+    NegotiableQuoteReferenceDocumentLink
+  ],
+  "shipping_addresses": [NegotiableQuoteShippingAddress],
+  "status": "abc123",
+  "template_id": 4,
+  "total_quantity": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteTemplateFilterInput

+
+
+
+
Description
+

Defines a filter to limit the negotiable quotes to return.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ state - FilterEqualTypeInput + Filter by state of one or more negotiable quote templates.
+ status - FilterEqualTypeInput + Filter by status of one or more negotiable quote templates.
+
+
+
+
+
Example
+ 
{
+  "state": FilterEqualTypeInput,
+  "status": FilterEqualTypeInput
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteTemplateGridItem

+
+
+
+
Description
+

Contains data for a negotiable quote template in a grid.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
activated_at - String! + The date and time the negotiable quote template was activated.
company_name - String! + Company name the quote template is assigned to
expiration_date - String! + The expiration period of the negotiable quote template.
is_min_max_qty_used - Boolean! + Indicates whether the minimum and maximum quantity settings are used.
last_shared_at - String! + The date and time the negotiable quote template was last shared.
max_order_commitment - Int! + Commitment for maximum orders
min_negotiated_grand_total - Float! + The minimum negotiated grand total of the negotiable quote template.
min_order_commitment - Int! + Commitment for minimum orders
name - String! + The title assigned to the negotiable quote template.
orders_placed - Int! + The number of orders placed for the negotiable quote template.
sales_rep_name - String! + The first and last name of the sales representative.
state - String! + State of the negotiable quote template.
status - String! + The status of the negotiable quote template.
submitted_by - String! + The first and last name of the buyer.
template_id - ID! + The unique ID of a NegotiableQuoteTemplate object.
+
+
+
+
+
Example
+ 
{
+  "activated_at": "abc123",
+  "company_name": "xyz789",
+  "expiration_date": "abc123",
+  "is_min_max_qty_used": true,
+  "last_shared_at": "xyz789",
+  "max_order_commitment": 123,
+  "min_negotiated_grand_total": 123.45,
+  "min_order_commitment": 123,
+  "name": "xyz789",
+  "orders_placed": 987,
+  "sales_rep_name": "abc123",
+  "state": "xyz789",
+  "status": "abc123",
+  "submitted_by": "abc123",
+  "template_id": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteTemplateItemQuantityInput

+
+
+
+
Description
+

Specifies the updated quantity of an item.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ item_id - ID! + The unique ID of a CartItemInterface object.
+ max_qty - Float + The new max quantity of the negotiable quote template item. Only used if is_min_max_qty_used is true on the template.
+ min_qty - Float + The new min quantity of the negotiable quote template item. Only used if is_min_max_qty_used is true on the template.
+ quantity - Float! + The new quantity of the negotiable quote item.
+
+
+
+
+
Example
+ 
{"item_id": 4, "max_qty": 987.65, "min_qty": 987.65, "quantity": 987.65}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteTemplateReferenceDocumentLinkInput

+
+
+
+
Description
+

Defines the reference document link to add to a negotiable quote template.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ document_identifier - String + The identifier of the reference document.
+ document_name - String! + The title of the reference document.
+ link_id - ID + The unique ID of a NegotiableQuoteReferenceDocumentLink object.
+ reference_document_url - String! + The URL of the reference document.
+
+
+
+
+
Example
+ 
{
+  "document_identifier": "xyz789",
+  "document_name": "xyz789",
+  "link_id": 4,
+  "reference_document_url": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteTemplateShippingAddressInput

+
+
+
+
Description
+

Defines shipping addresses for the negotiable quote template.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ address - NegotiableQuoteAddressInput + A shipping address.
+ customer_address_uid - ID + An ID from the company user's address book that uniquely identifies the address to be used for shipping.
+ customer_notes - String + Text provided by the company user.
+
+
+
+
+
Example
+ 
{
+  "address": NegotiableQuoteAddressInput,
+  "customer_address_uid": 4,
+  "customer_notes": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteTemplateSortInput

+
+
+
+
Description
+

Defines the field to use to sort a list of negotiable quotes.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ sort_direction - SortEnum! + Whether to return results in ascending or descending order.
+ sort_field - NegotiableQuoteTemplateSortableField! + The specified sort field.
+
+
+
+
+
Example
+ 
{"sort_direction": "ASC", "sort_field": "TEMPLATE_ID"}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteTemplateSortableField

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

TEMPLATE_ID

+ 		Sorts negotiable quote templates by template id.
+

LAST_SHARED_AT

+ 		Sorts negotiable quote templates by the date they were last shared.
+
+
+
+
+
Example
+ 
"TEMPLATE_ID"
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteTemplatesOutput

+
+
+
+
Description
+

Contains a list of negotiable templates that match the specified filter.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items - [NegotiableQuoteTemplateGridItem]! + A list of negotiable quote templates
page_info - SearchResultPageInfo! + Contains pagination metadata
sort_fields - SortFields + Contains the default sort field and all available sort fields.
total_count - Int! + The number of negotiable quote templates returned
+
+
+
+
+
Example
+ 
{
+  "items": [NegotiableQuoteTemplateGridItem],
+  "page_info": SearchResultPageInfo,
+  "sort_fields": SortFields,
+  "total_count": 987
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteUidNonFatalResultInterface

+
+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
quote_uid - ID! + The unique ID of a NegotiableQuote object.
+
+
+
Possible Types
+ + + + + + + + + + + +
NegotiableQuoteUidNonFatalResultInterface Types
+

NegotiableQuoteUidOperationSuccess

+
+
+
+
+
+
Example
+ 
{"quote_uid": 4}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteUidOperationSuccess

+
+
+
+
Description
+

Contains details about a successful operation on a negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
quote_uid - ID! + The unique ID of a NegotiableQuote object.
+
+
+
+
+
Example
+ 
{"quote_uid": 4}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuoteUser

+
+
+
+
Description
+

A limited view of a Buyer or Seller in the negotiable quote process.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
firstname - String! + The first name of the buyer or seller making a change.
lastname - String! + The buyer's or seller's last name.
+
+
+
+
+
Example
+ 
{
+  "firstname": "xyz789",
+  "lastname": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

NegotiableQuotesOutput

+
+
+
+
Description
+

Contains a list of negotiable that match the specified filter.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items - [NegotiableQuote]! + A list of negotiable quotes
page_info - SearchResultPageInfo! + Contains pagination metadata
sort_fields - SortFields + Contains the default sort field and all available sort fields.
total_count - Int! + The number of negotiable quotes returned
+
+
+
+
+
Example
+ 
{
+  "items": [NegotiableQuote],
+  "page_info": SearchResultPageInfo,
+  "sort_fields": SortFields,
+  "total_count": 123
+}
+
+
+
+
+
+
+
+ Types +
+

NoSuchEntityUidError

+
+
+
+
Description
+

Contains an error message when an invalid UID was specified.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
message - String! + The returned error message.
uid - ID! + The specified invalid unique ID of an object.
+
+
+
+
+
Example
+ 
{
+  "message": "abc123",
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

OpenNegotiableQuoteTemplateInput

+
+
+
+
Description
+

Specifies the quote template id to open quote template.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ template_id - ID! + The unique ID of a NegotiableQuoteTemplate object.
+
+
+
+
+
Example
+ 
{"template_id": 4}
+
+
+
+
+
+
+
+ Types +
+

Order

+
+
+
+
Description
+

Contains the order ID.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
order_id - String + + Use order_number instead. +
order_number - String! + The unique ID for an Order object.
+
+
+
+
+
Example
+ 
{
+  "order_id": "abc123",
+  "order_number": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

OrderActionType

+
+
+
+
Description
+

The list of available order actions.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

REORDER

+ 		+
+

CANCEL

+ 		+
+

RETURN

+ 		+
+
+
+
+
+
Example
+ 
"REORDER"
+
+
+
+
+
+
+
+ Types +
+

OrderAddress

+
+
+
+
Description
+

Contains detailed information about an order's billing and shipping addresses.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
city - String! + The city or town.
company - String + The customer's company.
country_code - CountryCodeEnum + The customer's country.
custom_attributesV2 - [AttributeValueInterface]! + Custom attributes assigned to the customer address.
+
+
Arguments
+
+
+
attributeCodes - [ID!] +
+
+
+
+
fax - String + The fax number.
firstname - String! + The first name of the person associated with the shipping/billing address.
lastname - String! + The family name of the person associated with the shipping/billing address.
middlename - String + The middle name of the person associated with the shipping/billing address.
postcode - String + The customer's ZIP or postal code.
prefix - String + An honorific, such as Dr., Mr., or Mrs.
region - String + The state or province name.
region_id - ID + The unique ID for a Region object of a pre-defined region.
street - [String]! + An array of strings that define the street number and name.
suffix - String + A value such as Sr., Jr., or III.
telephone - String + The telephone number.
vat_id - String + The customer's Value-added tax (VAT) number (for corporate customers).
+
+
+
+
+
Example
+ 
{
+  "city": "abc123",
+  "company": "abc123",
+  "country_code": "AF",
+  "custom_attributesV2": [AttributeValueInterface],
+  "fax": "abc123",
+  "firstname": "abc123",
+  "lastname": "abc123",
+  "middlename": "abc123",
+  "postcode": "xyz789",
+  "prefix": "xyz789",
+  "region": "abc123",
+  "region_id": 4,
+  "street": ["xyz789"],
+  "suffix": "abc123",
+  "telephone": "xyz789",
+  "vat_id": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

OrderCustomerInfo

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
firstname - String! + First name of the customer
lastname - String + Last name of the customer
middlename - String + Middle name of the customer
prefix - String + Prefix of the customer
suffix - String + Suffix of the customer
+
+
+
+
+
Example
+ 
{
+  "firstname": "abc123",
+  "lastname": "abc123",
+  "middlename": "abc123",
+  "prefix": "xyz789",
+  "suffix": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

OrderItem

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
discounts - [Discount] + The final discount information for the product.
eligible_for_return - Boolean + Indicates whether the order item is eligible to be in a return request.
entered_options - [OrderItemOption] + The entered option for the base product, such as a logo or image.
gift_message - GiftMessage + The selected gift message for the order item
gift_wrapping - GiftWrapping + The selected gift wrapping for the order item.
id - ID! + The unique ID for an OrderItemInterface object.
prices - OrderItemPrices + Contains details about the price of the item, including taxes and discounts.
product - ProductInterface + The ProductInterface object, which contains details about the base product
product_name - String + The name of the base product.
product_sale_price - Money! + The sale price of the base product, including selected options.
product_sku - String! + The SKU of the base product.
product_type - String + The type of product, such as simple, configurable, etc.
product_url_key - String + URL key of the base product.
quantity_canceled - Float + The number of canceled items.
quantity_invoiced - Float + The number of invoiced items.
quantity_ordered - Float + The number of units ordered for this item.
quantity_refunded - Float + The number of refunded items.
quantity_return_requested - Float + The requested return quantity of the item.
quantity_returned - Float + The number of returned items.
quantity_shipped - Float + The number of shipped items.
selected_options - [OrderItemOption] + The selected options for the base product, such as color or size.
status - String + The status of the order item.
+
+
+
+
+
Example
+ 
{
+  "discounts": [Discount],
+  "eligible_for_return": true,
+  "entered_options": [OrderItemOption],
+  "gift_message": GiftMessage,
+  "gift_wrapping": GiftWrapping,
+  "id": 4,
+  "prices": OrderItemPrices,
+  "product": ProductInterface,
+  "product_name": "abc123",
+  "product_sale_price": Money,
+  "product_sku": "xyz789",
+  "product_type": "abc123",
+  "product_url_key": "abc123",
+  "quantity_canceled": 123.45,
+  "quantity_invoiced": 123.45,
+  "quantity_ordered": 987.65,
+  "quantity_refunded": 123.45,
+  "quantity_return_requested": 987.65,
+  "quantity_returned": 987.65,
+  "quantity_shipped": 123.45,
+  "selected_options": [OrderItemOption],
+  "status": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

OrderItemInterface

+
+
+
+
Description
+

Order item details.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
discounts - [Discount] + The final discount information for the product.
eligible_for_return - Boolean + Indicates whether the order item is eligible to be in a return request.
entered_options - [OrderItemOption] + The entered option for the base product, such as a logo or image.
gift_message - GiftMessage + The selected gift message for the order item
gift_wrapping - GiftWrapping + The selected gift wrapping for the order item.
id - ID! + The unique ID for an OrderItemInterface object.
prices - OrderItemPrices + Contains details about the price of the item, including taxes and discounts.
product - ProductInterface + The ProductInterface object, which contains details about the base product
product_name - String + The name of the base product.
product_sale_price - Money! + The sale price of the base product, including selected options.
product_sku - String! + The SKU of the base product.
product_type - String + The type of product, such as simple, configurable, etc.
product_url_key - String + URL key of the base product.
quantity_canceled - Float + The number of canceled items.
quantity_invoiced - Float + The number of invoiced items.
quantity_ordered - Float + The number of units ordered for this item.
quantity_refunded - Float + The number of refunded items.
quantity_return_requested - Float + The requested return quantity of the item.
quantity_returned - Float + The number of returned items.
quantity_shipped - Float + The number of shipped items.
selected_options - [OrderItemOption] + The selected options for the base product, such as color or size.
status - String + The status of the order item.
+
+
+
Possible Types
+ + + + + + + + + + + + + + + + + + + + + + + +
OrderItemInterface Types
+

ConfigurableOrderItem

+
+

DownloadableOrderItem

+
+

BundleOrderItem

+
+

GiftCardOrderItem

+
+

OrderItem

+
+
+
+
+
+
Example
+ 
{
+  "discounts": [Discount],
+  "eligible_for_return": true,
+  "entered_options": [OrderItemOption],
+  "gift_message": GiftMessage,
+  "gift_wrapping": GiftWrapping,
+  "id": "4",
+  "prices": OrderItemPrices,
+  "product": ProductInterface,
+  "product_name": "abc123",
+  "product_sale_price": Money,
+  "product_sku": "xyz789",
+  "product_type": "xyz789",
+  "product_url_key": "xyz789",
+  "quantity_canceled": 123.45,
+  "quantity_invoiced": 987.65,
+  "quantity_ordered": 123.45,
+  "quantity_refunded": 123.45,
+  "quantity_return_requested": 987.65,
+  "quantity_returned": 987.65,
+  "quantity_shipped": 123.45,
+  "selected_options": [OrderItemOption],
+  "status": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

OrderItemOption

+
+
+
+
Description
+

Represents order item options like selected or entered.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
label - String! + The name of the option.
value - String! + The value of the option.
+
+
+
+
+
Example
+ 
{
+  "label": "xyz789",
+  "value": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

OrderItemPrices

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
discounts - [Discount] + An array of discounts to be applied to the cart item.
fixed_product_taxes - [FixedProductTax]! + +
original_price - Money + The original price of the item.
original_price_including_tax - Money + The original price of the item including tax.
original_row_total - Money! + The value of the original price multiplied by the quantity of the item.
original_row_total_including_tax - Money! + The value of the original price multiplied by the quantity of the item including tax.
price - Money! + The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart.
price_including_tax - Money! + The price of the item before any discounts were applied. The price that might include tax, depending on the configured display settings for cart.
row_total - Money! + The value of the price multiplied by the quantity of the item.
row_total_including_tax - Money! + The value of row_total plus the tax applied to the item.
total_item_discount - Money! + The total of all discounts applied to the item.
+
+
+
+
+
Example
+ 
{
+  "discounts": [Discount],
+  "fixed_product_taxes": [FixedProductTax],
+  "original_price": Money,
+  "original_price_including_tax": Money,
+  "original_row_total": Money,
+  "original_row_total_including_tax": Money,
+  "price": Money,
+  "price_including_tax": Money,
+  "row_total": Money,
+  "row_total_including_tax": Money,
+  "total_item_discount": Money
+}
+
+
+
+
+
+
+
+ Types +
+

OrderPaymentMethod

+
+
+
+
Description
+

Contains details about the payment method used to pay for the order.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
additional_data - [KeyValue] + Additional data per payment method type.
name - String! + The label that describes the payment method.
type - String! + The payment method code that indicates how the order was paid for.
+
+
+
+
+
Example
+ 
{
+  "additional_data": [KeyValue],
+  "name": "xyz789",
+  "type": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

OrderShipment

+
+
+
+
Description
+

Contains order shipment details.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
comments - [SalesCommentItem] + Comments added to the shipment.
id - ID! + The unique ID for a OrderShipment object.
items - [ShipmentItemInterface] + An array of items included in the shipment.
number - String! + The sequential credit shipment number.
tracking - [ShipmentTracking] + An array of shipment tracking details.
+
+
+
+
+
Example
+ 
{
+  "comments": [SalesCommentItem],
+  "id": "4",
+  "items": [ShipmentItemInterface],
+  "number": "xyz789",
+  "tracking": [ShipmentTracking]
+}
+
+
+
+
+
+
+
+ Types +
+

OrderTokenInput

+
+
+
+
Description
+

Input to retrieve an order based on token.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ token - String! + Order token.
+
+
+
+
+
Example
+ 
{"token": "xyz789"}
+
+
+
+
+
+
+
+ Types +
+

OrderTotal

+
+
+
+
Description
+

Contains details about the sales total amounts used to calculate the final price.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
base_grand_total - Money! + The final base grand total amount in the base currency.
discounts - [Discount] + The applied discounts to the order.
gift_options - GiftOptionsPrices + +
grand_total - Money! + The final total amount, including shipping, discounts, and taxes.
grand_total_excl_tax - Money! + The grand total of the order, excluding taxes.
shipping_handling - ShippingHandling + Details about the shipping and handling costs for the order.
subtotal - Money! + The subtotal of the order, excluding shipping, discounts, and taxes. Use subtotal_excl_tax field instead +
subtotal_excl_tax - Money! + The subtotal of the order, excluding taxes.
subtotal_incl_tax - Money! + The subtotal of the order, including taxes.
taxes - [TaxItem] + The order tax details.
total_giftcard - Money + The gift card balance applied to the order.
total_reward_points - Money + The total reward points applied to the order.
total_shipping - Money! + The shipping amount for the order.
total_store_credit - Money + The total store credit applied to the order.
total_tax - Money! + The amount of tax applied to the order.
+
+
+
+
+
Example
+ 
{
+  "base_grand_total": Money,
+  "discounts": [Discount],
+  "gift_options": GiftOptionsPrices,
+  "grand_total": Money,
+  "grand_total_excl_tax": Money,
+  "shipping_handling": ShippingHandling,
+  "subtotal": Money,
+  "subtotal_excl_tax": Money,
+  "subtotal_incl_tax": Money,
+  "taxes": [TaxItem],
+  "total_giftcard": Money,
+  "total_reward_points": Money,
+  "total_shipping": Money,
+  "total_store_credit": Money,
+  "total_tax": Money
+}
+
+
+
+
+
+
+
+ Types +
+

PayflowExpressInput

+
+
+
+
Description
+

Contains required input for Payflow Express Checkout payments.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ payer_id - String! + The unique ID of the PayPal user.
+ token - String! + The token returned by the createPaypalExpressToken mutation.
+
+
+
+
+
Example
+ 
{
+  "payer_id": "xyz789",
+  "token": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

PayflowLinkInput

+
+
+
+
Description
+

A set of relative URLs that PayPal uses in response to various actions during the authorization process. Adobe Commerce prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Payflow Link and Payments Advanced payment methods.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cancel_url - String! + The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. If the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.
+ error_url - String! + The relative URL of the transaction error page that PayPal redirects to upon payment error. If the full URL to this page is https://www.example.com/paypal/action/error.html, the relative URL is paypal/action/error.html.
+ return_url - String! + The relative URL of the order confirmation page that PayPal redirects to when the payment is successful and additional confirmation is not needed. If the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.
+
+
+
+
+
Example
+ 
{
+  "cancel_url": "xyz789",
+  "error_url": "abc123",
+  "return_url": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

PayflowLinkMode

+
+
+
+
Description
+

Indicates the mode for payment. Applies to the Payflow Link and Payments Advanced payment methods.

+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

TEST

+ 		+
+

LIVE

+ 		+
+
+
+
+
+
Example
+ 
"TEST"
+
+
+
+
+
+
+
+ Types +
+

PayflowLinkToken

+
+
+
+
Description
+

Contains information used to generate PayPal iframe for transaction. Applies to Payflow Link and Payments Advanced payment methods.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
mode - PayflowLinkMode + The mode for the Payflow transaction.
paypal_url - String + The PayPal URL used for requesting a Payflow form.
secure_token - String + The secure token generated by PayPal.
secure_token_id - String + The secure token ID generated by PayPal.
+
+
+
+
+
Example
+ 
{
+  "mode": "TEST",
+  "paypal_url": "abc123",
+  "secure_token": "xyz789",
+  "secure_token_id": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

PayflowLinkTokenInput

+
+
+
+
Description
+

Contains information required to fetch payment token information for the Payflow Link and Payments Advanced payment methods.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID that identifies the customer's cart.
+
+
+
+
+
Example
+ 
{"cart_id": "xyz789"}
+
+
+
+
+
+
+
+ Types +
+

PayflowProInput

+
+
+
+
Description
+

Contains input for the Payflow Pro and Payments Pro payment methods.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cc_details - CreditCardDetailsInput! + Required input for credit card related information.
+ is_active_payment_token_enabler - Boolean + Indicates whether details about the shopper's credit/debit card should be tokenized for later usage. Required only if Vault is enabled for the PayPal Payflow Pro payment integration.
+
+
+
+
+
Example
+ 
{
+  "cc_details": CreditCardDetailsInput,
+  "is_active_payment_token_enabler": false
+}
+
+
+
+
+
+
+
+ Types +
+

PayflowProResponseInput

+
+
+
+
Description
+

Input required to complete payment. Applies to Payflow Pro and Payments Pro payment methods.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID that identifies the shopper's cart.
+ paypal_payload - String! + The payload returned from PayPal.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "xyz789",
+  "paypal_payload": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

PayflowProResponseOutput

+
+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The cart with the updated selected payment method.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

PayflowProTokenInput

+
+
+
+
Description
+

Contains input required to fetch payment token information for the Payflow Pro and Payments Pro payment methods.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID that identifies the shopper's cart.
+ urls - PayflowProUrlInput! + A set of relative URLs that PayPal uses for callback.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "abc123",
+  "urls": PayflowProUrlInput
+}
+
+
+
+
+
+
+
+ Types +
+

PayflowProUrlInput

+
+
+
+
Description
+

Contains a set of relative URLs that PayPal uses in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for the Payflow Pro and Payment Pro payment methods.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cancel_url - String! + The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. If the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.
+ error_url - String! + The relative URL of the transaction error page that PayPal redirects to upon payment error. If the full URL to this page is https://www.example.com/paypal/action/error.html, the relative URL is paypal/action/error.html.
+ return_url - String! + The relative URL of the final confirmation page that PayPal redirects to upon payment success. If the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.
+
+
+
+
+
Example
+ 
{
+  "cancel_url": "xyz789",
+  "error_url": "xyz789",
+  "return_url": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

PaymentConfigItem

+
+
+
+
Description
+

Contains payment fields that are common to all types of payment methods.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
code - String + The payment method code as defined in the payment gateway
is_visible - Boolean + Indicates whether the payment method is displayed
payment_intent - String + Defines the payment intent (Authorize or Capture
sdk_params - [SDKParams] + The PayPal parameters required to load the JS SDK
sort_order - String + The relative order the payment method is displayed on the checkout page
title - String + The name displayed for the payment method
+
+
+
Possible Types
+ + + + + + + + + + + + + + + + + + + + + + + +
PaymentConfigItem Types
+

HostedFieldsConfig

+
+

SmartButtonsConfig

+
+

ApplePayConfig

+
+

GooglePayConfig

+
+

FastlaneConfig

+
+
+
+
+
+
Example
+ 
{
+  "code": "abc123",
+  "is_visible": true,
+  "payment_intent": "xyz789",
+  "sdk_params": [SDKParams],
+  "sort_order": "abc123",
+  "title": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

PaymentConfigOutput

+
+
+
+
Description
+

Retrieves the payment configuration for a given location

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
apple_pay - ApplePayConfig + ApplePay payment method configuration
fastlane - FastlaneConfig + Fastlane payment method configuration
google_pay - GooglePayConfig + GooglePay payment method configuration
hosted_fields - HostedFieldsConfig + Hosted fields payment method configuration
smart_buttons - SmartButtonsConfig + Smart Buttons payment method configuration
+
+
+
+
+
Example
+ 
{
+  "apple_pay": ApplePayConfig,
+  "fastlane": FastlaneConfig,
+  "google_pay": GooglePayConfig,
+  "hosted_fields": HostedFieldsConfig,
+  "smart_buttons": SmartButtonsConfig
+}
+
+
+
+
+
+
+
+ Types +
+

PaymentLocation

+
+
+
+
Description
+

Defines the origin location for that payment request

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

PRODUCT_DETAIL

+ 		+
+

MINICART

+ 		+
+

CART

+ 		+
+

CHECKOUT

+ 		+
+

START_OF_CHECKOUT

+ 		+
+

ADMIN

+ 		+
+
+
+
+
+
Example
+ 
"PRODUCT_DETAIL"
+
+
+
+
+
+
+
+ Types +
+

PaymentMethodInput

+
+
+
+
Description
+

Defines the payment method.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ braintree - BraintreeInput + +
+ braintree_ach_direct_debit - BraintreeInput + +
+ braintree_ach_direct_debit_vault - BraintreeVaultInput + +
+ braintree_applepay_vault - BraintreeVaultInput + +
+ braintree_cc_vault - BraintreeCcVaultInput + +
+ braintree_googlepay_vault - BraintreeVaultInput + +
+ braintree_paypal - BraintreeInput + +
+ braintree_paypal_vault - BraintreeVaultInput + +
+ code - String! + The internal name for the payment method.
+ hosted_pro - HostedProInput + Required input for PayPal Hosted pro payments.
+ payflow_express - PayflowExpressInput + Required input for Payflow Express Checkout payments.
+ payflow_link - PayflowLinkInput + Required input for PayPal Payflow Link and Payments Advanced payments.
+ payflowpro - PayflowProInput + Required input for PayPal Payflow Pro and Payment Pro payments.
+ payflowpro_cc_vault - VaultTokenInput + Required input for PayPal Payflow Pro vault payments.
+ payment_services_paypal_apple_pay - ApplePayMethodInput + Required input for Apple Pay button
+ payment_services_paypal_fastlane - FastlaneMethodInput + Required input for fastlane
+ payment_services_paypal_google_pay - GooglePayMethodInput + Required input for Google Pay button
+ payment_services_paypal_hosted_fields - HostedFieldsInput + Required input for Hosted Fields
+ payment_services_paypal_smart_buttons - SmartButtonMethodInput + Required input for Smart buttons
+ payment_services_paypal_vault - VaultMethodInput + Required input for vault
+ paypal_express - PaypalExpressInput + Required input for Express Checkout and Payments Standard payments.
+ purchase_order_number - String + The purchase order number. Optional for most payment methods.
+
+
+
+
+
Example
+ 
{
+  "braintree": BraintreeInput,
+  "braintree_ach_direct_debit": BraintreeInput,
+  "braintree_ach_direct_debit_vault": BraintreeVaultInput,
+  "braintree_applepay_vault": BraintreeVaultInput,
+  "braintree_cc_vault": BraintreeCcVaultInput,
+  "braintree_googlepay_vault": BraintreeVaultInput,
+  "braintree_paypal": BraintreeInput,
+  "braintree_paypal_vault": BraintreeVaultInput,
+  "code": "abc123",
+  "hosted_pro": HostedProInput,
+  "payflow_express": PayflowExpressInput,
+  "payflow_link": PayflowLinkInput,
+  "payflowpro": PayflowProInput,
+  "payflowpro_cc_vault": VaultTokenInput,
+  "payment_services_paypal_apple_pay": ApplePayMethodInput,
+  "payment_services_paypal_fastlane": FastlaneMethodInput,
+  "payment_services_paypal_google_pay": GooglePayMethodInput,
+  "payment_services_paypal_hosted_fields": HostedFieldsInput,
+  "payment_services_paypal_smart_buttons": SmartButtonMethodInput,
+  "payment_services_paypal_vault": VaultMethodInput,
+  "paypal_express": PaypalExpressInput,
+  "purchase_order_number": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

PaymentOrderOutput

+
+
+
+
Description
+

Contains the payment order details

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
id - String + PayPal order ID
mp_order_id - String + The order ID generated by Payment Services
payment_source_details - PaymentSourceDetails + Details about the card used on the order
status - String + The status of the payment order
+
+
+
+
+
Example
+ 
{
+  "id": "xyz789",
+  "mp_order_id": "abc123",
+  "payment_source_details": PaymentSourceDetails,
+  "status": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

PaymentSDKParamsItem

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
code - String + The payment method code used in the order
params - [SDKParams] + The payment SDK parameters
+
+
+
+
+
Example
+ 
{
+  "code": "xyz789",
+  "params": [SDKParams]
+}
+
+
+
+
+
+
+
+ Types +
+

PaymentSourceDetails

+
+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
card - Card + Details about the card used on the order
+
+
+
+
+
Example
+ 
{"card": Card}
+
+
+
+
+
+
+
+ Types +
+

PaymentSourceInput

+
+
+
+
Description
+

The payment source information

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ card - CardPaymentSourceInput! + The card payment source information
+
+
+
+
+
Example
+ 
{"card": CardPaymentSourceInput}
+
+
+
+
+
+
+
+ Types +
+

PaymentSourceOutput

+
+
+
+
Description
+

The payment source information

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
card - CardPaymentSourceOutput! + The card payment source information
+
+
+
+
+
Example
+ 
{"card": CardPaymentSourceOutput}
+
+
+
+
+
+
+
+ Types +
+

PaymentToken

+
+
+
+
Description
+

The stored payment method available to the customer.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
details - String + A description of the stored account details.
payment_method_code - String! + The payment method code associated with the token.
public_hash - String! + The public hash of the token.
type - PaymentTokenTypeEnum! + Specifies the payment token type.
+
+
+
+
+
Example
+ 
{
+  "details": "abc123",
+  "payment_method_code": "abc123",
+  "public_hash": "abc123",
+  "type": "card"
+}
+
+
+
+
+
+
+
+ Types +
+

PaymentTokenTypeEnum

+
+
+
+
Description
+

The list of available payment token types.

+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

card

+ 		phpcs:ignore Magento2.GraphQL.ValidArgumentName
+

account

+ 		phpcs:ignore Magento2.GraphQL.ValidArgumentName
+
+
+
+
+
Example
+ 
"card"
+
+
+
+
+
+
+
+ Types +
+

PaypalExpressInput

+
+
+
+
Description
+

Contains required input for Express Checkout and Payments Standard payments.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ payer_id - String! + The unique ID of the PayPal user.
+ token - String! + The token returned by the createPaypalExpressToken mutation.
+
+
+
+
+
Example
+ 
{
+  "payer_id": "abc123",
+  "token": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

PaypalExpressTokenInput

+
+
+
+
Description
+

Defines the attributes required to receive a payment token for Express Checkout and Payments Standard payment methods.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID that identifies the customer's cart.
+ code - String! + The payment method code.
+ express_button - Boolean + Indicates whether the buyer selected the quick checkout button. The default value is false.
+ urls - PaypalExpressUrlsInput! + A set of relative URLs that PayPal uses in response to various actions during the authorization process.
+ use_paypal_credit - Boolean + Indicates whether the buyer clicked the PayPal credit button. The default value is false.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "abc123",
+  "code": "abc123",
+  "express_button": false,
+  "urls": PaypalExpressUrlsInput,
+  "use_paypal_credit": true
+}
+
+
+
+
+
+
+
+ Types +
+

PaypalExpressTokenOutput

+
+
+
+
Description
+

Contains the token returned by PayPal and a set of URLs that allow the buyer to authorize payment and adjust checkout details. Applies to Express Checkout and Payments Standard payment methods.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
paypal_urls - PaypalExpressUrlList + A set of URLs that allow the buyer to authorize payment and adjust checkout details.
token - String + The token returned by PayPal.
+
+
+
+
+
Example
+ 
{
+  "paypal_urls": PaypalExpressUrlList,
+  "token": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

PaypalExpressUrlList

+
+
+
+
Description
+

Contains a set of URLs that allow the buyer to authorize payment and adjust checkout details for Express Checkout and Payments Standard transactions.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
edit - String + The PayPal URL that allows the buyer to edit their checkout details.
start - String + The URL to the PayPal login page.
+
+
+
+
+
Example
+ 
{
+  "edit": "abc123",
+  "start": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

PaypalExpressUrlsInput

+
+
+
+
Description
+

Contains a set of relative URLs that PayPal uses in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Express Checkout and Payments Standard payment methods.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cancel_url - String! + The relative URL of the page that PayPal redirects to when the buyer cancels the transaction in order to choose a different payment method. If the full URL to this page is https://www.example.com/paypal/action/cancel.html, the relative URL is paypal/action/cancel.html.
+ pending_url - String + The relative URL of the page that PayPal redirects to when the payment has been put on hold for additional review. This condition mostly applies to ACH transactions, and is not applicable to most PayPal solutions. If the full URL to this page is https://www.example.com/paypal/action/success_pending.html, the relative URL is paypal/action/success_pending.html.
+ return_url - String! + The relative URL of the final confirmation page that PayPal redirects to upon payment success. If the full URL to this page is https://www.example.com/paypal/action/return.html, the relative URL is paypal/action/return.html.
+ success_url - String + The relative URL of the order confirmation page that PayPal redirects to when the payment is successful and additional confirmation is not needed. Not applicable to most PayPal solutions. If the full URL to this page is https://www.example.com/paypal/action/success.html, the relative URL is paypal/action/success.html.
+
+
+
+
+
Example
+ 
{
+  "cancel_url": "xyz789",
+  "pending_url": "xyz789",
+  "return_url": "abc123",
+  "success_url": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

PhysicalProductInterface

+
+
+
+
Description
+

Contains attributes specific to tangible products.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
weight - Float + The weight of the item, in units defined by the store.
+
+
+
Possible Types
+ + + + + + + + + + + + + + + + + + + + + + + +
PhysicalProductInterface Types
+

SimpleProduct

+
+

ConfigurableProduct

+
+

BundleProduct

+
+

GiftCardProduct

+
+

GroupedProduct

+
+
+
+
+
+
Example
+ 
{"weight": 123.45}
+
+
+
+
+
+
+
+ Types +
+

PickupLocation

+
+
+
+
Description
+

Defines Pickup Location information.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
city - String + +
contact_name - String + +
country_id - String + +
description - String + +
email - String + +
fax - String + +
latitude - Float + +
longitude - Float + +
name - String + +
phone - String + +
pickup_location_code - String + +
postcode - String + +
region - String + +
region_id - Int + +
street - String + +
+
+
+
+
+
Example
+ 
{
+  "city": "xyz789",
+  "contact_name": "abc123",
+  "country_id": "abc123",
+  "description": "xyz789",
+  "email": "abc123",
+  "fax": "xyz789",
+  "latitude": 987.65,
+  "longitude": 123.45,
+  "name": "abc123",
+  "phone": "xyz789",
+  "pickup_location_code": "abc123",
+  "postcode": "xyz789",
+  "region": "abc123",
+  "region_id": 123,
+  "street": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

PickupLocationFilterInput

+
+
+
+
Description
+

PickupLocationFilterInput defines the list of attributes and filters for the search.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ city - FilterTypeInput + Filter by city.
+ country_id - FilterTypeInput + Filter by country.
+ name - FilterTypeInput + Filter by pickup location name.
+ pickup_location_code - FilterTypeInput + Filter by pickup location code.
+ postcode - FilterTypeInput + Filter by postcode.
+ region - FilterTypeInput + Filter by region.
+ region_id - FilterTypeInput + Filter by region id.
+ street - FilterTypeInput + Filter by street.
+
+
+
+
+
Example
+ 
{
+  "city": FilterTypeInput,
+  "country_id": FilterTypeInput,
+  "name": FilterTypeInput,
+  "pickup_location_code": FilterTypeInput,
+  "postcode": FilterTypeInput,
+  "region": FilterTypeInput,
+  "region_id": FilterTypeInput,
+  "street": FilterTypeInput
+}
+
+
+
+
+
+
+
+ Types +
+

PickupLocationSortInput

+
+
+
+
Description
+

PickupLocationSortInput specifies attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ city - SortEnum + City where pickup location is placed.
+ contact_name - SortEnum + Name of the contact person.
+ country_id - SortEnum + Id of the country in two letters.
+ description - SortEnum + Description of the pickup location.
+ distance - SortEnum + Distance to the address, requested by distance filter. Applicable only with distance filter. If distance sort order is present, all other sort orders will be ignored.
+ email - SortEnum + Contact email of the pickup location.
+ fax - SortEnum + Contact fax of the pickup location.
+ latitude - SortEnum + Geographic latitude where pickup location is placed.
+ longitude - SortEnum + Geographic longitude where pickup location is placed.
+ name - SortEnum + The pickup location name. Customer use this to identify the pickup location.
+ phone - SortEnum + Contact phone number of the pickup location.
+ pickup_location_code - SortEnum + A code assigned to pickup location to identify the source.
+ postcode - SortEnum + Postcode where pickup location is placed.
+ region - SortEnum + Name of the region.
+ region_id - SortEnum + Id of the region.
+ street - SortEnum + Street where pickup location is placed.
+
+
+
+
+
Example
+ 
{
+  "city": "ASC",
+  "contact_name": "ASC",
+  "country_id": "ASC",
+  "description": "ASC",
+  "distance": "ASC",
+  "email": "ASC",
+  "fax": "ASC",
+  "latitude": "ASC",
+  "longitude": "ASC",
+  "name": "ASC",
+  "phone": "ASC",
+  "pickup_location_code": "ASC",
+  "postcode": "ASC",
+  "region": "ASC",
+  "region_id": "ASC",
+  "street": "ASC"
+}
+
+
+
+
+
+
+
+ Types +
+

PickupLocations

+
+
+
+
Description
+

Top level object returned in a pickup locations search.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items - [PickupLocation] + An array of pickup locations that match the specific search request.
page_info - SearchResultPageInfo + An object that includes the page_info and currentPage values specified in the query.
total_count - Int + The number of products returned.
+
+
+
+
+
Example
+ 
{
+  "items": [PickupLocation],
+  "page_info": SearchResultPageInfo,
+  "total_count": 987
+}
+
+
+
+
+
+
+
+ Types +
+

PlaceNegotiableQuoteOrderInput

+
+
+
+
Description
+

Specifies the negotiable quote to convert to an order.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ quote_uid - ID! + The unique ID of a NegotiableQuote object.
+
+
+
+
+
Example
+ 
{"quote_uid": "4"}
+
+
+
+
+
+
+
+ Types +
+

PlaceNegotiableQuoteOrderOutput

+
+
+
+
Description
+

An output object that returns the generated order.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
order - Order! + Contains the generated order number.
+
+
+
+
+
Example
+ 
{"order": Order}
+
+
+
+
+
+
+
+ Types +
+

PlaceOrderError

+
+
+
+
Description
+

An error encountered while placing an order.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
code - PlaceOrderErrorCodes! + An error code that is specific to place order.
message - String! + A localized error message.
+
+
+
+
+
Example
+ 
{
+  "code": "CART_NOT_FOUND",
+  "message": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

PlaceOrderErrorCodes

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

CART_NOT_FOUND

+ 		+
+

CART_NOT_ACTIVE

+ 		+
+

GUEST_EMAIL_MISSING

+ 		+
+

UNABLE_TO_PLACE_ORDER

+ 		+
+

UNDEFINED

+ 		+
+
+
+
+
+
Example
+ 
"CART_NOT_FOUND"
+
+
+
+
+
+
+
+ Types +
+

PlaceOrderForPurchaseOrderInput

+
+
+
+
Description
+

Specifies the purchase order to convert to an order.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ purchase_order_uid - ID! + The unique ID of a purchase order.
+
+
+
+
+
Example
+ 
{"purchase_order_uid": "4"}
+
+
+
+
+
+
+
+ Types +
+

PlaceOrderForPurchaseOrderOutput

+
+
+
+
Description
+

Contains the results of the request to place an order.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
order - CustomerOrder! + Placed order.
+
+
+
+
+
Example
+ 
{"order": CustomerOrder}
+
+
+
+
+
+
+
+ Types +
+

PlaceOrderInput

+
+
+
+
Description
+

Specifies the quote to be converted to an order.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID of a Cart object.
+
+
+
+
+
Example
+ 
{"cart_id": "abc123"}
+
+
+
+
+
+
+
+ Types +
+

PlaceOrderOutput

+
+
+
+
Description
+

Contains the results of the request to place an order.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
errors - [PlaceOrderError] + An array of place order errors.
order - Order + The ID of the order. Use orderV2 instead. +
orderV2 - CustomerOrder + Full order information.
+
+
+
+
+
Example
+ 
{
+  "errors": [PlaceOrderError],
+  "order": Order,
+  "orderV2": CustomerOrder
+}
+
+
+
+
+
+
+
+ Types +
+

PlacePurchaseOrderInput

+
+
+
+
Description
+

Specifies the quote to be converted to a purchase order.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID of a Cart object.
+
+
+
+
+
Example
+ 
{"cart_id": "abc123"}
+
+
+
+
+
+
+
+ Types +
+

PlacePurchaseOrderOutput

+
+
+
+
Description
+

Contains the results of the request to place a purchase order.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
purchase_order - PurchaseOrder! + Placed purchase order.
+
+
+
+
+
Example
+ 
{"purchase_order": PurchaseOrder}
+
+
+
+
+
+
+
+ Types +
+

Price

+
+
+
+
Description
+

Deprecated. Use ProductPrice instead. Defines the price of a product as well as any tax-related adjustments.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
adjustments - [PriceAdjustment] + An array that provides information about tax, weee, or weee_tax adjustments. Use ProductPrice instead. +
amount - Money + The price of a product plus a three-letter currency code. Use ProductPrice instead. +
+
+
+
+
+
Example
+ 
{
+  "adjustments": [PriceAdjustment],
+  "amount": Money
+}
+
+
+
+
+
+
+
+ Types +
+

PriceAdjustment

+
+
+
+
Description
+

Deprecated. Taxes will be included or excluded in the price. Defines the amount of money to apply as an adjustment, the type of adjustment to apply, and whether the item is included or excluded from the adjustment.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
amount - Money + The amount of the price adjustment and its currency code.
code - PriceAdjustmentCodesEnum + Indicates whether the adjustment involves tax, weee, or weee_tax. PriceAdjustment is deprecated. +
description - PriceAdjustmentDescriptionEnum + Indicates whether the entity described by the code attribute is included or excluded from the adjustment. PriceAdjustment is deprecated. +
+
+
+
+
+
Example
+ 
{
+  "amount": Money,
+  "code": "TAX",
+  "description": "INCLUDED"
+}
+
+
+
+
+
+
+
+ Types +
+

PriceAdjustmentCodesEnum

+
+
+
+
Description
+

PriceAdjustment.code is deprecated.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

TAX

+ 		+ PriceAdjustmentCodesEnum is deprecated. Tax is included or excluded in the price. Tax is not shown separately in Catalog. +
+

WEEE

+ 		+ WEEE code is deprecated. Use fixed_product_taxes.label instead. +
+

WEEE_TAX

+ 		+ Use fixed_product_taxes instead. Tax is included or excluded in price. The tax is not shown separtely in Catalog. +
+
+
+
+
+
Example
+ 
"TAX"
+
+
+
+
+
+
+
+ Types +
+

PriceAdjustmentDescriptionEnum

+
+
+
+
Description
+

PriceAdjustmentDescriptionEnum is deprecated. States whether a price adjustment is included or excluded.

+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

INCLUDED

+ 		+
+

EXCLUDED

+ 		+
+
+
+
+
+
Example
+ 
"INCLUDED"
+
+
+
+
+
+
+
+ Types +
+

PriceDetails

+
+
+
+
Description
+

Can be used to retrieve the main price details in case of bundle product

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
discount_percentage - Float + The percentage of discount applied to the main product price
main_final_price - Float + The final price after applying the discount to the main product
main_price - Float + The regular price of the main product
+
+
+
+
+
Example
+ 
{
+  "discount_percentage": 123.45,
+  "main_final_price": 987.65,
+  "main_price": 987.65
+}
+
+
+
+
+
+
+
+ Types +
+

PriceRange

+
+
+
+
Description
+

Contains the price range for a product. If the product has a single price, the minimum and maximum price will be the same.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
maximum_price - ProductPrice + The highest possible price for the product.
minimum_price - ProductPrice! + The lowest possible price for the product.
+
+
+
+
+
Example
+ 
{
+  "maximum_price": ProductPrice,
+  "minimum_price": ProductPrice
+}
+
+
+
+
+
+
+
+ Types +
+

PriceTypeEnum

+
+
+
+
Description
+

Defines the price type.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

FIXED

+ 		+
+

PERCENT

+ 		+
+

DYNAMIC

+ 		+
+
+
+
+
+
Example
+ 
"FIXED"
+
+
+
+
+
+
+
+ Types +
+

PriceViewEnum

+
+
+
+
Description
+

Defines whether a bundle product's price is displayed as the lowest possible value or as a range.

+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

PRICE_RANGE

+ 		+
+

AS_LOW_AS

+ 		+
+
+
+
+
+
Example
+ 
"PRICE_RANGE"
+
+
+
+
+
+
+
+ Types +
+

ProductAttribute

+
+
+
+
Description
+

Contains a product attribute code and value.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
code - String! + The unique identifier for a product attribute code.
value - String! + The display value of the attribute.
+
+
+
+
+
Example
+ 
{
+  "code": "xyz789",
+  "value": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

ProductAttributeFilterInput

+
+
+
+
Description
+

Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ activity - FilterEqualTypeInput + Attribute label: Activity
+ category_gear - FilterEqualTypeInput + Attribute label: Category Gear
+ category_id - FilterEqualTypeInput + Deprecated: use category_uid to filter product by category ID.
+ category_uid - FilterEqualTypeInput + Filter product by the unique ID for a CategoryInterface object.
+ category_url_path - FilterEqualTypeInput + Filter product by category URL path.
+ climate - FilterEqualTypeInput + Attribute label: Climate
+ collar - FilterEqualTypeInput + Attribute label: Collar
+ color - FilterEqualTypeInput + Attribute label: Color
+ description - FilterMatchTypeInput + Attribute label: Description
+ eco_collection - FilterEqualTypeInput + Attribute label: Eco Collection
+ erin_recommends - FilterEqualTypeInput + Attribute label: Erin Recommends
+ features_bags - FilterEqualTypeInput + Attribute label: Features
+ format - FilterEqualTypeInput + Attribute label: Format
+ gender - FilterEqualTypeInput + Attribute label: Gender
+ material - FilterEqualTypeInput + Attribute label: Material
+ name - FilterMatchTypeInput + Attribute label: Product Name
+ new - FilterEqualTypeInput + Attribute label: New
+ pattern - FilterEqualTypeInput + Attribute label: Pattern
+ performance_fabric - FilterEqualTypeInput + Attribute label: Performance Fabric
+ price - FilterRangeTypeInput + Attribute label: Price
+ purpose - FilterEqualTypeInput + Attribute label: Purpose
+ sale - FilterEqualTypeInput + Attribute label: Sale
+ short_description - FilterMatchTypeInput + Attribute label: Short Description
+ size - FilterEqualTypeInput + Attribute label: Size
+ sku - FilterEqualTypeInput + Attribute label: SKU
+ sleeve - FilterEqualTypeInput + Attribute label: Sleeve
+ strap_bags - FilterEqualTypeInput + Attribute label: Strap/Handle
+ style_bags - FilterEqualTypeInput + Attribute label: Style Bags
+ style_bottom - FilterEqualTypeInput + Attribute label: Style Bottom
+ style_general - FilterEqualTypeInput + Attribute label: Style General
+ url_key - FilterEqualTypeInput + The part of the URL that identifies the product
+
+
+
+
+
Example
+ 
{
+  "activity": FilterEqualTypeInput,
+  "category_gear": FilterEqualTypeInput,
+  "category_id": FilterEqualTypeInput,
+  "category_uid": FilterEqualTypeInput,
+  "category_url_path": FilterEqualTypeInput,
+  "climate": FilterEqualTypeInput,
+  "collar": FilterEqualTypeInput,
+  "color": FilterEqualTypeInput,
+  "description": FilterMatchTypeInput,
+  "eco_collection": FilterEqualTypeInput,
+  "erin_recommends": FilterEqualTypeInput,
+  "features_bags": FilterEqualTypeInput,
+  "format": FilterEqualTypeInput,
+  "gender": FilterEqualTypeInput,
+  "material": FilterEqualTypeInput,
+  "name": FilterMatchTypeInput,
+  "new": FilterEqualTypeInput,
+  "pattern": FilterEqualTypeInput,
+  "performance_fabric": FilterEqualTypeInput,
+  "price": FilterRangeTypeInput,
+  "purpose": FilterEqualTypeInput,
+  "sale": FilterEqualTypeInput,
+  "short_description": FilterMatchTypeInput,
+  "size": FilterEqualTypeInput,
+  "sku": FilterEqualTypeInput,
+  "sleeve": FilterEqualTypeInput,
+  "strap_bags": FilterEqualTypeInput,
+  "style_bags": FilterEqualTypeInput,
+  "style_bottom": FilterEqualTypeInput,
+  "style_general": FilterEqualTypeInput,
+  "url_key": FilterEqualTypeInput
+}
+
+
+
+
+
+
+
+ Types +
+

ProductAttributeSortInput

+
+
+
+
Description
+

Specifies the attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. It's possible to sort products using searchable attributes with enabled 'Use in Filter Options' option

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ name - SortEnum + Attribute label: Product Name
+ position - SortEnum + Sort by the position assigned to each product.
+ price - SortEnum + Attribute label: Price
+ relevance - SortEnum + Sort by the search relevance score (default).
+
+
+
+
+
Example
+ 
{"name": "ASC", "position": "ASC", "price": "ASC", "relevance": "ASC"}
+
+
+
+
+
+
+
+ Types +
+

ProductCustomAttributes

+
+
+
+
Description
+

Product custom attributes

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
errors - [AttributeMetadataError]! + Errors when retrieving custom attributes metadata.
items - [AttributeValueInterface]! + Requested custom attributes
+
+
+
+
+
Example
+ 
{
+  "errors": [AttributeMetadataError],
+  "items": [AttributeValueInterface]
+}
+
+
+
+
+
+
+
+ Types +
+

ProductDiscount

+
+
+
+
Description
+

Contains the discount applied to a product price.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
amount_off - Float + The actual value of the discount.
percent_off - Float + The discount expressed a percentage.
+
+
+
+
+
Example
+ 
{"amount_off": 123.45, "percent_off": 987.65}
+
+
+
+
+
+
+
+ Types +
+

ProductFilterInput

+
+
+
+
Description
+

ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. ProductFilterInput defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ category_id - FilterTypeInput + The category ID the product belongs to.
+ country_of_manufacture - FilterTypeInput + The product's country of origin.
+ created_at - FilterTypeInput + The timestamp indicating when the product was created.
+ custom_layout - FilterTypeInput + The name of a custom layout.
+ custom_layout_update - FilterTypeInput + XML code that is applied as a layout update to the product page.
+ description - FilterTypeInput + Detailed information about the product. The value can include simple HTML tags.
+ gift_message_available - FilterTypeInput + Indicates whether a gift message is available.
+ has_options - FilterTypeInput + Indicates whether additional attributes have been created for the product.
+ image - FilterTypeInput + The relative path to the main image on the product page.
+ image_label - FilterTypeInput + The label assigned to a product image.
+ is_returnable - FilterTypeInput + Indicates whether the product can be returned.
+ manufacturer - FilterTypeInput + A number representing the product's manufacturer.
+ max_price - FilterTypeInput + The numeric maximal price of the product. Do not include the currency code.
+ meta_description - FilterTypeInput + A brief overview of the product for search results listings, maximum 255 characters.
+ meta_keyword - FilterTypeInput + A comma-separated list of keywords that are visible only to search engines.
+ meta_title - FilterTypeInput + A string that is displayed in the title bar and tab of the browser and in search results lists.
+ min_price - FilterTypeInput + The numeric minimal price of the product. Do not include the currency code.
+ name - FilterTypeInput + The product name. Customers use this name to identify the product.
+ news_from_date - FilterTypeInput + The beginning date for new product listings, and determines if the product is featured as a new product.
+ news_to_date - FilterTypeInput + The end date for new product listings.
+ options_container - FilterTypeInput + If the product has multiple options, determines where they appear on the product page.
+ or - ProductFilterInput + The keyword required to perform a logical OR comparison.
+ price - FilterTypeInput + The price of an item.
+ required_options - FilterTypeInput + Indicates whether the product has required options.
+ short_description - FilterTypeInput + A short description of the product. Its use depends on the theme.
+ sku - FilterTypeInput + A number or code assigned to a product to identify the product, options, price, and manufacturer.
+ small_image - FilterTypeInput + The relative path to the small image, which is used on catalog pages.
+ small_image_label - FilterTypeInput + The label assigned to a product's small image.
+ special_from_date - FilterTypeInput + The beginning date that a product has a special price.
+ special_price - FilterTypeInput + The discounted price of the product. Do not include the currency code.
+ special_to_date - FilterTypeInput + The end date that a product has a special price.
+ swatch_image - FilterTypeInput + The file name of a swatch image.
+ thumbnail - FilterTypeInput + The relative path to the product's thumbnail image.
+ thumbnail_label - FilterTypeInput + The label assigned to a product's thumbnail image.
+ tier_price - FilterTypeInput + The price when tier pricing is in effect and the items purchased threshold has been reached.
+ updated_at - FilterTypeInput + The timestamp indicating when the product was updated.
+ url_key - FilterTypeInput + The part of the URL that identifies the product
+ url_path - FilterTypeInput + +
+ weight - FilterTypeInput + The weight of the item, in units defined by the store.
+
+
+
+
+
Example
+ 
{
+  "category_id": FilterTypeInput,
+  "country_of_manufacture": FilterTypeInput,
+  "created_at": FilterTypeInput,
+  "custom_layout": FilterTypeInput,
+  "custom_layout_update": FilterTypeInput,
+  "description": FilterTypeInput,
+  "gift_message_available": FilterTypeInput,
+  "has_options": FilterTypeInput,
+  "image": FilterTypeInput,
+  "image_label": FilterTypeInput,
+  "is_returnable": FilterTypeInput,
+  "manufacturer": FilterTypeInput,
+  "max_price": FilterTypeInput,
+  "meta_description": FilterTypeInput,
+  "meta_keyword": FilterTypeInput,
+  "meta_title": FilterTypeInput,
+  "min_price": FilterTypeInput,
+  "name": FilterTypeInput,
+  "news_from_date": FilterTypeInput,
+  "news_to_date": FilterTypeInput,
+  "options_container": FilterTypeInput,
+  "or": ProductFilterInput,
+  "price": FilterTypeInput,
+  "required_options": FilterTypeInput,
+  "short_description": FilterTypeInput,
+  "sku": FilterTypeInput,
+  "small_image": FilterTypeInput,
+  "small_image_label": FilterTypeInput,
+  "special_from_date": FilterTypeInput,
+  "special_price": FilterTypeInput,
+  "special_to_date": FilterTypeInput,
+  "swatch_image": FilterTypeInput,
+  "thumbnail": FilterTypeInput,
+  "thumbnail_label": FilterTypeInput,
+  "tier_price": FilterTypeInput,
+  "updated_at": FilterTypeInput,
+  "url_key": FilterTypeInput,
+  "url_path": FilterTypeInput,
+  "weight": FilterTypeInput
+}
+
+
+
+
+
+
+
+ Types +
+

ProductImage

+
+
+
+
Description
+

Contains product image information, including the image URL and label.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
disabled - Boolean + Indicates whether the image is hidden from view.
label - String + The label of the product image or video.
position - Int + The media item's position after it has been sorted.
types - [String] + Array of image types. It can have the following values: image, small_image, thumbnail.
url - String + The URL of the product image or video.
+
+
+
+
+
Example
+ 
{
+  "disabled": false,
+  "label": "xyz789",
+  "position": 987,
+  "types": ["abc123"],
+  "url": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

ProductImageThumbnail

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

ITSELF

+ 		Use thumbnail of product as image.
+

PARENT

+ 		Use thumbnail of product's parent as image.
+
+
+
+
+
Example
+ 
"ITSELF"
+
+
+
+
+
+
+
+ Types +
+

ProductInfoInput

+
+
+
+
Description
+

Product Information used for Pickup Locations search.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ sku - String! + Product SKU.
+
+
+
+
+
Example
+ 
{"sku": "abc123"}
+
+
+
+
+
+
+
+ Types +
+

ProductInterface

+
+
+
+
Description
+

Contains fields that are common to all types of products.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
activity - String + + Use the custom_attributes field instead. +
attribute_set_id - Int + The attribute set assigned to the product. The field should not be used on the storefront. +
canonical_url - String + The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface] + The categories assigned to a product.
category_gear - String + + Use the custom_attributes field instead. +
climate - String + + Use the custom_attributes field instead. +
collar - String + + Use the custom_attributes field instead. +
color - Int + + Use the custom_attributes field instead. +
country_of_manufacture - String + The product's country of origin.
created_at - String + Timestamp indicating when the product was created. The field should not be used on the storefront. +
crosssell_products - [ProductInterface] + An array of cross-sell products.
custom_attributesV2 - ProductCustomAttributes + Product custom attributes.
+
+
Arguments
+
+
+
filters - AttributeFilterInput +
+
+
+
+
description - ComplexTextValue + Detailed information about the product. The value can include simple HTML tags.
eco_collection - Int + + Use the custom_attributes field instead. +
erin_recommends - Int + + Use the custom_attributes field instead. +
features_bags - String + + Use the custom_attributes field instead. +
format - Int + + Use the custom_attributes field instead. +
gender - String + + Use the custom_attributes field instead. +
gift_message_available - Boolean! + Returns a value indicating gift message availability for the product.
gift_wrapping_available - Boolean! + Returns a value indicating gift wrapping availability for the product.
gift_wrapping_price - Money + Returns value and currency indicating gift wrapping price for the product.
id - Int + The ID number assigned to the product. Use the uid field instead. +
image - ProductImage + The relative path to the main image on the product page.
is_returnable - String + Indicates whether the product can be returned.
manufacturer - Int + A number representing the product's manufacturer. Use the custom_attributes field instead. +
material - String + + Use the custom_attributes field instead. +
max_sale_qty - Float + Maximum Qty Allowed in Shopping Cart
media_gallery - [MediaGalleryInterface] + An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry] + An array of MediaGalleryEntry objects. Use media_gallery instead. +
meta_description - String + A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String + A comma-separated list of keywords that are visible only to search engines.
meta_title - String + A string that is displayed in the title bar and tab of the browser and in search results lists.
min_sale_qty - Float + Minimum Qty Allowed in Shopping Cart
name - String + The product name. Customers use this name to identify the product.
new - Int + + Use the custom_attributes field instead. +
new_from_date - String + The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String + The end date for new product listings.
only_x_left_in_stock - Float + Product stock only x left count
options_container - String + If the product has multiple options, determines where they appear on the product page.
pattern - String + + Use the custom_attributes field instead. +
performance_fabric - Int + + Use the custom_attributes field instead. +
price - ProductPrices + Indicates the price of an item. Use price_range for product price information. +
price_range - PriceRange! + The range of prices for the product
price_tiers - [TierPrice] + An array of TierPrice objects.
product_links - [ProductLinksInterface] + An array of ProductLinks objects.
purpose - Int + + Use the custom_attributes field instead. +
quantity - Float + Amount of available stock
rating_summary - Float! + The average of all the ratings given to the product.
related_products - [ProductInterface] + An array of related products.
review_count - Int! + The total count of all the reviews given to the product.
reviews - ProductReviews! + The list of products reviews.
+
+
Arguments
+
+
+
pageSize - Int +
+

The maximum number of results to return at once. The default is 20.

+
+
+
currentPage - Int +
+

The page of results to return. The default is 1.

+
+
+
+
sale - Int + + Use the custom_attributes field instead. +
short_description - ComplexTextValue + A short description of the product. Its use depends on the theme.
size - Int + + Use the custom_attributes field instead. +
sku - String + A number or code assigned to a product to identify the product, options, price, and manufacturer.
sleeve - String + + Use the custom_attributes field instead. +
small_image - ProductImage + The relative path to the small image, which is used on catalog pages.
special_from_date - String + The beginning date that a product has a special price. The field should not be used on the storefront. +
special_price - Float + The discounted price of the product.
special_to_date - String + The end date for a product with a special price.
staged - Boolean! + Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus + Stock status of the product
strap_bags - String + + Use the custom_attributes field instead. +
style_bags - String + + Use the custom_attributes field instead. +
style_bottom - String + + Use the custom_attributes field instead. +
style_general - String + + Use the custom_attributes field instead. +
swatch_image - String + The file name of a swatch image.
thumbnail - ProductImage + The relative path to the product's thumbnail image.
tier_price - Float + The price when tier pricing is in effect and the items purchased threshold has been reached. Use price_tiers for product tier price information. +
tier_prices - [ProductTierPrices] + An array of ProductTierPrices objects. Use price_tiers for product tier price information. +
type_id - String + One of simple, virtual, bundle, downloadable, grouped, or configurable. Use __typename instead. +
uid - ID! + The unique ID for a ProductInterface object.
updated_at - String + Timestamp indicating when the product was updated. The field should not be used on the storefront. +
upsell_products - [ProductInterface] + An array of up-sell products.
url_key - String + The part of the URL that identifies the product
url_path - String + + Use product's canonical_url or url rewrites instead +
url_rewrites - [UrlRewrite] + URL rewrites list
url_suffix - String + The part of the product URL that is appended after the url key
websites - [Website] + An array of websites in which the product is available. The field should not be used on the storefront. +
+
+
+
Possible Types
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ProductInterface Types
+

VirtualProduct

+
+

SimpleProduct

+
+

ConfigurableProduct

+
+

DownloadableProduct

+
+

BundleProduct

+
+

GiftCardProduct

+
+

GroupedProduct

+
+
+
+
+
+
Example
+ 
{
+  "activity": "xyz789",
+  "attribute_set_id": 123,
+  "canonical_url": "abc123",
+  "categories": [CategoryInterface],
+  "category_gear": "abc123",
+  "climate": "abc123",
+  "collar": "xyz789",
+  "color": 987,
+  "country_of_manufacture": "abc123",
+  "created_at": "abc123",
+  "crosssell_products": [ProductInterface],
+  "custom_attributesV2": ProductCustomAttributes,
+  "description": ComplexTextValue,
+  "eco_collection": 987,
+  "erin_recommends": 123,
+  "features_bags": "xyz789",
+  "format": 987,
+  "gender": "abc123",
+  "gift_message_available": true,
+  "gift_wrapping_available": false,
+  "gift_wrapping_price": Money,
+  "id": 123,
+  "image": ProductImage,
+  "is_returnable": "abc123",
+  "manufacturer": 123,
+  "material": "xyz789",
+  "max_sale_qty": 987.65,
+  "media_gallery": [MediaGalleryInterface],
+  "media_gallery_entries": [MediaGalleryEntry],
+  "meta_description": "xyz789",
+  "meta_keyword": "xyz789",
+  "meta_title": "abc123",
+  "min_sale_qty": 987.65,
+  "name": "abc123",
+  "new": 987,
+  "new_from_date": "abc123",
+  "new_to_date": "abc123",
+  "only_x_left_in_stock": 987.65,
+  "options_container": "xyz789",
+  "pattern": "xyz789",
+  "performance_fabric": 987,
+  "price": ProductPrices,
+  "price_range": PriceRange,
+  "price_tiers": [TierPrice],
+  "product_links": [ProductLinksInterface],
+  "purpose": 123,
+  "quantity": 123.45,
+  "rating_summary": 987.65,
+  "related_products": [ProductInterface],
+  "review_count": 123,
+  "reviews": ProductReviews,
+  "sale": 987,
+  "short_description": ComplexTextValue,
+  "size": 123,
+  "sku": "xyz789",
+  "sleeve": "xyz789",
+  "small_image": ProductImage,
+  "special_from_date": "xyz789",
+  "special_price": 123.45,
+  "special_to_date": "abc123",
+  "staged": true,
+  "stock_status": "IN_STOCK",
+  "strap_bags": "abc123",
+  "style_bags": "abc123",
+  "style_bottom": "xyz789",
+  "style_general": "xyz789",
+  "swatch_image": "abc123",
+  "thumbnail": ProductImage,
+  "tier_price": 987.65,
+  "tier_prices": [ProductTierPrices],
+  "type_id": "abc123",
+  "uid": "4",
+  "updated_at": "xyz789",
+  "upsell_products": [ProductInterface],
+  "url_key": "abc123",
+  "url_path": "abc123",
+  "url_rewrites": [UrlRewrite],
+  "url_suffix": "xyz789",
+  "websites": [Website]
+}
+
+
+
+
+
+ +
+
+ Types +
+

ProductLinksInterface

+
+
+
+
Description
+

Contains information about linked products, including the link type and product type of each item.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
link_type - String + One of related, associated, upsell, or crosssell.
linked_product_sku - String + The SKU of the linked product.
linked_product_type - String + The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable).
position - Int + The position within the list of product links.
sku - String + The identifier of the linked product.
+
+
+
Possible Types
+ + + + + + + + + + + +
ProductLinksInterface Types
+

ProductLinks

+
+
+
+
+
+
Example
+ 
{
+  "link_type": "xyz789",
+  "linked_product_sku": "xyz789",
+  "linked_product_type": "xyz789",
+  "position": 123,
+  "sku": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

ProductMediaGalleryEntriesContent

+
+
+
+
Description
+

Contains an image in base64 format and basic information about the image.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
base64_encoded_data - String + The image in base64 format.
name - String + The file name of the image.
type - String + The MIME type of the file, such as image/png.
+
+
+
+
+
Example
+ 
{
+  "base64_encoded_data": "xyz789",
+  "name": "abc123",
+  "type": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

ProductMediaGalleryEntriesVideoContent

+
+
+
+
Description
+

Contains a link to a video file and basic information about the video.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
media_type - String + Must be external-video.
video_description - String + A description of the video.
video_metadata - String + Optional data about the video.
video_provider - String + Describes the video source.
video_title - String + The title of the video.
video_url - String + The URL to the video.
+
+
+
+
+
Example
+ 
{
+  "media_type": "xyz789",
+  "video_description": "abc123",
+  "video_metadata": "abc123",
+  "video_provider": "abc123",
+  "video_title": "abc123",
+  "video_url": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

ProductPrice

+
+
+
+
Description
+

Represents a product price.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
discount - ProductDiscount + The price discount. Represents the difference between the regular and final price.
final_price - Money! + The final price of the product after applying discounts.
fixed_product_taxes - [FixedProductTax] + An array of the multiple Fixed Product Taxes that can be applied to a product price.
regular_price - Money! + The regular price of the product.
+
+
+
+
+
Example
+ 
{
+  "discount": ProductDiscount,
+  "final_price": Money,
+  "fixed_product_taxes": [FixedProductTax],
+  "regular_price": Money
+}
+
+
+
+
+
+
+
+ Types +
+

ProductPrices

+
+
+
+
Description
+

Deprecated. Use PriceRange instead. Contains the regular price of an item, as well as its minimum and maximum prices. Only composite products, which include bundle, configurable, and grouped products, can contain a minimum and maximum price.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
maximalPrice - Price + The highest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the to value. Use PriceRange.maximum_price instead. +
minimalPrice - Price + The lowest possible final price for all the options defined within a composite product. If you are specifying a price range, this would be the from value. Use PriceRange.minimum_price instead. +
regularPrice - Price + The base price of a product. Use regular_price from PriceRange.minimum_price or PriceRange.maximum_price instead. +
+
+
+
+
+
Example
+ 
{
+  "maximalPrice": Price,
+  "minimalPrice": Price,
+  "regularPrice": Price
+}
+
+
+
+
+
+
+
+ Types +
+

ProductReview

+
+
+
+
Description
+

Contains details of a product review.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
average_rating - Float! + The average of all ratings for this product.
created_at - String! + The date the review was created.
nickname - String! + The customer's nickname. Defaults to the customer name, if logged in.
product - ProductInterface! + The reviewed product.
ratings_breakdown - [ProductReviewRating]! + An array of ratings by rating category, such as quality, price, and value.
summary - String! + The summary (title) of the review.
text - String! + The review text.
+
+
+
+
+
Example
+ 
{
+  "average_rating": 123.45,
+  "created_at": "abc123",
+  "nickname": "xyz789",
+  "product": ProductInterface,
+  "ratings_breakdown": [ProductReviewRating],
+  "summary": "xyz789",
+  "text": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

ProductReviewRating

+
+
+
+
Description
+

Contains data about a single aspect of a product review.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
name - String! + The label assigned to an aspect of a product that is being rated, such as quality or price.
value - String! + The rating value given by customer. By default, possible values range from 1 to 5.
+
+
+
+
+
Example
+ 
{
+  "name": "xyz789",
+  "value": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

ProductReviewRatingInput

+
+
+
+
Description
+

Contains the reviewer's rating for a single aspect of a review.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ id - String! + An encoded rating ID.
+ value_id - String! + An encoded rating value ID.
+
+
+
+
+
Example
+ 
{
+  "id": "abc123",
+  "value_id": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

ProductReviewRatingMetadata

+
+
+
+
Description
+

Contains details about a single aspect of a product review.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
id - String! + An encoded rating ID.
name - String! + The label assigned to an aspect of a product that is being rated, such as quality or price.
values - [ProductReviewRatingValueMetadata]! + List of product review ratings sorted by position.
+
+
+
+
+
Example
+ 
{
+  "id": "xyz789",
+  "name": "abc123",
+  "values": [ProductReviewRatingValueMetadata]
+}
+
+
+
+
+
+
+
+ Types +
+

ProductReviewRatingValueMetadata

+
+
+
+
Description
+

Contains details about a single value in a product review.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
value - String! + A ratings scale, such as the number of stars awarded.
value_id - String! + An encoded rating value ID.
+
+
+
+
+
Example
+ 
{
+  "value": "xyz789",
+  "value_id": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

ProductReviewRatingsMetadata

+
+
+
+
Description
+

Contains an array of metadata about each aspect of a product review.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
items - [ProductReviewRatingMetadata]! + An array of product reviews sorted by position.
+
+
+
+
+
Example
+ 
{"items": [ProductReviewRatingMetadata]}
+
+
+
+
+
+
+
+ Types +
+

ProductReviews

+
+
+
+
Description
+

Contains an array of product reviews.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
items - [ProductReview]! + An array of product reviews.
page_info - SearchResultPageInfo! + Metadata for pagination rendering.
+
+
+
+
+
Example
+ 
{
+  "items": [ProductReview],
+  "page_info": SearchResultPageInfo
+}
+
+
+
+
+
+
+
+ Types +
+

ProductStockStatus

+
+
+
+
Description
+

This enumeration states whether a product stock status is in stock or out of stock

+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

IN_STOCK

+ 		+
+

OUT_OF_STOCK

+ 		+
+
+
+
+
+
Example
+ 
"IN_STOCK"
+
+
+
+
+
+
+
+ Types +
+

ProductTierPrices

+
+
+
+
Description
+

Deprecated. Use TierPrice instead. Defines a tier price, which is a quantity discount offered to a specific customer group.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
customer_group_id - String + The ID of the customer group. Not relevant for the storefront. +
percentage_value - Float + The percentage discount of the item. Use TierPrice.discount instead. +
qty - Float + The number of items that must be purchased to qualify for tier pricing. Use TierPrice.quantity instead. +
value - Float + The price of the fixed price item. Use TierPrice.final_price instead. +
website_id - Float + The ID assigned to the website. Not relevant for the storefront. +
+
+
+
+
+
Example
+ 
{
+  "customer_group_id": "abc123",
+  "percentage_value": 987.65,
+  "qty": 123.45,
+  "value": 123.45,
+  "website_id": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

ProductVideo

+
+
+
+
Description
+

Contains information about a product video.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
disabled - Boolean + Indicates whether the image is hidden from view.
label - String + The label of the product image or video.
position - Int + The media item's position after it has been sorted.
types - [String] + Array of image types. It can have the following values: image, small_image, thumbnail.
url - String + The URL of the product image or video.
video_content - ProductMediaGalleryEntriesVideoContent + Contains a ProductMediaGalleryEntriesVideoContent object.
+
+
+
+
+
Example
+ 
{
+  "disabled": true,
+  "label": "abc123",
+  "position": 987,
+  "types": ["xyz789"],
+  "url": "abc123",
+  "video_content": ProductMediaGalleryEntriesVideoContent
+}
+
+
+
+
+
+
+
+ Types +
+

Products

+
+
+
+
Description
+

Contains the results of a products query.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
aggregations - [Aggregation] + A bucket that contains the attribute code and label for each filterable option.
+
+
Arguments
+
+
+
filter - AggregationsFilterInput +
+
+
+
+
filters - [LayerFilter] + Layered navigation filters array. Use aggregations instead. +
items - [ProductInterface] + An array of products that match the specified search criteria.
page_info - SearchResultPageInfo + An object that includes the page_info and currentPage values specified in the query.
sort_fields - SortFields + An object that includes the default sort field and all available sort fields.
suggestions - [SearchSuggestion] + An array of search suggestions for case when search query have no results.
total_count - Int + The number of products that are marked as visible. By default, in complex products, parent products are visible, but their child products are not.
+
+
+
+
+
Example
+ 
{
+  "aggregations": [Aggregation],
+  "filters": [LayerFilter],
+  "items": [ProductInterface],
+  "page_info": SearchResultPageInfo,
+  "sort_fields": SortFields,
+  "suggestions": [SearchSuggestion],
+  "total_count": 123
+}
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrder

+
+
+
+
Description
+

Contains details about a purchase order.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
approval_flow - [PurchaseOrderRuleApprovalFlow]! + The approval flows for each applied rules.
available_actions - [PurchaseOrderAction]! + Purchase order actions available to the customer. Can be used to display action buttons on the client.
comments - [PurchaseOrderComment]! + The set of comments applied to the purchase order.
created_at - String! + The date the purchase order was created.
created_by - Customer + The company user who created the purchase order.
history_log - [PurchaseOrderHistoryItem]! + The log of the events related to the purchase order.
number - String! + The purchase order number.
order - CustomerOrder + The reference to the order placed based on the purchase order.
quote - Cart + The quote related to the purchase order.
status - PurchaseOrderStatus! + The current status of the purchase order.
uid - ID! + A unique identifier for the purchase order.
updated_at - String! + The date the purchase order was last updated.
+
+
+
+
+
Example
+ 
{
+  "approval_flow": [PurchaseOrderRuleApprovalFlow],
+  "available_actions": ["REJECT"],
+  "comments": [PurchaseOrderComment],
+  "created_at": "xyz789",
+  "created_by": Customer,
+  "history_log": [PurchaseOrderHistoryItem],
+  "number": "abc123",
+  "order": CustomerOrder,
+  "quote": Cart,
+  "status": "PENDING",
+  "uid": "4",
+  "updated_at": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrderAction

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

REJECT

+ 		+
+

CANCEL

+ 		+
+

VALIDATE

+ 		+
+

APPROVE

+ 		+
+

PLACE_ORDER

+ 		+
+
+
+
+
+
Example
+ 
"REJECT"
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrderActionError

+
+
+
+
Description
+

Contains details about a failed action.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
message - String! + The returned error message.
type - PurchaseOrderErrorType! + The error type.
+
+
+
+
+
Example
+ 
{"message": "abc123", "type": "NOT_FOUND"}
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrderApprovalFlowEvent

+
+
+
+
Description
+

Contains details about a single event in the approval flow of the purchase order.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
message - String + A formatted message.
name - String + The approver name.
role - String + The approver role.
status - PurchaseOrderApprovalFlowItemStatus + The status related to the event.
updated_at - String + The date and time the event was updated.
+
+
+
+
+
Example
+ 
{
+  "message": "abc123",
+  "name": "abc123",
+  "role": "xyz789",
+  "status": "PENDING",
+  "updated_at": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrderApprovalFlowItemStatus

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

PENDING

+ 		+
+

APPROVED

+ 		+
+

REJECTED

+ 		+
+
+
+
+
+
Example
+ 
"PENDING"
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrderApprovalRule

+
+
+
+
Description
+

Contains details about a purchase order approval rule.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
applies_to_roles - [CompanyRole]! + The name of the user(s) affected by the the purchase order approval rule.
approver_roles - [CompanyRole]! + The name of the user who needs to approve purchase orders that trigger the approval rule.
condition - PurchaseOrderApprovalRuleConditionInterface + Condition which triggers the approval rule.
created_at - String! + The date the purchase order rule was created.
created_by - String! + The name of the user who created the purchase order approval rule.
description - String + Description of the purchase order approval rule.
name - String! + The name of the purchase order approval rule.
status - PurchaseOrderApprovalRuleStatus! + The status of the purchase order approval rule.
uid - ID! + The unique identifier for the purchase order approval rule.
updated_at - String! + The date the purchase order rule was last updated.
+
+
+
+
+
Example
+ 
{
+  "applies_to_roles": [CompanyRole],
+  "approver_roles": [CompanyRole],
+  "condition": PurchaseOrderApprovalRuleConditionInterface,
+  "created_at": "xyz789",
+  "created_by": "xyz789",
+  "description": "xyz789",
+  "name": "abc123",
+  "status": "ENABLED",
+  "uid": "4",
+  "updated_at": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrderApprovalRuleConditionAmount

+
+
+
+
Description
+

Contains approval rule condition details, including the amount to be evaluated.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
amount - Money! + The amount to be be used for evaluation of the approval rule condition.
attribute - PurchaseOrderApprovalRuleType + The type of purchase order approval rule.
operator - PurchaseOrderApprovalRuleConditionOperator + The operator to be used for evaluating the approval rule condition.
+
+
+
+
+
Example
+ 
{
+  "amount": Money,
+  "attribute": "GRAND_TOTAL",
+  "operator": "MORE_THAN"
+}
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrderApprovalRuleConditionInterface

+
+
+
+
Description
+

Purchase order rule condition details.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
attribute - PurchaseOrderApprovalRuleType + The type of purchase order approval rule.
operator - PurchaseOrderApprovalRuleConditionOperator + The operator to be used for evaluating the approval rule condition.
+
+
+
Possible Types
+ + + + + + + + + + + + + + +
PurchaseOrderApprovalRuleConditionInterface Types
+

PurchaseOrderApprovalRuleConditionAmount

+
+

PurchaseOrderApprovalRuleConditionQuantity

+
+
+
+
+
+
Example
+ 
{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"}
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrderApprovalRuleConditionOperator

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

MORE_THAN

+ 		+
+

LESS_THAN

+ 		+
+

MORE_THAN_OR_EQUAL_TO

+ 		+
+

LESS_THAN_OR_EQUAL_TO

+ 		+
+
+
+
+
+
Example
+ 
"MORE_THAN"
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrderApprovalRuleConditionQuantity

+
+
+
+
Description
+

Contains approval rule condition details, including the quantity to be evaluated.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
attribute - PurchaseOrderApprovalRuleType + The type of purchase order approval rule.
operator - PurchaseOrderApprovalRuleConditionOperator + The operator to be used for evaluating the approval rule condition.
quantity - Int + The quantity to be used for evaluation of the approval rule condition.
+
+
+
+
+
Example
+ 
{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123}
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrderApprovalRuleInput

+
+
+
+
Description
+

Defines a new purchase order approval rule.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ applies_to - [ID]! + A list of company user role IDs to which this purchase order approval rule should be applied. When an empty array is provided, the rule is applied to all user roles in the system, including those created in the future.
+ approvers - [ID]! + A list of B2B user roles that can approve this purchase order approval rule.
+ condition - CreatePurchaseOrderApprovalRuleConditionInput! + The condition of the purchase order approval rule.
+ description - String + A summary of the purpose of the purchase order approval rule.
+ name - String! + The purchase order approval rule name.
+ status - PurchaseOrderApprovalRuleStatus! + The status of the purchase order approval rule.
+
+
+
+
+
Example
+ 
{
+  "applies_to": ["4"],
+  "approvers": ["4"],
+  "condition": CreatePurchaseOrderApprovalRuleConditionInput,
+  "description": "xyz789",
+  "name": "abc123",
+  "status": "ENABLED"
+}
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrderApprovalRuleMetadata

+
+
+
+
Description
+

Contains metadata that can be used to render rule edit forms.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
available_applies_to - [CompanyRole]! + A list of B2B user roles that the rule can be applied to.
available_condition_currencies - [AvailableCurrency]! + A list of currencies that can be used to create approval rules based on amounts, for example shipping cost rules.
available_requires_approval_from - [CompanyRole]! + A list of B2B user roles that can be specified as approvers for the approval rules.
+
+
+
+
+
Example
+ 
{
+  "available_applies_to": [CompanyRole],
+  "available_condition_currencies": [AvailableCurrency],
+  "available_requires_approval_from": [CompanyRole]
+}
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrderApprovalRuleStatus

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

ENABLED

+ 		+
+

DISABLED

+ 		+
+
+
+
+
+
Example
+ 
"ENABLED"
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrderApprovalRuleType

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

GRAND_TOTAL

+ 		+
+

SHIPPING_INCL_TAX

+ 		+
+

NUMBER_OF_SKUS

+ 		+
+
+
+
+
+
Example
+ 
"GRAND_TOTAL"
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrderApprovalRules

+
+
+
+
Description
+

Contains the approval rules that the customer can see.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items - [PurchaseOrderApprovalRule]! + A list of purchase order approval rules visible to the customer.
page_info - SearchResultPageInfo + Result pagination details.
total_count - Int + The total number of purchase order approval rules visible to the customer.
+
+
+
+
+
Example
+ 
{
+  "items": [PurchaseOrderApprovalRule],
+  "page_info": SearchResultPageInfo,
+  "total_count": 123
+}
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrderComment

+
+
+
+
Description
+

Contains details about a comment.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
author - Customer + The user who left the comment.
created_at - String! + The date and time when the comment was created.
text - String! + The text of the comment.
uid - ID! + A unique identifier of the comment.
+
+
+
+
+
Example
+ 
{
+  "author": Customer,
+  "created_at": "abc123",
+  "text": "abc123",
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrderErrorType

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

NOT_FOUND

+ 		+
+

OPERATION_NOT_APPLICABLE

+ 		+
+

COULD_NOT_SAVE

+ 		+
+

NOT_VALID_DATA

+ 		+
+

UNDEFINED

+ 		+
+
+
+
+
+
Example
+ 
"NOT_FOUND"
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrderHistoryItem

+
+
+
+
Description
+

Contains details about a status change.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
activity - String! + The activity type of the event.
created_at - String! + The date and time when the event happened.
message - String! + The message representation of the event.
uid - ID! + A unique identifier of the purchase order history item.
+
+
+
+
+
Example
+ 
{
+  "activity": "xyz789",
+  "created_at": "abc123",
+  "message": "xyz789",
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrderRuleApprovalFlow

+
+
+
+
Description
+

Contains details about approval roles applied to the purchase order and status changes.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
events - [PurchaseOrderApprovalFlowEvent]! + The approval flow event related to the rule.
rule_name - String! + The name of the applied rule.
+
+
+
+
+
Example
+ 
{
+  "events": [PurchaseOrderApprovalFlowEvent],
+  "rule_name": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrderStatus

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

PENDING

+ 		+
+

APPROVAL_REQUIRED

+ 		+
+

APPROVED

+ 		+
+

ORDER_IN_PROGRESS

+ 		+
+

ORDER_PLACED

+ 		+
+

ORDER_FAILED

+ 		+
+

REJECTED

+ 		+
+

CANCELED

+ 		+
+

APPROVED_PENDING_PAYMENT

+ 		+
+
+
+
+
+
Example
+ 
"PENDING"
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrders

+
+
+
+
Description
+

Contains a list of purchase orders.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items - [PurchaseOrder]! + Purchase orders matching the search criteria.
page_info - SearchResultPageInfo + Page information of search result's current page.
total_count - Int + Total number of purchase orders found matching the search criteria.
+
+
+
+
+
Example
+ 
{
+  "items": [PurchaseOrder],
+  "page_info": SearchResultPageInfo,
+  "total_count": 123
+}
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrdersActionInput

+
+
+
+
Description
+

Defines which purchase orders to act on.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ purchase_order_uids - [ID]! + An array of purchase order UIDs.
+
+
+
+
+
Example
+ 
{"purchase_order_uids": [4]}
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrdersActionOutput

+
+
+
+
Description
+

Returns a list of updated purchase orders and any error messages.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
errors - [PurchaseOrderActionError]! + An array of error messages encountered while performing the operation.
purchase_orders - [PurchaseOrder]! + A list of purchase orders.
+
+
+
+
+
Example
+ 
{
+  "errors": [PurchaseOrderActionError],
+  "purchase_orders": [PurchaseOrder]
+}
+
+
+
+
+
+
+
+ Types +
+

PurchaseOrdersFilterInput

+
+
+
+
Description
+

Defines the criteria to use to filter the list of purchase orders.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ company_purchase_orders - Boolean + Include only purchase orders made by subordinate company users.
+ created_date - FilterRangeTypeInput + Filter by the creation date of the purchase order.
+ require_my_approval - Boolean + Include only purchase orders that are waiting for the customer’s approval.
+ status - PurchaseOrderStatus + Filter by the status of the purchase order.
+
+
+
+
+
Example
+ 
{
+  "company_purchase_orders": true,
+  "created_date": FilterRangeTypeInput,
+  "require_my_approval": false,
+  "status": "PENDING"
+}
+
+
+
+
+
+
+
+ Types +
+

QuoteItemsSortInput

+
+
+
+
Description
+

Specifies the field to use for sorting quote items

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ field - SortQuoteItemsEnum! + Specifies the quote items field to sort by
+ order - SortEnum! + Specifies the order of quote items' sorting
+
+
+
+
+
Example
+ 
{"field": "ITEM_ID", "order": "ASC"}
+
+
+
+
+
+
+
+ Types +
+

QuoteTemplateLineItemNoteInput

+
+
+
+
Description
+

Sets quote item note.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ item_id - ID! + The unique ID of a CartLineItem object.
+ note - String + The note text to be added.
+ templateId - ID! + The unique ID of a NegotiableQuoteTemplate object.
+
+
+
+
+
Example
+ 
{
+  "item_id": 4,
+  "note": "xyz789",
+  "templateId": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

QuoteTemplateNotificationMessage

+
+
+
+
Description
+

Contains a notification message for a negotiable quote template.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
message - String! + The notification message.
type - String! + The type of notification message.
+
+
+
+
+
Example
+ 
{
+  "message": "abc123",
+  "type": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

ReCaptchaConfigOutput

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
configurations - ReCaptchaConfiguration + Configuration details for reCaptcha type
is_enabled - Boolean! + Indicates whether reCaptcha type is enabled
+
+
+
+
+
Example
+ 
{
+  "configurations": ReCaptchaConfiguration,
+  "is_enabled": true
+}
+
+
+
+
+
+
+
+ Types +
+

ReCaptchaConfiguration

+
+
+
+
Description
+

Contains reCAPTCHA form configuration details.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
badge_position - String + The position of the invisible reCAPTCHA badge on each page.
language_code - String + A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging.
minimum_score - Float + The minimum score that identifies a user interaction as a potential risk.
re_captcha_type - ReCaptchaTypeEmum! + +
technical_failure_message - String! + The message that appears when reCaptcha fails.
theme - String! + Theme to be used to render reCaptcha.
validation_failure_message - String! + The message that appears to the user if validation fails.
website_key - String! + The website key generated when the Google reCAPTCHA account was registered.
+
+
+
+
+
Example
+ 
{
+  "badge_position": "xyz789",
+  "language_code": "abc123",
+  "minimum_score": 987.65,
+  "re_captcha_type": "INVISIBLE",
+  "technical_failure_message": "xyz789",
+  "theme": "xyz789",
+  "validation_failure_message": "xyz789",
+  "website_key": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

ReCaptchaConfigurationV3

+
+
+
+
Description
+

Contains reCAPTCHA V3-Invisible configuration details.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
badge_position - String! + The position of the invisible reCAPTCHA badge on each page.
failure_message - String! + The message that appears to the user if validation fails.
forms - [ReCaptchaFormEnum]! + A list of forms on the storefront that have been configured to use reCAPTCHA V3.
is_enabled - Boolean! + Return whether recaptcha is enabled or not
language_code - String + A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging.
minimum_score - Float! + The minimum score that identifies a user interaction as a potential risk.
theme - String! + Theme to be used to render reCaptcha.
website_key - String! + The website key generated when the Google reCAPTCHA account was registered.
+
+
+
+
+
Example
+ 
{
+  "badge_position": "xyz789",
+  "failure_message": "xyz789",
+  "forms": ["PLACE_ORDER"],
+  "is_enabled": true,
+  "language_code": "xyz789",
+  "minimum_score": 987.65,
+  "theme": "abc123",
+  "website_key": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

ReCaptchaFormEnum

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

PLACE_ORDER

+ 		+
+

CONTACT

+ 		+
+

CUSTOMER_LOGIN

+ 		+
+

CUSTOMER_FORGOT_PASSWORD

+ 		+
+

CUSTOMER_CREATE

+ 		+
+

CUSTOMER_EDIT

+ 		+
+

NEWSLETTER

+ 		+
+

PRODUCT_REVIEW

+ 		+
+

SENDFRIEND

+ 		+
+

BRAINTREE

+ 		+
+

RESEND_CONFIRMATION_EMAIL

+ 		+
+
+
+
+
+
Example
+ 
"PLACE_ORDER"
+
+
+
+
+
+
+
+ Types +
+

ReCaptchaTypeEmum

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

INVISIBLE

+ 		+
+

RECAPTCHA

+ 		+
+

RECAPTCHA_V3

+ 		+
+
+
+
+
+
Example
+ 
"INVISIBLE"
+
+
+
+
+
+
+
+ Types +
+

Region

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
code - String + The two-letter code for the region, such as TX for Texas.
id - Int + The unique ID for a Region object.
name - String + The name of the region, such as Texas.
+
+
+
+
+
Example
+ 
{
+  "code": "abc123",
+  "id": 123,
+  "name": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

RemoveCouponFromCartInput

+
+
+
+
Description
+

Specifies the cart from which to remove a coupon.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID of a Cart object.
+
+
+
+
+
Example
+ 
{"cart_id": "abc123"}
+
+
+
+
+
+
+
+ Types +
+

RemoveCouponFromCartOutput

+
+
+
+
Description
+

Contains details about the cart after removing a coupon.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart + The cart after removing a coupon.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

RemoveCouponsFromCartInput

+
+
+
+
Description
+

Remove coupons from the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID of a Cart object.
+ coupon_codes - [String]! + An array of coupon codes to be removed from the quote. If coupon_codes is empty all coupons will be removed from the quote.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "abc123",
+  "coupon_codes": ["xyz789"]
+}
+
+
+
+
+
+
+
+ Types +
+

RemoveGiftCardFromCartInput

+
+
+
+
Description
+

Defines the input required to run the removeGiftCardFromCart mutation.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID that identifies the customer's cart.
+ gift_card_code - String! + The gift card code to be removed to the cart.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "xyz789",
+  "gift_card_code": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

RemoveGiftCardFromCartOutput

+
+
+
+
Description
+

Defines the possible output for the removeGiftCardFromCart mutation.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The contents of the specified shopping cart.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

RemoveGiftRegistryItemsOutput

+
+
+
+
Description
+

Contains the results of a request to remove an item from a gift registry.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
gift_registry - GiftRegistry + The gift registry after removing items.
+
+
+
+
+
Example
+ 
{"gift_registry": GiftRegistry}
+
+
+
+
+
+
+
+ Types +
+

RemoveGiftRegistryOutput

+
+
+
+
Description
+

Contains the results of a request to delete a gift registry.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
success - Boolean! + Indicates whether the gift registry was successfully deleted.
+
+
+
+
+
Example
+ 
{"success": false}
+
+
+
+
+
+
+
+ Types +
+

RemoveGiftRegistryRegistrantsOutput

+
+
+
+
Description
+

Contains the results of a request to delete a registrant.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
gift_registry - GiftRegistry + The gift registry after deleting registrants.
+
+
+
+
+
Example
+ 
{"gift_registry": GiftRegistry}
+
+
+
+
+
+
+
+ Types +
+

RemoveItemFromCartInput

+
+
+
+
Description
+

Specifies which items to remove from the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID of a Cart object.
+ cart_item_id - Int + Deprecated. Use cart_item_uid instead.
+ cart_item_uid - ID + Required field. The unique ID for a CartItemInterface object.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "abc123",
+  "cart_item_id": 123,
+  "cart_item_uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

RemoveItemFromCartOutput

+
+
+
+
Description
+

Contains details about the cart after removing an item.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The cart after removing an item.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

RemoveNegotiableQuoteItemsInput

+
+
+
+
Description
+

Defines the items to remove from the specified negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ quote_item_uids - [ID]! + An array of IDs indicating which items to remove from the negotiable quote.
+ quote_uid - ID! + The unique ID of a NegotiableQuote object.
+
+
+
+
+
Example
+ 
{
+  "quote_item_uids": ["4"],
+  "quote_uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

RemoveNegotiableQuoteItemsOutput

+
+
+
+
Description
+

Contains the negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
quote - NegotiableQuote + The negotiable quote after removing items.
+
+
+
+
+
Example
+ 
{"quote": NegotiableQuote}
+
+
+
+
+
+
+
+ Types +
+

RemoveNegotiableQuoteTemplateItemsInput

+
+
+
+
Description
+

Defines the items to remove from the specified negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ item_uids - [ID]! + An array of IDs indicating which items to remove from the negotiable quote.
+ template_id - ID! + The unique ID of a NegotiableQuoteTemplate object.
+
+
+
+
+
Example
+ 
{
+  "item_uids": ["4"],
+  "template_id": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

RemoveProductsFromCompareListInput

+
+
+
+
Description
+

Defines which products to remove from a compare list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ products - [ID]! + An array of product IDs to remove from the compare list.
+ uid - ID! + The unique identifier of the compare list to modify.
+
+
+
+
+
Example
+ 
{"products": [4], "uid": 4}
+
+
+
+
+
+
+
+ Types +
+

RemoveProductsFromWishlistOutput

+
+
+
+
Description
+

Contains the customer's wish list and any errors encountered.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
user_errors - [WishListUserInputError]! + An array of errors encountered while deleting products from a wish list.
wishlist - Wishlist! + Contains the wish list with after items were successfully deleted.
+
+
+
+
+
Example
+ 
{
+  "user_errors": [WishListUserInputError],
+  "wishlist": Wishlist
+}
+
+
+
+
+
+
+
+ Types +
+

RemoveReturnTrackingInput

+
+
+
+
Description
+

Defines the tracking information to delete.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ return_shipping_tracking_uid - ID! + The unique ID for a ReturnShippingTracking object.
+
+
+
+
+
Example
+ 
{"return_shipping_tracking_uid": 4}
+
+
+
+
+
+
+
+ Types +
+

RemoveReturnTrackingOutput

+
+
+
+
Description
+

Contains the response after deleting tracking information.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
return - Return + Contains details about the modified return.
+
+
+
+
+
Example
+ 
{"return": Return}
+
+
+
+
+
+
+
+ Types +
+

RemoveRewardPointsFromCartOutput

+
+
+
+
Description
+

Contains the customer cart.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The customer cart after reward points are removed.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

RemoveStoreCreditFromCartInput

+
+
+
+
Description
+

Defines the input required to run the removeStoreCreditFromCart mutation.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID that identifies the customer's cart.
+
+
+
+
+
Example
+ 
{"cart_id": "xyz789"}
+
+
+
+
+
+
+
+ Types +
+

RemoveStoreCreditFromCartOutput

+
+
+
+
Description
+

Defines the possible output for the removeStoreCreditFromCart mutation.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The contents of the specified shopping cart.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

RenameNegotiableQuoteInput

+
+
+
+
Description
+

Sets new name for a negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ quote_comment - String + The reason for the quote name change specified by the buyer.
+ quote_name - String! + The new quote name the buyer specified to the negotiable quote request.
+ quote_uid - ID! + The cart ID of the buyer requesting a new negotiable quote.
+
+
+
+
+
Example
+ 
{
+  "quote_comment": "abc123",
+  "quote_name": "abc123",
+  "quote_uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

RenameNegotiableQuoteOutput

+
+
+
+
Description
+

Contains the updated negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
quote - NegotiableQuote + The negotiable quote after updating the name.
+
+
+
+
+
Example
+ 
{"quote": NegotiableQuote}
+
+
+
+
+
+
+
+ Types +
+

ReorderItemsOutput

+
+
+
+
Description
+

Contains the cart and any errors after adding products.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + Detailed information about the customer's cart.
userInputErrors - [CheckoutUserInputError]! + An array of reordering errors.
+
+
+
+
+
Example
+ 
{
+  "cart": Cart,
+  "userInputErrors": [CheckoutUserInputError]
+}
+
+
+
+
+
+
+
+ Types +
+

RequestGuestReturnInput

+
+
+
+
Description
+

Contains information needed to start a return request.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ comment_text - String + Text the buyer entered that describes the reason for the refund request.
+ contact_email - String + The email address the buyer enters to receive notifications about the status of the return.
+ items - [RequestReturnItemInput]! + An array of items to be returned.
+ token - String! + Order token.
+
+
+
+
+
Example
+ 
{
+  "comment_text": "xyz789",
+  "contact_email": "abc123",
+  "items": [RequestReturnItemInput],
+  "token": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

RequestNegotiableQuoteInput

+
+
+
+
Description
+

Defines properties of a negotiable quote request.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - ID! + The cart ID of the buyer requesting a new negotiable quote.
+ comment - NegotiableQuoteCommentInput! + Comments the buyer entered to describe the request.
+ is_draft - Boolean + Flag indicating if quote is draft or not.
+ quote_name - String! + The name the buyer assigned to the negotiable quote request.
+
+
+
+
+
Example
+ 
{
+  "cart_id": 4,
+  "comment": NegotiableQuoteCommentInput,
+  "is_draft": false,
+  "quote_name": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

RequestNegotiableQuoteOutput

+
+
+
+
Description
+

Contains the NegotiableQuote object generated when a buyer requests a negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
quote - NegotiableQuote + Details about the negotiable quote.
+
+
+
+
+
Example
+ 
{"quote": NegotiableQuote}
+
+
+
+
+
+
+
+ Types +
+

RequestNegotiableQuoteTemplateInput

+
+
+
+
Description
+

Defines properties of a negotiable quote template request.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - ID! + The cart ID of the quote to create the new negotiable quote template from.
+
+
+
+
+
Example
+ 
{"cart_id": 4}
+
+
+
+
+
+
+
+ Types +
+

RequestReturnInput

+
+
+
+
Description
+

Contains information needed to start a return request.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ comment_text - String + Text the buyer entered that describes the reason for the refund request.
+ contact_email - String + The email address the buyer enters to receive notifications about the status of the return.
+ items - [RequestReturnItemInput]! + An array of items to be returned.
+ order_uid - ID! + The unique ID for a Order object.
+
+
+
+
+
Example
+ 
{
+  "comment_text": "abc123",
+  "contact_email": "xyz789",
+  "items": [RequestReturnItemInput],
+  "order_uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

RequestReturnItemInput

+
+
+
+
Description
+

Contains details about an item to be returned.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ entered_custom_attributes - [EnteredCustomAttributeInput] + Details about a custom attribute that was entered.
+ order_item_uid - ID! + The unique ID for a OrderItemInterface object.
+ quantity_to_return - Float! + The quantity of the item to be returned.
+ selected_custom_attributes - [SelectedCustomAttributeInput] + An array of selected custom option IDs associated with the item to be returned. For example, the IDs for the selected color and size of a configurable product.
+
+
+
+
+
Example
+ 
{
+  "entered_custom_attributes": [
+    EnteredCustomAttributeInput
+  ],
+  "order_item_uid": 4,
+  "quantity_to_return": 123.45,
+  "selected_custom_attributes": [
+    SelectedCustomAttributeInput
+  ]
+}
+
+
+
+
+
+
+
+ Types +
+

RequestReturnOutput

+
+
+
+
Description
+

Contains the response to a return request.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + +
Field NameDescription
return - Return + Details about a single return request.
returns - Returns + An array of return requests.
+
+
Arguments
+
+
+
pageSize - Int +
+

Specifies the maximum number of results to return at once. The default is 20.

+
+
+
currentPage - Int +
+

Specifies which page of results to return. The default is 1.

+
+
+
+
+
+
+
+
+
Example
+ 
{
+  "return": Return,
+  "returns": Returns
+}
+
+
+
+
+
+
+
+ Types +
+

RequisitionList

+
+
+
+
Description
+

Defines the contents of a requisition list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
description - String + Optional text that describes the requisition list.
items - RequistionListItems + An array of products added to the requisition list.
+
+
Arguments
+
+
+
currentPage - Int +
+

The page of results to return. The default value is 1.

+
+
+
pageSize - Int +
+

The maximum number of results to return. The default value is 1.

+
+
+
+
items_count - Int! + The number of items in the list.
name - String! + The requisition list name.
uid - ID! + The unique requisition list ID.
updated_at - String + The time of the last modification of the requisition list.
+
+
+
+
+
Example
+ 
{
+  "description": "xyz789",
+  "items": RequistionListItems,
+  "items_count": 987,
+  "name": "xyz789",
+  "uid": 4,
+  "updated_at": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

RequisitionListFilterInput

+
+
+
+
Description
+

Defines requisition list filters.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ name - FilterMatchTypeInput + Filter by the display name of the requisition list.
+ uids - FilterEqualTypeInput + Filter requisition lists by one or more requisition list IDs.
+
+
+
+
+
Example
+ 
{
+  "name": FilterMatchTypeInput,
+  "uids": FilterEqualTypeInput
+}
+
+
+
+
+
+
+
+ Types +
+

RequisitionListItemInterface

+
+
+
+
Description
+

The interface for requisition list items.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
customizable_options - [SelectedCustomizableOption]! + Selected custom options for an item in the requisition list.
product - ProductInterface! + Details about a requisition list item.
quantity - Float! + The amount added.
uid - ID! + The unique ID for the requisition list item.
+
+
+
Possible Types
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
RequisitionListItemInterface Types
+

SimpleRequisitionListItem

+
+

VirtualRequisitionListItem

+
+

DownloadableRequisitionListItem

+
+

BundleRequisitionListItem

+
+

ConfigurableRequisitionListItem

+
+

GiftCardRequisitionListItem

+
+
+
+
+
+
Example
+ 
{
+  "customizable_options": [SelectedCustomizableOption],
+  "product": ProductInterface,
+  "quantity": 987.65,
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

RequisitionListItemsInput

+
+
+
+
Description
+

Defines the items to add.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ entered_options - [EnteredOptionInput] + Entered option IDs.
+ parent_sku - String + For configurable products, the SKU of the parent product.
+ quantity - Float + The quantity of the product to add.
+ selected_options - [String] + Selected option IDs.
+ sku - String! + The product SKU.
+
+
+
+
+
Example
+ 
{
+  "entered_options": [EnteredOptionInput],
+  "parent_sku": "xyz789",
+  "quantity": 987.65,
+  "selected_options": ["abc123"],
+  "sku": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

RequisitionLists

+
+
+
+
Description
+

Defines customer requisition lists.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items - [RequisitionList] + An array of requisition lists.
page_info - SearchResultPageInfo + Pagination metadata.
total_count - Int + The number of returned requisition lists.
+
+
+
+
+
Example
+ 
{
+  "items": [RequisitionList],
+  "page_info": SearchResultPageInfo,
+  "total_count": 987
+}
+
+
+
+
+
+
+
+ Types +
+

RequistionListItems

+
+
+
+
Description
+

Contains an array of items added to a requisition list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items - [RequisitionListItemInterface]! + An array of items in the requisition list.
page_info - SearchResultPageInfo + Pagination metadata.
total_pages - Int! + The number of pages returned.
+
+
+
+
+
Example
+ 
{
+  "items": [RequisitionListItemInterface],
+  "page_info": SearchResultPageInfo,
+  "total_pages": 123
+}
+
+
+
+
+
+
+
+ Types +
+

Return

+
+
+
+
Description
+

Contains details about a return.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
available_shipping_carriers - [ReturnShippingCarrier] + A list of shipping carriers available for returns.
comments - [ReturnComment] + A list of comments posted for the return request.
created_at - String! + The date the return was requested.
customer - ReturnCustomer! + Data from the customer who created the return request.
items - [ReturnItem] + A list of items being returned.
number - String! + A human-readable return number.
order - CustomerOrder + The order associated with the return.
shipping - ReturnShipping + Shipping information for the return.
status - ReturnStatus + The status of the return request.
uid - ID! + The unique ID for a Return object.
+
+
+
+
+
Example
+ 
{
+  "available_shipping_carriers": [ReturnShippingCarrier],
+  "comments": [ReturnComment],
+  "created_at": "abc123",
+  "customer": ReturnCustomer,
+  "items": [ReturnItem],
+  "number": "abc123",
+  "order": CustomerOrder,
+  "shipping": ReturnShipping,
+  "status": "PENDING",
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

ReturnComment

+
+
+
+
Description
+

Contains details about a return comment.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
author_name - String! + The name or author who posted the comment.
created_at - String! + The date and time the comment was posted.
text - String! + The contents of the comment.
uid - ID! + The unique ID for a ReturnComment object.
+
+
+
+
+
Example
+ 
{
+  "author_name": "abc123",
+  "created_at": "abc123",
+  "text": "xyz789",
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

ReturnCustomAttribute

+
+
+
+
Description
+

Contains details about a ReturnCustomerAttribute object.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
label - String! + A description of the attribute.
uid - ID! + The unique ID for a ReturnCustomAttribute object.
value - String! + A JSON-encoded value of the attribute.
+
+
+
+
+
Example
+ 
{
+  "label": "abc123",
+  "uid": 4,
+  "value": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

ReturnCustomer

+
+
+
+
Description
+

The customer information for the return.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
email - String! + The email address of the customer.
firstname - String + The first name of the customer.
lastname - String + The last name of the customer.
+
+
+
+
+
Example
+ 
{
+  "email": "abc123",
+  "firstname": "xyz789",
+  "lastname": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

ReturnItem

+
+
+
+
Description
+

Contains details about a product being returned.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
custom_attributes - [ReturnCustomAttribute] + Return item custom attributes that are visible on the storefront. Use custom_attributesV2 instead. +
custom_attributesV2 - [AttributeValueInterface] + Custom attributes that are visible on the storefront.
order_item - OrderItemInterface! + Provides access to the product being returned, including information about selected and entered options.
quantity - Float! + The quantity of the item the merchant authorized to be returned.
request_quantity - Float! + The quantity of the item requested to be returned.
status - ReturnItemStatus! + The return status of the item.
uid - ID! + The unique ID for a ReturnItem object.
+
+
+
+
+
Example
+ 
{
+  "custom_attributes": [ReturnCustomAttribute],
+  "custom_attributesV2": [AttributeValueInterface],
+  "order_item": OrderItemInterface,
+  "quantity": 123.45,
+  "request_quantity": 123.45,
+  "status": "PENDING",
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

ReturnItemAttributeMetadata

+
+
+
+
Description
+

Return Item attribute metadata.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
code - ID! + The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
default_value - String + Default attribute value.
entity_type - AttributeEntityTypeEnum! + The type of entity that defines the attribute.
frontend_class - String + The frontend class of the attribute.
frontend_input - AttributeFrontendInputEnum + The frontend input type of the attribute.
input_filter - InputFilterEnum + The template used for the input of the attribute (e.g., 'date').
is_required - Boolean! + Whether the attribute value is required.
is_unique - Boolean! + Whether the attribute value must be unique.
label - String + The label assigned to the attribute.
multiline_count - Int + The number of lines of the attribute value.
options - [CustomAttributeOptionInterface]! + Attribute options.
sort_order - Int + The position of the attribute in the form.
validate_rules - [ValidationRule] + The validation rules of the attribute value.
+
+
+
+
+
Example
+ 
{
+  "code": "4",
+  "default_value": "abc123",
+  "entity_type": "CATALOG_PRODUCT",
+  "frontend_class": "abc123",
+  "frontend_input": "BOOLEAN",
+  "input_filter": "NONE",
+  "is_required": false,
+  "is_unique": false,
+  "label": "abc123",
+  "multiline_count": 123,
+  "options": [CustomAttributeOptionInterface],
+  "sort_order": 123,
+  "validate_rules": [ValidationRule]
+}
+
+
+
+
+
+
+
+ Types +
+

ReturnItemStatus

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

PENDING

+ 		+
+

AUTHORIZED

+ 		+
+

RECEIVED

+ 		+
+

APPROVED

+ 		+
+

REJECTED

+ 		+
+

DENIED

+ 		+
+
+
+
+
+
Example
+ 
"PENDING"
+
+
+
+
+
+
+
+ Types +
+

ReturnShipping

+
+
+
+
Description
+

Contains details about the return shipping address.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + +
Field NameDescription
address - ReturnShippingAddress + The merchant-defined return shipping address.
tracking - [ReturnShippingTracking] + The unique ID for a ReturnShippingTracking object. If a single UID is specified, the array contains a single tracking record. Otherwise, array contains all tracking information.
+
+
Arguments
+
+
+
uid - ID +
+
+
+
+
+
+
+
+
+
Example
+ 
{
+  "address": ReturnShippingAddress,
+  "tracking": [ReturnShippingTracking]
+}
+
+
+
+
+
+
+
+ Types +
+

ReturnShippingAddress

+
+
+
+
Description
+

Contains details about the shipping address used for receiving returned items.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
city - String! + The city for product returns.
contact_name - String + The merchant's contact person.
country - Country! + An object that defines the country for product returns.
postcode - String! + The postal code for product returns.
region - Region! + An object that defines the state or province for product returns.
street - [String]! + The street address for product returns.
telephone - String + The telephone number for product returns.
+
+
+
+
+
Example
+ 
{
+  "city": "xyz789",
+  "contact_name": "abc123",
+  "country": Country,
+  "postcode": "abc123",
+  "region": Region,
+  "street": ["xyz789"],
+  "telephone": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

ReturnShippingCarrier

+
+
+
+
Description
+

Contains details about the carrier on a return.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
label - String! + A description of the shipping carrier.
uid - ID! + The unique ID for a ReturnShippingCarrier object assigned to the shipping carrier.
+
+
+
+
+
Example
+ 
{"label": "xyz789", "uid": 4}
+
+
+
+
+
+
+
+ Types +
+

ReturnShippingTracking

+
+
+
+
Description
+

Contains shipping and tracking details.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
carrier - ReturnShippingCarrier! + Contains details of a shipping carrier.
status - ReturnShippingTrackingStatus + Details about the status of a shipment.
tracking_number - String! + A tracking number assigned by the carrier.
uid - ID! + The unique ID for a ReturnShippingTracking object assigned to the tracking item.
+
+
+
+
+
Example
+ 
{
+  "carrier": ReturnShippingCarrier,
+  "status": ReturnShippingTrackingStatus,
+  "tracking_number": "abc123",
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

ReturnShippingTrackingStatus

+
+
+
+
Description
+

Contains the status of a shipment.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
text - String! + Text that describes the status.
type - ReturnShippingTrackingStatusType! + Indicates whether the status type is informational or an error.
+
+
+
+
+
Example
+ 
{"text": "xyz789", "type": "INFORMATION"}
+
+
+
+
+
+
+
+ Types +
+

ReturnShippingTrackingStatusType

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

INFORMATION

+ 		+
+

ERROR

+ 		+
+
+
+
+
+
Example
+ 
"INFORMATION"
+
+
+
+
+
+
+
+ Types +
+

ReturnStatus

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

PENDING

+ 		+
+

UNCONFIRMED

+ 		+
+

AUTHORIZED

+ 		+
+

PARTIALLY_AUTHORIZED

+ 		+
+

RECEIVED

+ 		+
+

PARTIALLY_RECEIVED

+ 		+
+

APPROVED

+ 		+
+

PARTIALLY_APPROVED

+ 		+
+

REJECTED

+ 		+
+

PARTIALLY_REJECTED

+ 		+
+

DENIED

+ 		+
+

PROCESSED_AND_CLOSED

+ 		+
+

CLOSED

+ 		+
+
+
+
+
+
Example
+ 
"PENDING"
+
+
+
+
+
+
+
+ Types +
+

Returns

+
+
+
+
Description
+

Contains a list of customer return requests.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items - [Return] + A list of return requests.
page_info - SearchResultPageInfo + Pagination metadata.
total_count - Int + The total number of return requests.
+
+
+
+
+
Example
+ 
{
+  "items": [Return],
+  "page_info": SearchResultPageInfo,
+  "total_count": 123
+}
+
+
+
+
+
+
+
+ Types +
+

RevokeCustomerTokenOutput

+
+
+
+
Description
+

Contains the result of a request to revoke a customer token.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
result - Boolean! + The result of a request to revoke a customer token.
+
+
+
+
+
Example
+ 
{"result": true}
+
+
+
+
+
+
+
+ Types +
+

RewardPoints

+
+
+
+
Description
+

Contains details about a customer's reward points.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
balance - RewardPointsAmount + The current balance of reward points.
balance_history - [RewardPointsBalanceHistoryItem] + The balance history of reward points. If the ability for customers to view the balance history has been disabled in the Admin, this field will be set to null.
exchange_rates - RewardPointsExchangeRates + The current exchange rates for reward points.
subscription_status - RewardPointsSubscriptionStatus + The subscription status of emails related to reward points.
+
+
+
+
+
Example
+ 
{
+  "balance": RewardPointsAmount,
+  "balance_history": [RewardPointsBalanceHistoryItem],
+  "exchange_rates": RewardPointsExchangeRates,
+  "subscription_status": RewardPointsSubscriptionStatus
+}
+
+
+
+
+
+
+
+ Types +
+

RewardPointsAmount

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
money - Money! + The reward points amount in store currency.
points - Float! + The reward points amount in points.
+
+
+
+
+
Example
+ 
{"money": Money, "points": 123.45}
+
+
+
+
+
+
+
+ Types +
+

RewardPointsBalanceHistoryItem

+
+
+
+
Description
+

Contain details about the reward points transaction.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
balance - RewardPointsAmount + The award points balance after the completion of the transaction.
change_reason - String! + The reason the balance changed.
date - String! + The date of the transaction.
points_change - Float! + The number of points added or deducted in the transaction.
+
+
+
+
+
Example
+ 
{
+  "balance": RewardPointsAmount,
+  "change_reason": "xyz789",
+  "date": "abc123",
+  "points_change": 987.65
+}
+
+
+
+
+
+
+
+ Types +
+

RewardPointsExchangeRates

+
+
+
+
Description
+

Lists the reward points exchange rates. The values depend on the customer group.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
earning - RewardPointsRate + How many points are earned for a given amount spent.
redemption - RewardPointsRate + How many points must be redeemed to get a given amount of currency discount at the checkout.
+
+
+
+
+
Example
+ 
{
+  "earning": RewardPointsRate,
+  "redemption": RewardPointsRate
+}
+
+
+
+
+
+
+
+ Types +
+

RewardPointsRate

+
+
+
+
Description
+

Contains details about customer's reward points rate.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
currency_amount - Float! + The money value for the exchange rate. For earnings, this is the amount spent to earn the specified points. For redemption, this is the amount of money the number of points represents.
points - Float! + The number of points for an exchange rate. For earnings, this is the number of points earned. For redemption, this is the number of points needed for redemption.
+
+
+
+
+
Example
+ 
{"currency_amount": 987.65, "points": 987.65}
+
+
+
+
+
+
+
+ Types +
+

RewardPointsSubscriptionStatus

+
+
+
+
Description
+

Indicates whether the customer subscribes to reward points emails.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
balance_updates - RewardPointsSubscriptionStatusesEnum! + Indicates whether the customer subscribes to 'Reward points balance updates' emails.
points_expiration_notifications - RewardPointsSubscriptionStatusesEnum! + Indicates whether the customer subscribes to 'Reward points expiration notifications' emails.
+
+
+
+
+
Example
+ 
{
+  "balance_updates": "SUBSCRIBED",
+  "points_expiration_notifications": "SUBSCRIBED"
+}
+
+
+
+
+
+
+
+ Types +
+

RewardPointsSubscriptionStatusesEnum

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

SUBSCRIBED

+ 		+
+

NOT_SUBSCRIBED

+ 		+
+
+
+
+
+
Example
+ 
"SUBSCRIBED"
+
+
+
+
+
+
+
+ Types +
+

RoutableInterface

+
+
+
+
Description
+

Routable entities serve as the model for a rendered page.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
redirect_code - Int! + Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
relative_url - String + The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
type - UrlRewriteEntityTypeEnum + One of PRODUCT, CATEGORY, or CMS_PAGE.
+
+
+
Possible Types
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
RoutableInterface Types
+

CmsPage

+
+

CategoryTree

+
+

VirtualProduct

+
+

SimpleProduct

+
+

RoutableUrl

+
+

ConfigurableProduct

+
+

DownloadableProduct

+
+

BundleProduct

+
+

GiftCardProduct

+
+

GroupedProduct

+
+
+
+
+
+
Example
+ 
{
+  "redirect_code": 123,
+  "relative_url": "abc123",
+  "type": "CMS_PAGE"
+}
+
+
+
+
+
+
+
+ Types +
+

RoutableUrl

+
+
+
+
Description
+

Default implementation of RoutableInterface. This type is returned when the URL is not linked to an entity.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
redirect_code - Int! + Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
relative_url - String + The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
type - UrlRewriteEntityTypeEnum + One of PRODUCT, CATEGORY, or CMS_PAGE.
+
+
+
+
+
Example
+ 
{
+  "redirect_code": 123,
+  "relative_url": "xyz789",
+  "type": "CMS_PAGE"
+}
+
+
+
+
+
+
+
+ Types +
+

SDKParams

+
+
+
+
Description
+

Defines the name and value of a SDK parameter

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
name - String + The name of the SDK parameter
value - String + The value of the SDK parameter
+
+
+
+
+
Example
+ 
{
+  "name": "abc123",
+  "value": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

SalesCommentItem

+
+
+
+
Description
+

Contains details about a comment.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
message - String! + The text of the message.
timestamp - String! + The timestamp of the comment.
+
+
+
+
+
Example
+ 
{
+  "message": "xyz789",
+  "timestamp": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

ScopeTypeEnum

+
+
+
+
Description
+

This enumeration defines the scope type for customer orders.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

GLOBAL

+ 		+
+

WEBSITE

+ 		+
+

STORE

+ 		+
+
+
+
+
+
Example
+ 
"GLOBAL"
+
+
+
+
+
+
+
+ Types +
+

SearchResultPageInfo

+
+
+
+
Description
+

Provides navigation for the query response.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
current_page - Int + The specific page to return.
page_size - Int + The maximum number of items to return per page of results.
total_pages - Int + The total number of pages in the response.
+
+
+
+
+
Example
+ 
{"current_page": 987, "page_size": 987, "total_pages": 987}
+
+
+
+
+
+
+
+ Types +
+

SearchSuggestion

+
+
+
+
Description
+

A string that contains search suggestion

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
search - String! + The search suggestion of existing product.
+
+
+
+
+
Example
+ 
{"search": "xyz789"}
+
+
+
+
+
+
+
+ Types +
+

SelectedBundleOption

+
+
+
+
Description
+

Contains details about a selected bundle option.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
id - Int! + + Use uid instead +
label - String! + The display name of the selected bundle product option.
type - String! + The type of selected bundle product option.
uid - ID! + The unique ID for a SelectedBundleOption object
values - [SelectedBundleOptionValue]! + An array of selected bundle option values.
+
+
+
+
+
Example
+ 
{
+  "id": 123,
+  "label": "xyz789",
+  "type": "abc123",
+  "uid": 4,
+  "values": [SelectedBundleOptionValue]
+}
+
+
+
+
+
+
+
+ Types +
+

SelectedBundleOptionValue

+
+
+
+
Description
+

Contains details about a value for a selected bundle option.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
id - Int! + Use uid instead
label - String! + The display name of the value for the selected bundle product option.
original_price - Money! + The original price of the value for the selected bundle product option.
price - Float! + The price of the value for the selected bundle product option. Use priceV2 instead. +
priceV2 - Money! + The price of the value for the selected bundle product option.
quantity - Float! + The quantity of the value for the selected bundle product option.
uid - ID! + The unique ID for a SelectedBundleOptionValue object
+
+
+
+
+
Example
+ 
{
+  "id": 123,
+  "label": "abc123",
+  "original_price": Money,
+  "price": 123.45,
+  "priceV2": Money,
+  "quantity": 987.65,
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

SelectedConfigurableOption

+
+
+
+
Description
+

Contains details about a selected configurable option.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
configurable_product_option_uid - ID! + The unique ID for a ConfigurableProductOptions object.
configurable_product_option_value_uid - ID! + The unique ID for a ConfigurableProductOptionsValues object.
id - Int! + + Use SelectedConfigurableOption.configurable_product_option_uid instead. +
option_label - String! + The display text for the option.
value_id - Int! + + Use SelectedConfigurableOption.configurable_product_option_value_uid instead. +
value_label - String! + The display name of the selected configurable option.
+
+
+
+
+
Example
+ 
{
+  "configurable_product_option_uid": 4,
+  "configurable_product_option_value_uid": "4",
+  "id": 123,
+  "option_label": "abc123",
+  "value_id": 987,
+  "value_label": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

SelectedCustomAttributeInput

+
+
+
+
Description
+

Contains details about an attribute the buyer selected.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ attribute_code - String! + A string that identifies the selected attribute.
+ value - String! + The unique ID for a selected custom attribute value.
+
+
+
+
+
Example
+ 
{
+  "attribute_code": "abc123",
+  "value": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

SelectedCustomizableOption

+
+
+
+
Description
+

Identifies a customized product that has been placed in a cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
customizable_option_uid - ID! + The unique ID for a specific CustomizableOptionInterface object, such as a CustomizableFieldOption, CustomizableFileOption, or CustomizableAreaOption object.
id - Int! + + Use SelectedCustomizableOption.customizable_option_uid instead. +
is_required - Boolean! + Indicates whether the customizable option is required.
label - String! + The display name of the selected customizable option.
sort_order - Int! + A value indicating the order to display this option.
type - String! + The type of CustomizableOptionInterface object.
values - [SelectedCustomizableOptionValue]! + An array of selectable values.
+
+
+
+
+
Example
+ 
{
+  "customizable_option_uid": 4,
+  "id": 987,
+  "is_required": true,
+  "label": "abc123",
+  "sort_order": 123,
+  "type": "abc123",
+  "values": [SelectedCustomizableOptionValue]
+}
+
+
+
+
+
+
+
+ Types +
+

SelectedCustomizableOptionValue

+
+
+
+
Description
+

Identifies the value of the selected customized option.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
customizable_option_value_uid - ID! + The unique ID for a value object that corresponds to the object represented by the customizable_option_uid attribute.
id - Int! + + Use SelectedCustomizableOptionValue.customizable_option_value_uid instead. +
label - String! + The display name of the selected value.
price - CartItemSelectedOptionValuePrice! + The price of the selected customizable value.
value - String! + The text identifying the selected value.
+
+
+
+
+
Example
+ 
{
+  "customizable_option_value_uid": 4,
+  "id": 987,
+  "label": "xyz789",
+  "price": CartItemSelectedOptionValuePrice,
+  "value": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

SelectedPaymentMethod

+
+
+
+
Description
+

Describes the payment method the shopper selected.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
code - String! + The payment method code.
purchase_order_number - String + The purchase order number.
title - String! + The payment method title.
+
+
+
+
+
Example
+ 
{
+  "code": "xyz789",
+  "purchase_order_number": "abc123",
+  "title": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

SelectedShippingMethod

+
+
+
+
Description
+

Contains details about the selected shipping method and carrier.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
amount - Money! + The cost of shipping using this shipping method.
base_amount - Money + + The field should not be used on the storefront. +
carrier_code - String! + A string that identifies a commercial carrier or an offline shipping method.
carrier_title - String! + The label for the carrier code.
method_code - String! + A shipping method code associated with a carrier.
method_title - String! + The label for the method code.
price_excl_tax - Money! + The cost of shipping using this shipping method, excluding tax.
price_incl_tax - Money! + The cost of shipping using this shipping method, including tax.
+
+
+
+
+
Example
+ 
{
+  "amount": Money,
+  "base_amount": Money,
+  "carrier_code": "abc123",
+  "carrier_title": "xyz789",
+  "method_code": "xyz789",
+  "method_title": "abc123",
+  "price_excl_tax": Money,
+  "price_incl_tax": Money
+}
+
+
+
+
+
+
+
+ Types +
+

SendEmailToFriendInput

+
+
+
+
Description
+

Defines the referenced product and the email sender and recipients.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ product_id - Int! + The ID of the product that the sender is referencing.
+ recipients - [SendEmailToFriendRecipientInput]! + An array containing information about each recipient.
+ sender - SendEmailToFriendSenderInput! + Information about the customer and the content of the message.
+
+
+
+
+
Example
+ 
{
+  "product_id": 987,
+  "recipients": [SendEmailToFriendRecipientInput],
+  "sender": SendEmailToFriendSenderInput
+}
+
+
+
+
+
+
+
+ Types +
+

SendEmailToFriendOutput

+
+
+
+
Description
+

Contains information about the sender and recipients.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
recipients - [SendEmailToFriendRecipient] + An array containing information about each recipient.
sender - SendEmailToFriendSender + Information about the customer and the content of the message.
+
+
+
+
+
Example
+ 
{
+  "recipients": [SendEmailToFriendRecipient],
+  "sender": SendEmailToFriendSender
+}
+
+
+
+
+
+
+
+ Types +
+

SendEmailToFriendRecipient

+
+
+
+
Description
+

An output object that contains information about the recipient.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
email - String! + The email address of the recipient.
name - String! + The name of the recipient.
+
+
+
+
+
Example
+ 
{
+  "email": "abc123",
+  "name": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

SendEmailToFriendRecipientInput

+
+
+
+
Description
+

Contains details about a recipient.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ email - String! + The email address of the recipient.
+ name - String! + The name of the recipient.
+
+
+
+
+
Example
+ 
{
+  "email": "xyz789",
+  "name": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

SendEmailToFriendSender

+
+
+
+
Description
+

An output object that contains information about the sender.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
email - String! + The email address of the sender.
message - String! + The text of the message to be sent.
name - String! + The name of the sender.
+
+
+
+
+
Example
+ 
{
+  "email": "abc123",
+  "message": "xyz789",
+  "name": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

SendEmailToFriendSenderInput

+
+
+
+
Description
+

Contains details about the sender.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ email - String! + The email address of the sender.
+ message - String! + The text of the message to be sent.
+ name - String! + The name of the sender.
+
+
+
+
+
Example
+ 
{
+  "email": "xyz789",
+  "message": "abc123",
+  "name": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

SendFriendConfiguration

+
+
+
+
Description
+

Contains details about the configuration of the Email to a Friend feature.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
enabled_for_customers - Boolean! + Indicates whether the Email to a Friend feature is enabled.
enabled_for_guests - Boolean! + Indicates whether the Email to a Friend feature is enabled for guests.
+
+
+
+
+
Example
+ 
{"enabled_for_customers": false, "enabled_for_guests": false}
+
+
+
+
+
+
+
+ Types +
+

SendNegotiableQuoteForReviewInput

+
+
+
+
Description
+

Specifies which negotiable quote to send for review.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ comment - NegotiableQuoteCommentInput + A comment for the seller to review.
+ quote_uid - ID! + The unique ID of a NegotiableQuote object.
+
+
+
+
+
Example
+ 
{
+  "comment": NegotiableQuoteCommentInput,
+  "quote_uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

SendNegotiableQuoteForReviewOutput

+
+
+
+
Description
+

Contains the negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
quote - NegotiableQuote + The negotiable quote after sending for seller review.
+
+
+
+
+
Example
+ 
{"quote": NegotiableQuote}
+
+
+
+
+
+
+
+ Types +
+

SetBillingAddressOnCartInput

+
+
+
+
Description
+

Sets the billing address.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ billing_address - BillingAddressInput! + The billing address.
+ cart_id - String! + The unique ID of a Cart object.
+
+
+
+
+
Example
+ 
{
+  "billing_address": BillingAddressInput,
+  "cart_id": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

SetBillingAddressOnCartOutput

+
+
+
+
Description
+

Contains details about the cart after setting the billing address.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The cart after setting the billing address.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

SetCartAsInactiveOutput

+
+
+
+
Description
+

Sets the cart as inactive

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
error - String + The error message returned after failing to set the cart as inactive
success - Boolean! + Indicates whether the cart was set as inactive
+
+
+
+
+
Example
+ 
{"error": "xyz789", "success": true}
+
+
+
+
+
+
+
+ Types +
+

SetGiftOptionsOnCartInput

+
+
+
+
Description
+

Defines the gift options applied to the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID that identifies the shopper's cart.
+ gift_message - GiftMessageInput + Gift message details for the cart.
+ gift_receipt_included - Boolean! + Whether customer requested gift receipt for the cart.
+ gift_wrapping_id - ID + The unique ID for a GiftWrapping object to be used for the cart.
+ printed_card_included - Boolean! + Whether customer requested printed card for the cart.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "abc123",
+  "gift_message": GiftMessageInput,
+  "gift_receipt_included": false,
+  "gift_wrapping_id": 4,
+  "printed_card_included": false
+}
+
+
+
+
+
+
+
+ Types +
+

SetGiftOptionsOnCartOutput

+
+
+
+
Description
+

Contains the cart after gift options have been applied.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The modified cart object.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

SetGuestEmailOnCartInput

+
+
+
+
Description
+

Defines the guest email and cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID of a Cart object.
+ email - String! + The email address of the guest.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "abc123",
+  "email": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

SetGuestEmailOnCartOutput

+
+
+
+
Description
+

Contains details about the cart after setting the email of a guest.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The cart after setting the guest email.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

SetLineItemNoteOutput

+
+
+
+
Description
+

Contains the updated negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
quote - NegotiableQuote + The negotiable quote after sending for seller review.
+
+
+
+
+
Example
+ 
{"quote": NegotiableQuote}
+
+
+
+
+
+
+
+ Types +
+

SetNegotiableQuoteBillingAddressInput

+
+
+
+
Description
+

Sets the billing address.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ billing_address - NegotiableQuoteBillingAddressInput! + The billing address to be added.
+ quote_uid - ID! + The unique ID of a NegotiableQuote object.
+
+
+
+
+
Example
+ 
{
+  "billing_address": NegotiableQuoteBillingAddressInput,
+  "quote_uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

SetNegotiableQuoteBillingAddressOutput

+
+
+
+
Description
+

Contains the negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
quote - NegotiableQuote + The negotiable quote after assigning a billing address.
+
+
+
+
+
Example
+ 
{"quote": NegotiableQuote}
+
+
+
+
+
+
+
+ Types +
+

SetNegotiableQuotePaymentMethodInput

+
+
+
+
Description
+

Defines the payment method of the specified negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ payment_method - NegotiableQuotePaymentMethodInput! + The payment method to be assigned to the negotiable quote.
+ quote_uid - ID! + The unique ID of a NegotiableQuote object.
+
+
+
+
+
Example
+ 
{
+  "payment_method": NegotiableQuotePaymentMethodInput,
+  "quote_uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

SetNegotiableQuotePaymentMethodOutput

+
+
+
+
Description
+

Contains details about the negotiable quote after setting the payment method.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
quote - NegotiableQuote + The updated negotiable quote.
+
+
+
+
+
Example
+ 
{"quote": NegotiableQuote}
+
+
+
+
+
+
+
+ Types +
+

SetNegotiableQuoteShippingAddressInput

+
+
+
+
Description
+

Defines the shipping address to assign to the negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ customer_address_id - ID + The unique ID of a CustomerAddress object.
+ quote_uid - ID! + The unique ID of a NegotiableQuote object.
+ shipping_addresses - [NegotiableQuoteShippingAddressInput] + An array of shipping addresses to apply to the negotiable quote.
+
+
+
+
+
Example
+ 
{
+  "customer_address_id": 4,
+  "quote_uid": "4",
+  "shipping_addresses": [
+    NegotiableQuoteShippingAddressInput
+  ]
+}
+
+
+
+
+
+
+
+ Types +
+

SetNegotiableQuoteShippingAddressOutput

+
+
+
+
Description
+

Contains the negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
quote - NegotiableQuote + The negotiable quote after assigning a shipping address.
+
+
+
+
+
Example
+ 
{"quote": NegotiableQuote}
+
+
+
+
+
+
+
+ Types +
+

SetNegotiableQuoteShippingMethodsInput

+
+
+
+
Description
+

Defines the shipping method to apply to the negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ quote_uid - ID! + The unique ID of a NegotiableQuote object.
+ shipping_methods - [ShippingMethodInput]! + An array of shipping methods to apply to the negotiable quote.
+
+
+
+
+
Example
+ 
{
+  "quote_uid": 4,
+  "shipping_methods": [ShippingMethodInput]
+}
+
+
+
+
+
+
+
+ Types +
+

SetNegotiableQuoteShippingMethodsOutput

+
+
+
+
Description
+

Contains the negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
quote - NegotiableQuote + The negotiable quote after applying shipping methods.
+
+
+
+
+
Example
+ 
{"quote": NegotiableQuote}
+
+
+
+
+
+
+
+ Types +
+

SetNegotiableQuoteTemplateShippingAddressInput

+
+
+
+
Description
+

Defines the shipping address to assign to the negotiable quote template.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ shipping_address - NegotiableQuoteTemplateShippingAddressInput! + A shipping adadress to apply to the negotiable quote template.
+ template_id - ID! + The unique ID of a NegotiableQuote object.
+
+
+
+
+
Example
+ 
{
+  "shipping_address": NegotiableQuoteTemplateShippingAddressInput,
+  "template_id": 4
+}
+
+
+
+
+
+
+
+ Types +
+

SetPaymentMethodAndPlaceOrderInput

+
+
+
+
Description
+

Applies a payment method to the quote.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID of a Cart object.
+ payment_method - PaymentMethodInput! + The payment method data to apply to the cart.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "abc123",
+  "payment_method": PaymentMethodInput
+}
+
+
+
+
+
+
+
+ Types +
+

SetPaymentMethodOnCartInput

+
+
+
+
Description
+

Applies a payment method to the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID of a Cart object.
+ payment_method - PaymentMethodInput! + The payment method data to apply to the cart.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "xyz789",
+  "payment_method": PaymentMethodInput
+}
+
+
+
+
+
+
+
+ Types +
+

SetPaymentMethodOnCartOutput

+
+
+
+
Description
+

Contains details about the cart after setting the payment method.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The cart after setting the payment method.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

SetShippingAddressesOnCartInput

+
+
+
+
Description
+

Specifies an array of addresses to use for shipping.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID of a Cart object.
+ shipping_addresses - [ShippingAddressInput]! + An array of shipping addresses.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "xyz789",
+  "shipping_addresses": [ShippingAddressInput]
+}
+
+
+
+
+
+
+
+ Types +
+

SetShippingAddressesOnCartOutput

+
+
+
+
Description
+

Contains details about the cart after setting the shipping addresses.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The cart after setting the shipping addresses.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

SetShippingMethodsOnCartInput

+
+
+
+
Description
+

Applies one or shipping methods to the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID of a Cart object.
+ shipping_methods - [ShippingMethodInput]! + An array of shipping methods.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "abc123",
+  "shipping_methods": [ShippingMethodInput]
+}
+
+
+
+
+
+
+
+ Types +
+

SetShippingMethodsOnCartOutput

+
+
+
+
Description
+

Contains details about the cart after setting the shipping methods.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The cart after setting the shipping methods.
+
+
+
+
+
Example
+ 
{"cart": Cart}
+
+
+
+
+
+
+
+ Types +
+

ShareGiftRegistryInviteeInput

+
+
+
+
Description
+

Defines a gift registry invitee.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ email - String! + The email address of the gift registry invitee.
+ name - String! + The name of the gift registry invitee.
+
+
+
+
+
Example
+ 
{
+  "email": "xyz789",
+  "name": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

ShareGiftRegistryOutput

+
+
+
+
Description
+

Contains the results of a request to share a gift registry.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
is_shared - Boolean! + Indicates whether the gift registry was successfully shared.
+
+
+
+
+
Example
+ 
{"is_shared": true}
+
+
+
+
+
+
+
+ Types +
+

ShareGiftRegistrySenderInput

+
+
+
+
Description
+

Defines the sender of an invitation to view a gift registry.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ message - String! + A brief message from the sender.
+ name - String! + The sender of the gift registry invitation.
+
+
+
+
+
Example
+ 
{
+  "message": "abc123",
+  "name": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

ShipBundleItemsEnum

+
+
+
+
Description
+

Defines whether bundle items must be shipped together.

+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

TOGETHER

+ 		+
+

SEPARATELY

+ 		+
+
+
+
+
+
Example
+ 
"TOGETHER"
+
+
+
+
+
+
+
+ Types +
+

ShipmentItem

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
id - ID! + The unique ID for a ShipmentItemInterface object.
order_item - OrderItemInterface + The order item associated with the shipment item.
product_name - String + The name of the base product.
product_sale_price - Money! + The sale price for the base product.
product_sku - String! + The SKU of the base product.
quantity_shipped - Float! + The number of shipped items.
+
+
+
+
+
Example
+ 
{
+  "id": 4,
+  "order_item": OrderItemInterface,
+  "product_name": "abc123",
+  "product_sale_price": Money,
+  "product_sku": "abc123",
+  "quantity_shipped": 987.65
+}
+
+
+
+
+
+
+
+ Types +
+

ShipmentItemInterface

+
+
+
+
Description
+

Order shipment item details.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
id - ID! + The unique ID for a ShipmentItemInterface object.
order_item - OrderItemInterface + The order item associated with the shipment item.
product_name - String + The name of the base product.
product_sale_price - Money! + The sale price for the base product.
product_sku - String! + The SKU of the base product.
quantity_shipped - Float! + The number of shipped items.
+
+
+
Possible Types
+ + + + + + + + + + + + + + + + + +
ShipmentItemInterface Types
+

BundleShipmentItem

+
+

GiftCardShipmentItem

+
+

ShipmentItem

+
+
+
+
+
+
Example
+ 
{
+  "id": "4",
+  "order_item": OrderItemInterface,
+  "product_name": "xyz789",
+  "product_sale_price": Money,
+  "product_sku": "abc123",
+  "quantity_shipped": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

ShipmentTracking

+
+
+
+
Description
+

Contains order shipment tracking details.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
carrier - String! + The shipping carrier for the order delivery.
number - String + The tracking number of the order shipment.
title - String! + The shipment tracking title.
+
+
+
+
+
Example
+ 
{
+  "carrier": "abc123",
+  "number": "abc123",
+  "title": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

ShippingAddressInput

+
+
+
+
Description
+

Defines a single shipping address.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ address - CartAddressInput + Defines a shipping address.
+ customer_address_id - Int + An ID from the customer's address book that uniquely identifies the address to be used for shipping.
+ customer_address_uid - ID + The unique ID from the customer's address book that uniquely identifies the address to be used for shipping.
+ customer_notes - String + Text provided by the shopper.
+ pickup_location_code - String + The code of Pickup Location which will be used for In-Store Pickup.
+
+
+
+
+
Example
+ 
{
+  "address": CartAddressInput,
+  "customer_address_id": 987,
+  "customer_address_uid": "4",
+  "customer_notes": "abc123",
+  "pickup_location_code": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

ShippingCartAddress

+
+
+
+
Description
+

Contains shipping addresses and methods.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
available_shipping_methods - [AvailableShippingMethod] + An array that lists the shipping methods that can be applied to the cart.
cart_items - [CartItemQuantity] + + Use cart_items_v2 instead. +
cart_items_v2 - [CartItemInterface] + An array that lists the items in the cart.
city - String! + The city specified for the billing or shipping address.
company - String + The company specified for the billing or shipping address.
country - CartAddressCountry! + An object containing the country label and code.
custom_attributes - [AttributeValueInterface]! + The custom attribute values of the billing or shipping address.
customer_address_uid - ID + The unique ID from the customer's address book that uniquely identifies the address.
customer_notes - String + Text provided by the shopper.
fax - String + The customer's fax number.
firstname - String! + The first name of the customer or guest.
id - Int + Id of the customer address. Use customer_address_uid instead. +
items_weight - Float + + This information should not be exposed on the frontend. +
lastname - String! + The last name of the customer or guest.
middlename - String + The middle name of the person associated with the billing/shipping address.
pickup_location_code - String + +
postcode - String + The ZIP or postal code of the billing or shipping address.
prefix - String + An honorific, such as Dr., Mr., or Mrs.
region - CartAddressRegion + An object containing the region label and code.
same_as_billing - Boolean! + Indicates whether the shipping address is same as billing address.
selected_shipping_method - SelectedShippingMethod + An object that describes the selected shipping method.
street - [String]! + An array containing the street for the billing or shipping address.
suffix - String + A value such as Sr., Jr., or III.
telephone - String + The telephone number for the billing or shipping address.
uid - ID! + The unique id of the customer cart address.
vat_id - String + The VAT company number for billing or shipping address.
+
+
+
+
+
Example
+ 
{
+  "available_shipping_methods": [AvailableShippingMethod],
+  "cart_items": [CartItemQuantity],
+  "cart_items_v2": [CartItemInterface],
+  "city": "xyz789",
+  "company": "abc123",
+  "country": CartAddressCountry,
+  "custom_attributes": [AttributeValueInterface],
+  "customer_address_uid": "4",
+  "customer_notes": "xyz789",
+  "fax": "xyz789",
+  "firstname": "xyz789",
+  "id": 987,
+  "items_weight": 123.45,
+  "lastname": "abc123",
+  "middlename": "abc123",
+  "pickup_location_code": "abc123",
+  "postcode": "xyz789",
+  "prefix": "xyz789",
+  "region": CartAddressRegion,
+  "same_as_billing": true,
+  "selected_shipping_method": SelectedShippingMethod,
+  "street": ["xyz789"],
+  "suffix": "abc123",
+  "telephone": "abc123",
+  "uid": 4,
+  "vat_id": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

ShippingDiscount

+
+
+
+
Description
+

Defines an individual shipping discount. This discount can be applied to shipping.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
amount - Money! + The amount of the discount.
+
+
+
+
+
Example
+ 
{"amount": Money}
+
+
+
+
+
+
+
+ Types +
+

ShippingHandling

+
+
+
+
Description
+

Contains details about shipping and handling costs.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
amount_excluding_tax - Money + The shipping amount, excluding tax.
amount_including_tax - Money + The shipping amount, including tax.
discounts - [ShippingDiscount] + The applied discounts to the shipping.
taxes - [TaxItem] + Details about taxes applied for shipping.
total_amount - Money! + The total amount for shipping.
+
+
+
+
+
Example
+ 
{
+  "amount_excluding_tax": Money,
+  "amount_including_tax": Money,
+  "discounts": [ShippingDiscount],
+  "taxes": [TaxItem],
+  "total_amount": Money
+}
+
+
+
+
+
+
+
+ Types +
+

ShippingMethodInput

+
+
+
+
Description
+

Defines the shipping carrier and method.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ carrier_code - String! + A string that identifies a commercial carrier or an offline delivery method.
+ method_code - String! + A string that indicates which service a commercial carrier will use to ship items. For offline delivery methods, this value is similar to the label displayed on the checkout page.
+
+
+
+
+
Example
+ 
{
+  "carrier_code": "abc123",
+  "method_code": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

SimpleCartItem

+
+
+
+
Description
+

An implementation for simple product cart items.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
available_gift_wrapping - [GiftWrapping]! + The list of available gift wrapping options for the cart item.
customizable_options - [SelectedCustomizableOption]! + An array containing the customizable options the shopper selected.
discount - [Discount] + Contains discount for quote line item.
errors - [CartItemError] + An array of errors encountered while loading the cart item
gift_message - GiftMessage + The entered gift message for the cart item
gift_wrapping - GiftWrapping + The selected gift wrapping for the cart item.
id - String! + + Use uid instead. +
is_available - Boolean! + True if requested quantity is less than available stock, false otherwise.
max_qty - Float + Line item max qty in quote template
min_qty - Float + Line item min qty in quote template
not_available_message - String + Message to display when the product is not available with this selected option.
note_from_buyer - [ItemNote] + The buyer's quote line item note.
note_from_seller - [ItemNote] + The seller's quote line item note.
prices - CartItemPrices + Contains details about the price of the item, including taxes and discounts.
product - ProductInterface! + Details about an item in the cart.
quantity - Float! + The quantity of this item in the cart.
uid - ID! + The unique ID for a CartItemInterface object.
+
+
+
+
+
Example
+ 
{
+  "available_gift_wrapping": [GiftWrapping],
+  "customizable_options": [SelectedCustomizableOption],
+  "discount": [Discount],
+  "errors": [CartItemError],
+  "gift_message": GiftMessage,
+  "gift_wrapping": GiftWrapping,
+  "id": "xyz789",
+  "is_available": true,
+  "max_qty": 987.65,
+  "min_qty": 987.65,
+  "not_available_message": "xyz789",
+  "note_from_buyer": [ItemNote],
+  "note_from_seller": [ItemNote],
+  "prices": CartItemPrices,
+  "product": ProductInterface,
+  "quantity": 987.65,
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

SimpleProduct

+
+
+
+
Description
+

Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
activity - String + + Use the custom_attributes field instead. +
attribute_set_id - Int + The attribute set assigned to the product. The field should not be used on the storefront. +
canonical_url - String + The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface] + The categories assigned to a product.
category_gear - String + + Use the custom_attributes field instead. +
climate - String + + Use the custom_attributes field instead. +
collar - String + + Use the custom_attributes field instead. +
color - Int + + Use the custom_attributes field instead. +
country_of_manufacture - String + The product's country of origin.
created_at - String + Timestamp indicating when the product was created. The field should not be used on the storefront. +
crosssell_products - [ProductInterface] + An array of cross-sell products.
custom_attributesV2 - ProductCustomAttributes + Product custom attributes.
+
+
Arguments
+
+
+
filters - AttributeFilterInput +
+
+
+
+
description - ComplexTextValue + Detailed information about the product. The value can include simple HTML tags.
eco_collection - Int + + Use the custom_attributes field instead. +
erin_recommends - Int + + Use the custom_attributes field instead. +
features_bags - String + + Use the custom_attributes field instead. +
format - Int + + Use the custom_attributes field instead. +
gender - String + + Use the custom_attributes field instead. +
gift_message_available - Boolean! + Returns a value indicating gift message availability for the product.
gift_wrapping_available - Boolean! + Returns a value indicating gift wrapping availability for the product.
gift_wrapping_price - Money + Returns value and currency indicating gift wrapping price for the product.
id - Int + The ID number assigned to the product. Use the uid field instead. +
image - ProductImage + The relative path to the main image on the product page.
is_returnable - String + Indicates whether the product can be returned.
manufacturer - Int + A number representing the product's manufacturer. Use the custom_attributes field instead. +
material - String + + Use the custom_attributes field instead. +
max_sale_qty - Float + Maximum Qty Allowed in Shopping Cart
media_gallery - [MediaGalleryInterface] + An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry] + An array of MediaGalleryEntry objects. Use media_gallery instead. +
meta_description - String + A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String + A comma-separated list of keywords that are visible only to search engines.
meta_title - String + A string that is displayed in the title bar and tab of the browser and in search results lists.
min_sale_qty - Float + Minimum Qty Allowed in Shopping Cart
name - String + The product name. Customers use this name to identify the product.
new - Int + + Use the custom_attributes field instead. +
new_from_date - String + The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String + The end date for new product listings.
only_x_left_in_stock - Float + Product stock only x left count
options - [CustomizableOptionInterface] + An array of options for a customizable product.
options_container - String + If the product has multiple options, determines where they appear on the product page.
pattern - String + + Use the custom_attributes field instead. +
performance_fabric - Int + + Use the custom_attributes field instead. +
price - ProductPrices + Indicates the price of an item. Use price_range for product price information. +
price_range - PriceRange! + The range of prices for the product
price_tiers - [TierPrice] + An array of TierPrice objects.
product_links - [ProductLinksInterface] + An array of ProductLinks objects.
purpose - Int + + Use the custom_attributes field instead. +
quantity - Float + Amount of available stock
rating_summary - Float! + The average of all the ratings given to the product.
redirect_code - Int! + Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface] + An array of related products.
relative_url - String + The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int! + The total count of all the reviews given to the product.
reviews - ProductReviews! + The list of products reviews.
+
+
Arguments
+
+
+
pageSize - Int +
+

The maximum number of results to return at once. The default is 20.

+
+
+
currentPage - Int +
+

The page of results to return. The default is 1.

+
+
+
+
sale - Int + + Use the custom_attributes field instead. +
short_description - ComplexTextValue + A short description of the product. Its use depends on the theme.
size - Int + + Use the custom_attributes field instead. +
sku - String + A number or code assigned to a product to identify the product, options, price, and manufacturer.
sleeve - String + + Use the custom_attributes field instead. +
small_image - ProductImage + The relative path to the small image, which is used on catalog pages.
special_from_date - String + The beginning date that a product has a special price. The field should not be used on the storefront. +
special_price - Float + The discounted price of the product.
special_to_date - String + The end date for a product with a special price.
staged - Boolean! + Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus + Stock status of the product
strap_bags - String + + Use the custom_attributes field instead. +
style_bags - String + + Use the custom_attributes field instead. +
style_bottom - String + + Use the custom_attributes field instead. +
style_general - String + + Use the custom_attributes field instead. +
swatch_image - String + The file name of a swatch image.
thumbnail - ProductImage + The relative path to the product's thumbnail image.
tier_price - Float + The price when tier pricing is in effect and the items purchased threshold has been reached. Use price_tiers for product tier price information. +
tier_prices - [ProductTierPrices] + An array of ProductTierPrices objects. Use price_tiers for product tier price information. +
type - UrlRewriteEntityTypeEnum + One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String + One of simple, virtual, bundle, downloadable, grouped, or configurable. Use __typename instead. +
uid - ID! + The unique ID for a ProductInterface object.
updated_at - String + Timestamp indicating when the product was updated. The field should not be used on the storefront. +
upsell_products - [ProductInterface] + An array of up-sell products.
url_key - String + The part of the URL that identifies the product
url_path - String + + Use product's canonical_url or url rewrites instead +
url_rewrites - [UrlRewrite] + URL rewrites list
url_suffix - String + The part of the product URL that is appended after the url key
websites - [Website] + An array of websites in which the product is available. The field should not be used on the storefront. +
weight - Float + The weight of the item, in units defined by the store.
+
+
+
+
+
Example
+ 
{
+  "activity": "abc123",
+  "attribute_set_id": 123,
+  "canonical_url": "abc123",
+  "categories": [CategoryInterface],
+  "category_gear": "abc123",
+  "climate": "abc123",
+  "collar": "xyz789",
+  "color": 987,
+  "country_of_manufacture": "xyz789",
+  "created_at": "xyz789",
+  "crosssell_products": [ProductInterface],
+  "custom_attributesV2": ProductCustomAttributes,
+  "description": ComplexTextValue,
+  "eco_collection": 123,
+  "erin_recommends": 987,
+  "features_bags": "xyz789",
+  "format": 123,
+  "gender": "abc123",
+  "gift_message_available": false,
+  "gift_wrapping_available": true,
+  "gift_wrapping_price": Money,
+  "id": 123,
+  "image": ProductImage,
+  "is_returnable": "xyz789",
+  "manufacturer": 987,
+  "material": "xyz789",
+  "max_sale_qty": 123.45,
+  "media_gallery": [MediaGalleryInterface],
+  "media_gallery_entries": [MediaGalleryEntry],
+  "meta_description": "abc123",
+  "meta_keyword": "abc123",
+  "meta_title": "xyz789",
+  "min_sale_qty": 123.45,
+  "name": "xyz789",
+  "new": 123,
+  "new_from_date": "abc123",
+  "new_to_date": "xyz789",
+  "only_x_left_in_stock": 987.65,
+  "options": [CustomizableOptionInterface],
+  "options_container": "xyz789",
+  "pattern": "xyz789",
+  "performance_fabric": 123,
+  "price": ProductPrices,
+  "price_range": PriceRange,
+  "price_tiers": [TierPrice],
+  "product_links": [ProductLinksInterface],
+  "purpose": 987,
+  "quantity": 123.45,
+  "rating_summary": 987.65,
+  "redirect_code": 123,
+  "related_products": [ProductInterface],
+  "relative_url": "abc123",
+  "review_count": 987,
+  "reviews": ProductReviews,
+  "sale": 987,
+  "short_description": ComplexTextValue,
+  "size": 987,
+  "sku": "xyz789",
+  "sleeve": "abc123",
+  "small_image": ProductImage,
+  "special_from_date": "abc123",
+  "special_price": 123.45,
+  "special_to_date": "abc123",
+  "staged": false,
+  "stock_status": "IN_STOCK",
+  "strap_bags": "xyz789",
+  "style_bags": "xyz789",
+  "style_bottom": "abc123",
+  "style_general": "abc123",
+  "swatch_image": "xyz789",
+  "thumbnail": ProductImage,
+  "tier_price": 987.65,
+  "tier_prices": [ProductTierPrices],
+  "type": "CMS_PAGE",
+  "type_id": "abc123",
+  "uid": 4,
+  "updated_at": "xyz789",
+  "upsell_products": [ProductInterface],
+  "url_key": "xyz789",
+  "url_path": "abc123",
+  "url_rewrites": [UrlRewrite],
+  "url_suffix": "xyz789",
+  "websites": [Website],
+  "weight": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

SimpleProductCartItemInput

+
+
+
+
Description
+

Defines a single product to add to the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ customizable_options - [CustomizableOptionInput] + An array that defines customizable options for the product.
+ data - CartItemInput! + An object containing the sku, quantity, and other relevant information about the product.
+
+
+
+
+
Example
+ 
{
+  "customizable_options": [CustomizableOptionInput],
+  "data": CartItemInput
+}
+
+
+
+
+
+
+
+ Types +
+

SimpleRequisitionListItem

+
+
+
+
Description
+

Contains details about simple products added to a requisition list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
customizable_options - [SelectedCustomizableOption]! + Selected custom options for an item in the requisition list.
product - ProductInterface! + Details about a requisition list item.
quantity - Float! + The amount added.
uid - ID! + The unique ID for the requisition list item.
+
+
+
+
+
Example
+ 
{
+  "customizable_options": [SelectedCustomizableOption],
+  "product": ProductInterface,
+  "quantity": 987.65,
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

SimpleWishlistItem

+
+
+
+
Description
+

Contains a simple product wish list item.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
added_at - String! + The date and time the item was added to the wish list.
customizable_options - [SelectedCustomizableOption]! + Custom options selected for the wish list item.
description - String + The description of the item.
id - ID! + The unique ID for a WishlistItemInterface object.
product - ProductInterface + Product details of the wish list item.
quantity - Float! + The quantity of this wish list item.
+
+
+
+
+
Example
+ 
{
+  "added_at": "xyz789",
+  "customizable_options": [SelectedCustomizableOption],
+  "description": "xyz789",
+  "id": "4",
+  "product": ProductInterface,
+  "quantity": 987.65
+}
+
+
+
+
+
+
+
+ Types +
+

SmartButtonMethodInput

+
+
+
+
Description
+

Smart button payment inputs

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ payment_source - String + The payment source for the payment method
+ payments_order_id - String + The payment services order ID
+ paypal_order_id - String + PayPal order ID
+
+
+
+
+
Example
+ 
{
+  "payment_source": "xyz789",
+  "payments_order_id": "abc123",
+  "paypal_order_id": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

SmartButtonsConfig

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
app_switch_when_available - Boolean + Indicated whether to use App Switch on enabled mobile devices
button_styles - ButtonStyles + The styles for the PayPal Smart Button configuration
code - String + The payment method code as defined in the payment gateway
display_message - Boolean + Indicates whether to display the PayPal Pay Later message
display_venmo - Boolean + Indicates whether to display Venmo
is_visible - Boolean + Indicates whether the payment method is displayed
message_styles - MessageStyles + Contains details about the styles for the PayPal Pay Later message
payment_intent - String + Defines the payment intent (Authorize or Capture
sdk_params - [SDKParams] + The PayPal parameters required to load the JS SDK
sort_order - String + The relative order the payment method is displayed on the checkout page
title - String + The name displayed for the payment method
+
+
+
+
+
Example
+ 
{
+  "app_switch_when_available": false,
+  "button_styles": ButtonStyles,
+  "code": "xyz789",
+  "display_message": false,
+  "display_venmo": true,
+  "is_visible": true,
+  "message_styles": MessageStyles,
+  "payment_intent": "xyz789",
+  "sdk_params": [SDKParams],
+  "sort_order": "abc123",
+  "title": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

SortEnum

+
+
+
+
Description
+

Indicates whether to return results in ascending or descending order.

+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

ASC

+ 		+
+

DESC

+ 		+
+
+
+
+
+
Example
+ 
"ASC"
+
+
+
+
+
+
+
+ Types +
+

SortField

+
+
+
+
Description
+

Defines a possible sort field.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
label - String + The label of the sort field.
value - String + The attribute code of the sort field.
+
+
+
+
+
Example
+ 
{
+  "label": "xyz789",
+  "value": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

SortFields

+
+
+
+
Description
+

Contains a default value for sort fields and all available sort fields.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
default - String + The default sort field value.
options - [SortField] + An array of possible sort fields.
+
+
+
+
+
Example
+ 
{
+  "default": "xyz789",
+  "options": [SortField]
+}
+
+
+
+
+
+
+
+ Types +
+

SortQuoteItemsEnum

+
+
+
+
Description
+

Specifies the field to use for sorting quote items

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

ITEM_ID

+ 		+
+

CREATED_AT

+ 		+
+

UPDATED_AT

+ 		+
+

PRODUCT_ID

+ 		+
+

SKU

+ 		+
+

NAME

+ 		+
+

DESCRIPTION

+ 		+
+

WEIGHT

+ 		+
+

QTY

+ 		+
+

PRICE

+ 		+
+

BASE_PRICE

+ 		+
+

CUSTOM_PRICE

+ 		+
+

DISCOUNT_PERCENT

+ 		+
+

DISCOUNT_AMOUNT

+ 		+
+

BASE_DISCOUNT_AMOUNT

+ 		+
+

TAX_PERCENT

+ 		+
+

TAX_AMOUNT

+ 		+
+

BASE_TAX_AMOUNT

+ 		+
+

ROW_TOTAL

+ 		+
+

BASE_ROW_TOTAL

+ 		+
+

ROW_TOTAL_WITH_DISCOUNT

+ 		+
+

ROW_WEIGHT

+ 		+
+

PRODUCT_TYPE

+ 		+
+

BASE_TAX_BEFORE_DISCOUNT

+ 		+
+

TAX_BEFORE_DISCOUNT

+ 		+
+

ORIGINAL_CUSTOM_PRICE

+ 		+
+

PRICE_INC_TAX

+ 		+
+

BASE_PRICE_INC_TAX

+ 		+
+

ROW_TOTAL_INC_TAX

+ 		+
+

BASE_ROW_TOTAL_INC_TAX

+ 		+
+

DISCOUNT_TAX_COMPENSATION_AMOUNT

+ 		+
+

BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT

+ 		+
+

FREE_SHIPPING

+ 		+
+
+
+
+
+
Example
+ 
"ITEM_ID"
+
+
+
+
+
+
+
+ Types +
+

StoreConfig

+
+
+
+
Description
+

Contains information about a store's configuration.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
absolute_footer - String + Contains scripts that must be included in the HTML before the closing <body> tag.
allow_gift_receipt - String + Indicates if the gift sender has the option to send a gift receipt. Possible values: 1 (Yes) and 0 (No).
allow_gift_wrapping_on_order - String + Indicates whether gift wrapping can be added for the entire order. Possible values: 1 (Yes) and 0 (No).
allow_gift_wrapping_on_order_items - String + Indicates whether gift wrapping can be added for individual order items. Possible values: 1 (Yes) and 0 (No).
allow_guests_to_write_product_reviews - String + Indicates whether guest users can write product reviews. Possible values: 1 (Yes) and 0 (No).
allow_items - String + The value of the Allow Gift Messages for Order Items option
allow_order - String + The value of the Allow Gift Messages on Order Level option
allow_printed_card - String + Indicates if a printed card can accompany an order. Possible values: 1 (Yes) and 0 (No).
autocomplete_on_storefront - Boolean + Indicates whether to enable autocomplete on login and forgot password forms.
base_currency_code - String + The base currency code.
base_link_url - String + A fully-qualified URL that is used to create relative links to the base_url.
base_media_url - String + The fully-qualified URL that specifies the location of media files.
base_static_url - String + The fully-qualified URL that specifies the location of static view files.
base_url - String + The store’s fully-qualified base URL.
braintree_3dsecure_allowspecific - Boolean + Braintree 3D Secure, should 3D Secure be used for specific countries.
braintree_3dsecure_always_request_3ds - Boolean + Braintree 3D Secure, always request 3D Secure flag.
braintree_3dsecure_specificcountry - String + Braintree 3D Secure, the specific countries to use 3D Secure in, to be used if allow specific is status is enabled.
braintree_3dsecure_threshold_amount - String + Braintree 3D Secure, threshold above which 3D Secure should be requested.
braintree_3dsecure_verify_3dsecure - Boolean + Braintree 3D Secure enabled/active status.
braintree_ach_direct_debit_vault_active - Boolean + Braintree ACH vault status.
braintree_applepay_merchant_name - String + Braintree Apple Pay merchant name.
braintree_applepay_vault_active - Boolean + Braintree Apple Pay vault status.
braintree_cc_vault_active - String + Braintree cc vault status.
braintree_cc_vault_cvv - Boolean + Braintree cc vault CVV re-verification enabled status.
braintree_environment - String + Braintree environment.
braintree_googlepay_btn_color - String + Braintree Google Pay button color.
braintree_googlepay_cctypes - String + Braintree Google Pay Card types supported.
braintree_googlepay_merchant_id - String + Braintree Google Pay merchant ID.
braintree_googlepay_vault_active - Boolean + Braintree Google Pay vault status.
braintree_local_payment_allowed_methods - String + Braintree Local Payment Methods allowed payment methods.
braintree_local_payment_fallback_button_text - String + Braintree Local Payment Methods fallback button text.
braintree_local_payment_redirect_on_fail - String + Braintree Local Payment Methods redirect URL on failed payment.
braintree_merchant_account_id - String + Braintree Merchant Account ID.
braintree_paypal_button_location_cart_type_credit_color - String + Braintree PayPal Credit mini-cart & cart button style color.
braintree_paypal_button_location_cart_type_credit_label - String + Braintree PayPal Credit mini-cart & cart button style label.
braintree_paypal_button_location_cart_type_credit_shape - String + Braintree PayPal Credit mini-cart & cart button style shape.
braintree_paypal_button_location_cart_type_credit_show - Boolean + Braintree PayPal Credit mini-cart & cart button show status.
braintree_paypal_button_location_cart_type_messaging_layout - String + Braintree PayPal Pay Later messaging mini-cart & cart style layout.
braintree_paypal_button_location_cart_type_messaging_logo - String + Braintree PayPal Pay Later messaging mini-cart & cart style logo.
braintree_paypal_button_location_cart_type_messaging_logo_position - String + Braintree PayPal Pay Later messaging mini-cart & cart style logo position.
braintree_paypal_button_location_cart_type_messaging_show - Boolean + Braintree PayPal Pay Later messaging mini-cart & cart show status.
braintree_paypal_button_location_cart_type_messaging_text_color - String + Braintree PayPal Pay Later messaging checkout style text color.
braintree_paypal_button_location_cart_type_paylater_color - String + Braintree PayPal Pay Later mini-cart & cart button style color.
braintree_paypal_button_location_cart_type_paylater_label - String + Braintree PayPal Pay Later mini-cart & cart button style label.
braintree_paypal_button_location_cart_type_paylater_shape - String + Braintree PayPal Pay Later mini-cart & cart button style shape.
braintree_paypal_button_location_cart_type_paylater_show - Boolean + Braintree PayPal Pay Later mini-cart & cart button show status.
braintree_paypal_button_location_cart_type_paypal_color - String + Braintree PayPal mini-cart & cart button style color.
braintree_paypal_button_location_cart_type_paypal_label - String + Braintree PayPal mini-cart & cart button style label.
braintree_paypal_button_location_cart_type_paypal_shape - String + Braintree PayPal mini-cart & cart button style shape.
braintree_paypal_button_location_cart_type_paypal_show - Boolean + Braintree PayPal mini-cart & cart button show.
braintree_paypal_button_location_checkout_type_credit_color - String + Braintree PayPal Credit checkout button style color.
braintree_paypal_button_location_checkout_type_credit_label - String + Braintree PayPal Credit checkout button style label.
braintree_paypal_button_location_checkout_type_credit_shape - String + Braintree PayPal Credit checkout button style shape.
braintree_paypal_button_location_checkout_type_credit_show - Boolean + Braintree PayPal Credit checkout button show status.
braintree_paypal_button_location_checkout_type_messaging_layout - String + Braintree PayPal Pay Later messaging checkout style layout.
braintree_paypal_button_location_checkout_type_messaging_logo - String + Braintree PayPal Pay Later messaging checkout style logo.
braintree_paypal_button_location_checkout_type_messaging_logo_position - String + Braintree PayPal Pay Later messaging checkout style logo position.
braintree_paypal_button_location_checkout_type_messaging_show - Boolean + Braintree PayPal Pay Later messaging checkout show status.
braintree_paypal_button_location_checkout_type_messaging_text_color - String + Braintree PayPal Pay Later messaging checkout style text color.
braintree_paypal_button_location_checkout_type_paylater_color - String + Braintree PayPal Pay Later checkout button style color.
braintree_paypal_button_location_checkout_type_paylater_label - String + Braintree PayPal Pay Later checkout button style label.
braintree_paypal_button_location_checkout_type_paylater_shape - String + Braintree PayPal Pay Later checkout button style shape.
braintree_paypal_button_location_checkout_type_paylater_show - Boolean + Braintree PayPal Pay Later checkout button show status.
braintree_paypal_button_location_checkout_type_paypal_color - String + Braintree PayPal checkout button style color.
braintree_paypal_button_location_checkout_type_paypal_label - String + Braintree PayPal checkout button style label.
braintree_paypal_button_location_checkout_type_paypal_shape - String + Braintree PayPal checkout button style shape.
braintree_paypal_button_location_checkout_type_paypal_show - Boolean + Braintree PayPal checkout button show.
braintree_paypal_button_location_productpage_type_credit_color - String + Braintree PayPal Credit PDP button style color.
braintree_paypal_button_location_productpage_type_credit_label - String + Braintree PayPal Credit PDP button style label.
braintree_paypal_button_location_productpage_type_credit_shape - String + Braintree PayPal Credit PDP button style shape.
braintree_paypal_button_location_productpage_type_credit_show - Boolean + Braintree PayPal Credit PDP button show status.
braintree_paypal_button_location_productpage_type_messaging_layout - String + Braintree PayPal Pay Later messaging PDP style layout.
braintree_paypal_button_location_productpage_type_messaging_logo - String + Braintree PayPal Pay Later messaging PDP style logo.
braintree_paypal_button_location_productpage_type_messaging_logo_position - String + Braintree PayPal Pay Later messaging PDP style logo position.
braintree_paypal_button_location_productpage_type_messaging_show - Boolean + Braintree PayPal Pay Later messaging PDP show status.
braintree_paypal_button_location_productpage_type_messaging_text_color - String + Braintree PayPal Pay Later messaging PDP style text color.
braintree_paypal_button_location_productpage_type_paylater_color - String + Braintree PayPal Pay Later PDP button style color.
braintree_paypal_button_location_productpage_type_paylater_label - String + Braintree PayPal Pay Later PDP button style label.
braintree_paypal_button_location_productpage_type_paylater_shape - String + Braintree PayPal Pay Later PDP button style shape.
braintree_paypal_button_location_productpage_type_paylater_show - Boolean + Braintree PayPal Pay Later PDP button show status.
braintree_paypal_button_location_productpage_type_paypal_color - String + Braintree PayPal PDP button style color.
braintree_paypal_button_location_productpage_type_paypal_label - String + Braintree PayPal PDP button style label.
braintree_paypal_button_location_productpage_type_paypal_shape - String + Braintree PayPal PDP button style shape.
braintree_paypal_button_location_productpage_type_paypal_show - Boolean + Braintree PayPal PDP button show.
braintree_paypal_credit_uk_merchant_name - String + Braintree PayPal Credit Merchant Name on the FCA Register.
braintree_paypal_display_on_shopping_cart - Boolean + Should display Braintree PayPal in mini-cart & cart?
braintree_paypal_merchant_country - String + Braintree PayPal merchant's country.
braintree_paypal_merchant_name_override - String + Braintree PayPal override for Merchant Name.
braintree_paypal_require_billing_address - Boolean + Does Braintree PayPal require the customer's billing address?
braintree_paypal_send_cart_line_items - Boolean + Does Braintree PayPal require the order line items?
braintree_paypal_vault_active - Boolean + Braintree PayPal vault status.
cart_expires_in_days - Int + checkout/cart/delete_quote_after: quote lifetime in days.
cart_gift_wrapping - String + Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No).
cart_merge_preference - String! + Configuration data from checkout/cart/cart_merge_preference
cart_printed_card - String + Indicates if printed card prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No).
cart_summary_display_quantity - Int + checkout/cart_link/use_qty: what to show in the display cart summary, number of items or item quantities.
catalog_default_sort_by - String + The default sort order of the search results list.
category_fixed_product_tax_display_setting - FixedProductTaxDisplaySettings + Corresponds to the 'Display Prices In Product Lists' field in the Admin. It indicates how FPT information is displayed on category pages.
category_url_suffix - String + The suffix applied to category pages, such as .htm or .html.
check_money_order_enable_for_specific_countries - Boolean + Indicates whether only specific countries can use this payment method.
check_money_order_enabled - Boolean + Indicates whether the Check/Money Order payment method is enabled.
check_money_order_make_check_payable_to - String + The name of the party to whom the check must be payable.
check_money_order_max_order_total - String + The maximum order amount required to qualify for the Check/Money Order payment method.
check_money_order_min_order_total - String + The minimum order amount required to qualify for the Check/Money Order payment method.
check_money_order_new_order_status - String + The status of new orders placed using the Check/Money Order payment method.
check_money_order_payment_from_specific_countries - String + A comma-separated list of specific countries allowed to use the Check/Money Order payment method.
check_money_order_send_check_to - String + The full street address or PO Box where the checks are mailed.
check_money_order_sort_order - Int + A number indicating the position of the Check/Money Order payment method in the list of available payment methods during checkout.
check_money_order_title - String + The title of the Check/Money Order payment method displayed on the storefront.
cms_home_page - String + The name of the CMS page that identifies the home page for the store.
cms_no_cookies - String + A specific CMS page that displays when cookies are not enabled for the browser.
cms_no_route - String + A specific CMS page that displays when a 404 'Page Not Found' error occurs.
code - String + A code assigned to the store to identify it. Use store_code instead. +
configurable_product_image - ProductImageThumbnail! + checkout/cart/configurable_product_image: which image to use for configurable products.
configurable_thumbnail_source - String + Indicates whether the parent or child (itself) thumbnail should be used in the cart for configurable products.
contact_enabled - Boolean! + Indicates whether the Contact Us form in enabled.
copyright - String + The copyright statement that appears at the bottom of each page.
countries_with_required_region - String + Extended Config Data - general/region/state_required
create_account_confirmation - Boolean + Indicates if the new accounts need confirmation.
customer_access_token_lifetime - Float + Customer access token lifetime.
default_country - String + Extended Config Data - general/country/default
default_description - String + The description that provides a summary of your site for search engine listings. It should not be more than 160 characters in length.
default_display_currency_code - String + The default display currency code.
default_keywords - String + A series of keywords that describe your store, each separated by a comma.
default_title - String + The title that appears at the title bar of each page when viewed in a browser.
demonotice - Int + Controls the display of the demo store notice at the top of the page. Options: 0 (No) or 1 (Yes).
display_product_prices_in_catalog - Int! + Configuration data from tax/display/type
display_shipping_prices - Int! + Configuration data from tax/display/shipping
display_state_if_optional - Boolean + Extended Config Data - general/region/display_all
enable_multiple_wishlists - String + Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No).
fixed_product_taxes_apply_tax_to_fpt - Boolean! + Configuration data from tax/weee/apply_vat
fixed_product_taxes_display_prices_in_emails - Int! + Configuration data from tax/weee/display_email
fixed_product_taxes_display_prices_in_product_lists - Int! + Configuration data from tax/weee/display_list
fixed_product_taxes_display_prices_in_sales_modules - Int! + Configuration data from tax/weee/display_sales
fixed_product_taxes_display_prices_on_product_view_page - Int! + Configuration data from tax/weee/display
fixed_product_taxes_enable - Boolean! + Configuration data from tax/weee/enable
fixed_product_taxes_include_fpt_in_subtotal - Boolean! + Configuration data from tax/weee/include_in_subtotal
front - String + The landing page that is associated with the base URL.
graphql_share_customer_group - Boolean + Configuration data from customer/account_information/graphql_share_customer_group
grid_per_page - Int + The default number of products per page in Grid View.
grid_per_page_values - String + A list of numbers that define how many products can be displayed in Grid View.
grouped_product_image - ProductImageThumbnail! + checkout/cart/grouped_product_image: which image to use for grouped products.
head_includes - String + Scripts that must be included in the HTML before the closing <head> tag.
head_shortcut_icon - String + The small graphic image (favicon) that appears in the address bar and tab of the browser.
header_logo_src - String + The path to the logo that appears in the header.
id - Int + The ID number assigned to the store. Use store_code instead. +
is_checkout_agreements_enabled - Boolean! + Configuration data from checkout/options/enable_agreements
is_default_store - Boolean + Indicates whether the store view has been designated as the default within the store group.
is_default_store_group - Boolean + Indicates whether the store group has been designated as the default within the website.
is_guest_checkout_enabled - Boolean + checkout/options/guest_checkout: whether the guest checkout is enabled or not.
is_negotiable_quote_active - Boolean + Indicates whether negotiable quote functionality is enabled.
is_one_page_checkout_enabled - Boolean + checkout/options/onepage_checkout_enabled: whether the one page checkout is enabled or not
is_requisition_list_active - String + Indicates whether requisition lists are enabled. Possible values: 1 (Yes) and 0 (No).
list_mode - String + The format of the search results list.
list_per_page - Int + The default number of products per page in List View.
list_per_page_values - String + A list of numbers that define how many products can be displayed in List View.
locale - String + The store locale.
logo_alt - String + The Alt text that is associated with the logo.
logo_height - Int + The height of the logo image, in pixels.
logo_width - Int + The width of the logo image, in pixels.
magento_reward_general_is_enabled - String + Indicates whether reward points functionality is enabled. Possible values: 1 (Enabled) and 0 (Disabled).
magento_reward_general_is_enabled_on_front - String + Indicates whether reward points functionality is enabled on the storefront. Possible values: 1 (Enabled) and 0 (Disabled).
magento_reward_general_min_points_balance - String + The minimum point balance customers must have before they can redeem them. A null value indicates no minimum.
magento_reward_general_publish_history - String + When enabled, customers can see a detailed history of their reward points. Possible values: 1 (Enabled) and 0 (Disabled).
magento_reward_points_invitation_customer - String + The number of points for a referral when an invitee registers on the site.
magento_reward_points_invitation_customer_limit - String + The maximum number of registration referrals that will qualify for rewards. A null value indicates no limit.
magento_reward_points_invitation_order - String + The number of points for a referral, when an invitee places their first order on the site.
magento_reward_points_invitation_order_limit - String + The number of order conversions that can earn points for the customer who sends the invitation. A null value indicates no limit.
magento_reward_points_newsletter - String + The number of points earned by registered customers who subscribe to a newsletter.
magento_reward_points_order - String + Indicates customers earn points for shopping according to the reward point exchange rate. In Luma, this also controls whether to show a message in the shopping cart about the rewards points earned for the purchase, as well as the customer’s current reward point balance.
magento_reward_points_register - String + The number of points customer gets for registering.
magento_reward_points_review - String + The number of points for writing a review.
magento_reward_points_review_limit - String + The maximum number of reviews that will qualify for the rewards. A null value indicates no limit.
magento_wishlist_general_is_enabled - String + Indicates whether wishlists are enabled (1) or disabled (0).
max_items_in_order_summary - Int + checkout/options/max_items_display_count: maximum number of items to display in order summary.
maximum_number_of_wishlists - String + If multiple wish lists are enabled, the maximum number of wish lists the customer can have.
minicart_display - Boolean + checkout/sidebar/display: whether to display the minicart or not.
minicart_max_items - Int + checkout/sidebar/count: maximum number of items to show in minicart.
minimum_password_length - String + The minimum number of characters required for a valid password.
newsletter_enabled - Boolean! + Indicates whether newsletters are enabled.
no_route - String + The default page that displays when a 404 'Page not Found' error occurs.
optional_zip_countries - String + Extended Config Data - general/country/optional_zip_countries
order_cancellation_enabled - Boolean! + Indicates whether orders can be cancelled by customers or not.
order_cancellation_reasons - [CancellationReason]! + An array containing available cancellation reasons.
orders_invoices_credit_memos_display_full_summary - Boolean! + Configuration data from tax/sales_display/full_summary
orders_invoices_credit_memos_display_grandtotal - Boolean! + Configuration data from tax/sales_display/grandtotal
orders_invoices_credit_memos_display_price - Int! + Configuration data from tax/sales_display/price
orders_invoices_credit_memos_display_shipping_amount - Int! + Configuration data from tax/sales_display/shipping
orders_invoices_credit_memos_display_subtotal - Int! + Configuration data from tax/sales_display/subtotal
orders_invoices_credit_memos_display_zero_tax - Boolean! + Configuration data from tax/sales_display/zero_tax
payment_payflowpro_cc_vault_active - String + Payflow Pro vault status.
printed_card_price - String + The default price of a printed card that accompanies an order. Use printed_card_priceV2 instead +
printed_card_priceV2 - Money + The default price of a printed card that accompanies an order.
product_fixed_product_tax_display_setting - FixedProductTaxDisplaySettings + Corresponds to the 'Display Prices On Product View Page' field in the Admin. It indicates how FPT information is displayed on product pages.
product_reviews_enabled - String + Indicates whether product reviews are enabled. Possible values: 1 (Yes) and 0 (No).
product_url_suffix - String + The suffix applied to product pages, such as .htm or .html.
quickorder_active - Boolean! + Indicates whether quick order functionality is enabled.
required_character_classes_number - String + The number of different character classes (lowercase, uppercase, digits, special characters) required in a password.
returns_enabled - String! + Indicates whether RMA is enabled on the storefront. Possible values: enabled/disabled.
root_category_id - Int + The ID of the root category. Use root_category_uid instead. +
root_category_uid - ID + The unique ID for a CategoryInterface object.
sales_fixed_product_tax_display_setting - FixedProductTaxDisplaySettings + Corresponds to the 'Display Prices In Sales Modules' field in the Admin. It indicates how FPT information is displayed on cart, checkout, and order pages.
sales_gift_wrapping - String + Indicates if gift wrapping prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No).
sales_printed_card - String + Indicates if printed card prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No).
secure_base_link_url - String + A secure fully-qualified URL that is used to create relative links to the base_url.
secure_base_media_url - String + The secure fully-qualified URL that specifies the location of media files.
secure_base_static_url - String + The secure fully-qualified URL that specifies the location of static view files.
secure_base_url - String + The store’s fully-qualified secure base URL.
send_friend - SendFriendConfiguration + Email to a Friend configuration.
share_active_segments - Boolean + Configuration data from customer/magento_customersegment/share_active_segments
share_applied_cart_rule - Boolean + Configuration data from promo/graphql/share_applied_cart_rule
shopping_cart_display_full_summary - Boolean + Extended Config Data - tax/cart_display/full_summary
shopping_cart_display_grand_total - Boolean + Extended Config Data - tax/cart_display/grandtotal
shopping_cart_display_price - Int + Extended Config Data - tax/cart_display/price
shopping_cart_display_shipping - Int + Extended Config Data - tax/cart_display/shipping
shopping_cart_display_subtotal - Int + Extended Config Data - tax/cart_display/subtotal
shopping_cart_display_tax_gift_wrapping - TaxWrappingEnum + Extended Config Data - tax/cart_display/gift_wrapping
shopping_cart_display_zero_tax - Boolean + Extended Config Data - tax/cart_display/zero_tax
show_cms_breadcrumbs - Int + Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes).
store_code - ID + The unique ID of the store view. In the Admin, this is called the Store View Code. When making a GraphQL call, assign this value to the Store header to provide the scope.
store_group_code - ID + The unique ID assigned to the store group. In the Admin, this is called the Store Name.
store_group_name - String + The label assigned to the store group.
store_name - String + The label assigned to the store view.
store_sort_order - Int + The store view sort order.
timezone - String + The time zone of the store.
title_prefix - String + A prefix that appears before the title to create a two- or three-part title.
title_separator - String + The character that separates the category name and subcategory in the browser title bar.
title_suffix - String + A suffix that appears after the title to create a two- or three-part title.
use_store_in_url - Boolean + Indicates whether the store code should be used in the URL.
website_code - ID + The unique ID for the website.
website_id - Int + The ID number assigned to the website store. The field should not be used on the storefront. +
website_name - String + The label assigned to the website.
weight_unit - String + The unit of weight.
welcome - String + Text that appears in the header of the page and includes the name of the logged in customer.
zero_subtotal_enable_for_specific_countries - Boolean + Indicates whether only specific countries can use this payment method.
zero_subtotal_enabled - Boolean + Indicates whether the Zero Subtotal payment method is enabled.
zero_subtotal_new_order_status - String + The status of new orders placed using the Zero Subtotal payment method.
zero_subtotal_payment_action - String + When the new order status is 'Processing', this can be set to authorize_capture to automatically invoice all items that have a zero balance.
zero_subtotal_payment_from_specific_countries - String + A comma-separated list of specific countries allowed to use the Zero Subtotal payment method.
zero_subtotal_sort_order - Int + A number indicating the position of the Zero Subtotal payment method in the list of available payment methods during checkout.
zero_subtotal_title - String + The title of the Zero Subtotal payment method displayed on the storefront.
+
+
+
+
+
Example
+ 
{
+  "absolute_footer": "abc123",
+  "allow_gift_receipt": "abc123",
+  "allow_gift_wrapping_on_order": "abc123",
+  "allow_gift_wrapping_on_order_items": "abc123",
+  "allow_guests_to_write_product_reviews": "xyz789",
+  "allow_items": "abc123",
+  "allow_order": "abc123",
+  "allow_printed_card": "xyz789",
+  "autocomplete_on_storefront": true,
+  "base_currency_code": "xyz789",
+  "base_link_url": "xyz789",
+  "base_media_url": "abc123",
+  "base_static_url": "xyz789",
+  "base_url": "xyz789",
+  "braintree_3dsecure_allowspecific": true,
+  "braintree_3dsecure_always_request_3ds": false,
+  "braintree_3dsecure_specificcountry": "abc123",
+  "braintree_3dsecure_threshold_amount": "abc123",
+  "braintree_3dsecure_verify_3dsecure": false,
+  "braintree_ach_direct_debit_vault_active": true,
+  "braintree_applepay_merchant_name": "abc123",
+  "braintree_applepay_vault_active": false,
+  "braintree_cc_vault_active": "abc123",
+  "braintree_cc_vault_cvv": true,
+  "braintree_environment": "xyz789",
+  "braintree_googlepay_btn_color": "abc123",
+  "braintree_googlepay_cctypes": "xyz789",
+  "braintree_googlepay_merchant_id": "xyz789",
+  "braintree_googlepay_vault_active": true,
+  "braintree_local_payment_allowed_methods": "xyz789",
+  "braintree_local_payment_fallback_button_text": "abc123",
+  "braintree_local_payment_redirect_on_fail": "abc123",
+  "braintree_merchant_account_id": "abc123",
+  "braintree_paypal_button_location_cart_type_credit_color": "xyz789",
+  "braintree_paypal_button_location_cart_type_credit_label": "abc123",
+  "braintree_paypal_button_location_cart_type_credit_shape": "abc123",
+  "braintree_paypal_button_location_cart_type_credit_show": true,
+  "braintree_paypal_button_location_cart_type_messaging_layout": "abc123",
+  "braintree_paypal_button_location_cart_type_messaging_logo": "abc123",
+  "braintree_paypal_button_location_cart_type_messaging_logo_position": "xyz789",
+  "braintree_paypal_button_location_cart_type_messaging_show": true,
+  "braintree_paypal_button_location_cart_type_messaging_text_color": "xyz789",
+  "braintree_paypal_button_location_cart_type_paylater_color": "xyz789",
+  "braintree_paypal_button_location_cart_type_paylater_label": "abc123",
+  "braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
+  "braintree_paypal_button_location_cart_type_paylater_show": true,
+  "braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
+  "braintree_paypal_button_location_cart_type_paypal_label": "xyz789",
+  "braintree_paypal_button_location_cart_type_paypal_shape": "abc123",
+  "braintree_paypal_button_location_cart_type_paypal_show": false,
+  "braintree_paypal_button_location_checkout_type_credit_color": "abc123",
+  "braintree_paypal_button_location_checkout_type_credit_label": "xyz789",
+  "braintree_paypal_button_location_checkout_type_credit_shape": "abc123",
+  "braintree_paypal_button_location_checkout_type_credit_show": false,
+  "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789",
+  "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789",
+  "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789",
+  "braintree_paypal_button_location_checkout_type_messaging_show": true,
+  "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123",
+  "braintree_paypal_button_location_checkout_type_paylater_color": "xyz789",
+  "braintree_paypal_button_location_checkout_type_paylater_label": "abc123",
+  "braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789",
+  "braintree_paypal_button_location_checkout_type_paylater_show": false,
+  "braintree_paypal_button_location_checkout_type_paypal_color": "xyz789",
+  "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789",
+  "braintree_paypal_button_location_checkout_type_paypal_shape": "abc123",
+  "braintree_paypal_button_location_checkout_type_paypal_show": true,
+  "braintree_paypal_button_location_productpage_type_credit_color": "abc123",
+  "braintree_paypal_button_location_productpage_type_credit_label": "abc123",
+  "braintree_paypal_button_location_productpage_type_credit_shape": "xyz789",
+  "braintree_paypal_button_location_productpage_type_credit_show": false,
+  "braintree_paypal_button_location_productpage_type_messaging_layout": "abc123",
+  "braintree_paypal_button_location_productpage_type_messaging_logo": "abc123",
+  "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789",
+  "braintree_paypal_button_location_productpage_type_messaging_show": true,
+  "braintree_paypal_button_location_productpage_type_messaging_text_color": "xyz789",
+  "braintree_paypal_button_location_productpage_type_paylater_color": "abc123",
+  "braintree_paypal_button_location_productpage_type_paylater_label": "abc123",
+  "braintree_paypal_button_location_productpage_type_paylater_shape": "abc123",
+  "braintree_paypal_button_location_productpage_type_paylater_show": true,
+  "braintree_paypal_button_location_productpage_type_paypal_color": "abc123",
+  "braintree_paypal_button_location_productpage_type_paypal_label": "abc123",
+  "braintree_paypal_button_location_productpage_type_paypal_shape": "abc123",
+  "braintree_paypal_button_location_productpage_type_paypal_show": false,
+  "braintree_paypal_credit_uk_merchant_name": "abc123",
+  "braintree_paypal_display_on_shopping_cart": true,
+  "braintree_paypal_merchant_country": "abc123",
+  "braintree_paypal_merchant_name_override": "xyz789",
+  "braintree_paypal_require_billing_address": true,
+  "braintree_paypal_send_cart_line_items": true,
+  "braintree_paypal_vault_active": false,
+  "cart_expires_in_days": 123,
+  "cart_gift_wrapping": "abc123",
+  "cart_merge_preference": "abc123",
+  "cart_printed_card": "abc123",
+  "cart_summary_display_quantity": 987,
+  "catalog_default_sort_by": "xyz789",
+  "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
+  "category_url_suffix": "xyz789",
+  "check_money_order_enable_for_specific_countries": true,
+  "check_money_order_enabled": false,
+  "check_money_order_make_check_payable_to": "xyz789",
+  "check_money_order_max_order_total": "abc123",
+  "check_money_order_min_order_total": "xyz789",
+  "check_money_order_new_order_status": "abc123",
+  "check_money_order_payment_from_specific_countries": "abc123",
+  "check_money_order_send_check_to": "abc123",
+  "check_money_order_sort_order": 987,
+  "check_money_order_title": "abc123",
+  "cms_home_page": "abc123",
+  "cms_no_cookies": "abc123",
+  "cms_no_route": "abc123",
+  "code": "xyz789",
+  "configurable_product_image": "ITSELF",
+  "configurable_thumbnail_source": "abc123",
+  "contact_enabled": false,
+  "copyright": "xyz789",
+  "countries_with_required_region": "abc123",
+  "create_account_confirmation": true,
+  "customer_access_token_lifetime": 987.65,
+  "default_country": "abc123",
+  "default_description": "xyz789",
+  "default_display_currency_code": "abc123",
+  "default_keywords": "abc123",
+  "default_title": "abc123",
+  "demonotice": 987,
+  "display_product_prices_in_catalog": 123,
+  "display_shipping_prices": 123,
+  "display_state_if_optional": true,
+  "enable_multiple_wishlists": "xyz789",
+  "fixed_product_taxes_apply_tax_to_fpt": false,
+  "fixed_product_taxes_display_prices_in_emails": 123,
+  "fixed_product_taxes_display_prices_in_product_lists": 123,
+  "fixed_product_taxes_display_prices_in_sales_modules": 987,
+  "fixed_product_taxes_display_prices_on_product_view_page": 987,
+  "fixed_product_taxes_enable": true,
+  "fixed_product_taxes_include_fpt_in_subtotal": true,
+  "front": "xyz789",
+  "graphql_share_customer_group": true,
+  "grid_per_page": 123,
+  "grid_per_page_values": "abc123",
+  "grouped_product_image": "ITSELF",
+  "head_includes": "abc123",
+  "head_shortcut_icon": "abc123",
+  "header_logo_src": "xyz789",
+  "id": 123,
+  "is_checkout_agreements_enabled": false,
+  "is_default_store": true,
+  "is_default_store_group": false,
+  "is_guest_checkout_enabled": true,
+  "is_negotiable_quote_active": false,
+  "is_one_page_checkout_enabled": false,
+  "is_requisition_list_active": "abc123",
+  "list_mode": "xyz789",
+  "list_per_page": 987,
+  "list_per_page_values": "abc123",
+  "locale": "abc123",
+  "logo_alt": "xyz789",
+  "logo_height": 123,
+  "logo_width": 123,
+  "magento_reward_general_is_enabled": "abc123",
+  "magento_reward_general_is_enabled_on_front": "xyz789",
+  "magento_reward_general_min_points_balance": "xyz789",
+  "magento_reward_general_publish_history": "xyz789",
+  "magento_reward_points_invitation_customer": "xyz789",
+  "magento_reward_points_invitation_customer_limit": "xyz789",
+  "magento_reward_points_invitation_order": "xyz789",
+  "magento_reward_points_invitation_order_limit": "xyz789",
+  "magento_reward_points_newsletter": "abc123",
+  "magento_reward_points_order": "abc123",
+  "magento_reward_points_register": "xyz789",
+  "magento_reward_points_review": "abc123",
+  "magento_reward_points_review_limit": "xyz789",
+  "magento_wishlist_general_is_enabled": "abc123",
+  "max_items_in_order_summary": 987,
+  "maximum_number_of_wishlists": "xyz789",
+  "minicart_display": false,
+  "minicart_max_items": 123,
+  "minimum_password_length": "xyz789",
+  "newsletter_enabled": true,
+  "no_route": "xyz789",
+  "optional_zip_countries": "abc123",
+  "order_cancellation_enabled": false,
+  "order_cancellation_reasons": [CancellationReason],
+  "orders_invoices_credit_memos_display_full_summary": false,
+  "orders_invoices_credit_memos_display_grandtotal": false,
+  "orders_invoices_credit_memos_display_price": 987,
+  "orders_invoices_credit_memos_display_shipping_amount": 987,
+  "orders_invoices_credit_memos_display_subtotal": 987,
+  "orders_invoices_credit_memos_display_zero_tax": true,
+  "payment_payflowpro_cc_vault_active": "xyz789",
+  "printed_card_price": "abc123",
+  "printed_card_priceV2": Money,
+  "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
+  "product_reviews_enabled": "xyz789",
+  "product_url_suffix": "abc123",
+  "quickorder_active": true,
+  "required_character_classes_number": "xyz789",
+  "returns_enabled": "abc123",
+  "root_category_id": 123,
+  "root_category_uid": "4",
+  "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
+  "sales_gift_wrapping": "xyz789",
+  "sales_printed_card": "xyz789",
+  "secure_base_link_url": "abc123",
+  "secure_base_media_url": "abc123",
+  "secure_base_static_url": "xyz789",
+  "secure_base_url": "abc123",
+  "send_friend": SendFriendConfiguration,
+  "share_active_segments": true,
+  "share_applied_cart_rule": true,
+  "shopping_cart_display_full_summary": false,
+  "shopping_cart_display_grand_total": false,
+  "shopping_cart_display_price": 987,
+  "shopping_cart_display_shipping": 123,
+  "shopping_cart_display_subtotal": 123,
+  "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
+  "shopping_cart_display_zero_tax": true,
+  "show_cms_breadcrumbs": 987,
+  "store_code": "4",
+  "store_group_code": "4",
+  "store_group_name": "abc123",
+  "store_name": "xyz789",
+  "store_sort_order": 987,
+  "timezone": "abc123",
+  "title_prefix": "xyz789",
+  "title_separator": "xyz789",
+  "title_suffix": "xyz789",
+  "use_store_in_url": true,
+  "website_code": "4",
+  "website_id": 123,
+  "website_name": "xyz789",
+  "weight_unit": "abc123",
+  "welcome": "abc123",
+  "zero_subtotal_enable_for_specific_countries": true,
+  "zero_subtotal_enabled": false,
+  "zero_subtotal_new_order_status": "xyz789",
+  "zero_subtotal_payment_action": "xyz789",
+  "zero_subtotal_payment_from_specific_countries": "abc123",
+  "zero_subtotal_sort_order": 987,
+  "zero_subtotal_title": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

StorefrontProperties

+
+
+
+
Description
+

Indicates where an attribute can be displayed.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
position - Int + The relative position of the attribute in the layered navigation block.
use_in_layered_navigation - UseInLayeredNavigationOptions + Indicates whether the attribute is filterable with results, without results, or not at all.
use_in_product_listing - Boolean + Indicates whether the attribute is displayed in product listings.
use_in_search_results_layered_navigation - Boolean + Indicates whether the attribute can be used in layered navigation on search results pages.
visible_on_catalog_pages - Boolean + Indicates whether the attribute is displayed on product pages.
+
+
+
+
+
Example
+ 
{
+  "position": 987,
+  "use_in_layered_navigation": "NO",
+  "use_in_product_listing": false,
+  "use_in_search_results_layered_navigation": true,
+  "visible_on_catalog_pages": true
+}
+
+
+
+
+
+
+
+ Types +
+

String

+
+
+
+
Description
+

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

+
+
+
+
+
Example
+ 
"abc123"
+
+
+
+
+
+
+
+ Types +
+

SubmitNegotiableQuoteTemplateForReviewInput

+
+
+
+
Description
+

Specifies the quote template properties to update.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ comment - String + A comment for the seller to review.
+ max_order_commitment - Int + Commitment for maximum orders
+ min_order_commitment - Int + Commitment for minimum orders
+ name - String + The title assigned to the negotiable quote template.
+ reference_document_links - [NegotiableQuoteTemplateReferenceDocumentLinkInput] + An array of reference document links to add to the negotiable quote template.
+ template_id - ID! + The unique ID of a NegotiableQuoteTemplate object.
+
+
+
+
+
Example
+ 
{
+  "comment": "abc123",
+  "max_order_commitment": 123,
+  "min_order_commitment": 987,
+  "name": "abc123",
+  "reference_document_links": [
+    NegotiableQuoteTemplateReferenceDocumentLinkInput
+  ],
+  "template_id": 4
+}
+
+
+
+
+
+
+
+ Types +
+

SubscribeEmailToNewsletterOutput

+
+
+
+
Description
+

Contains the result of the subscribeEmailToNewsletter operation.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
status - SubscriptionStatusesEnum + The status of the subscription request.
+
+
+
+
+
Example
+ 
{"status": "NOT_ACTIVE"}
+
+
+
+
+
+
+
+ Types +
+

SubscriptionStatusesEnum

+
+
+
+
Description
+

Indicates the status of the request.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

NOT_ACTIVE

+ 		+
+

SUBSCRIBED

+ 		+
+

UNSUBSCRIBED

+ 		+
+

UNCONFIRMED

+ 		+
+
+
+
+
+
Example
+ 
"NOT_ACTIVE"
+
+
+
+
+
+
+
+ Types +
+

SwatchData

+
+
+
+
Description
+

Describes the swatch type and a value.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
type - String + The type of swatch filter item: 1 - text; 2 - image.
value - String + The value for the swatch item. It could be text or an image link.
+
+
+
+
+
Example
+ 
{
+  "type": "abc123",
+  "value": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

SwatchDataInterface

+
+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
value - String + The value can be represented as color (HEX code), image link, or text.
+
+
+
Possible Types
+ + + + + + + + + + + + + + + + + +
SwatchDataInterface Types
+

ImageSwatchData

+
+

TextSwatchData

+
+

ColorSwatchData

+
+
+
+
+
+
Example
+ 
{"value": "xyz789"}
+
+
+
+
+
+
+
+ Types +
+

SwatchInputTypeEnum

+
+
+
+
Description
+

Swatch attribute metadata input types.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

BOOLEAN

+ 		+
+

DATE

+ 		+
+

DATETIME

+ 		+
+

DROPDOWN

+ 		+
+

FILE

+ 		+
+

GALLERY

+ 		+
+

HIDDEN

+ 		+
+

IMAGE

+ 		+
+

MEDIA_IMAGE

+ 		+
+

MULTILINE

+ 		+
+

MULTISELECT

+ 		+
+

PRICE

+ 		+
+

SELECT

+ 		+
+

TEXT

+ 		+
+

TEXTAREA

+ 		+
+

UNDEFINED

+ 		+
+

VISUAL

+ 		+
+

WEIGHT

+ 		+
+
+
+
+
+
Example
+ 
"BOOLEAN"
+
+
+
+
+
+
+
+ Types +
+

SwatchLayerFilterItem

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items_count - Int + The count of items per filter. Use AggregationOption.count instead. +
label - String + The label for a filter. Use AggregationOption.label instead. +
swatch_data - SwatchData + Data required to render a swatch filter item.
value_string - String + The value of a filter request variable to be used in query. Use AggregationOption.value instead. +
+
+
+
+
+
Example
+ 
{
+  "items_count": 123,
+  "label": "xyz789",
+  "swatch_data": SwatchData,
+  "value_string": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

SwatchLayerFilterItemInterface

+
+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
swatch_data - SwatchData + Data required to render a swatch filter item.
+
+
+
Possible Types
+ + + + + + + + + + + +
SwatchLayerFilterItemInterface Types
+

SwatchLayerFilterItem

+
+
+
+
+
+
Example
+ 
{"swatch_data": SwatchData}
+
+
+
+
+
+
+
+ Types +
+

SyncPaymentOrderInput

+
+
+
+
Description
+

Synchronizes the payment order details

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cartId - String! + The customer cart ID
+ id - String! + PayPal order ID
+
+
+
+
+
Example
+ 
{
+  "cartId": "abc123",
+  "id": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

TaxItem

+
+
+
+
Description
+

Contains tax item details.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
amount - Money! + The amount of tax applied to the item.
rate - Float! + The rate used to calculate the tax.
title - String! + A title that describes the tax.
+
+
+
+
+
Example
+ 
{
+  "amount": Money,
+  "rate": 123.45,
+  "title": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

TaxWrappingEnum

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

DISPLAY_EXCLUDING_TAX

+ 		+
+

DISPLAY_INCLUDING_TAX

+ 		+
+

DISPLAY_TYPE_BOTH

+ 		+
+
+
+
+
+
Example
+ 
"DISPLAY_EXCLUDING_TAX"
+
+
+
+
+
+
+
+ Types +
+

TextSwatchData

+
+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
value - String + The value can be represented as color (HEX code), image link, or text.
+
+
+
+
+
Example
+ 
{"value": "xyz789"}
+
+
+
+
+
+
+
+ Types +
+

ThreeDSMode

+
+
+
+
Description
+

3D Secure mode.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

OFF

+ 		+
+

SCA_WHEN_REQUIRED

+ 		+
+

SCA_ALWAYS

+ 		+
+
+
+
+
+
Example
+ 
"OFF"
+
+
+
+
+
+
+
+ Types +
+

TierPrice

+
+
+
+
Description
+

Defines a price based on the quantity purchased.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
discount - ProductDiscount + The price discount that this tier represents.
final_price - Money + The price of the product at this tier.
quantity - Float + The minimum number of items that must be purchased to qualify for this price tier.
+
+
+
+
+
Example
+ 
{
+  "discount": ProductDiscount,
+  "final_price": Money,
+  "quantity": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

UpdateCartItemsInput

+
+
+
+
Description
+

Modifies the specified items in the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String! + The unique ID of a Cart object.
+ cart_items - [CartItemUpdateInput]! + An array of items to be updated.
+
+
+
+
+
Example
+ 
{
+  "cart_id": "abc123",
+  "cart_items": [CartItemUpdateInput]
+}
+
+
+
+
+
+
+
+ Types +
+

UpdateCartItemsOutput

+
+
+
+
Description
+

Contains details about the cart after updating items.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
cart - Cart! + The cart after updating products.
errors - [CartUserInputError]! + Contains errors encountered while updating an item to the cart.
+
+
+
+
+
Example
+ 
{
+  "cart": Cart,
+  "errors": [CartUserInputError]
+}
+
+
+
+
+
+
+
+ Types +
+

UpdateCompanyOutput

+
+
+
+
Description
+

Contains the response to the request to update the company.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
company - Company! + The updated company instance.
+
+
+
+
+
Example
+ 
{"company": Company}
+
+
+
+
+
+
+
+ Types +
+

UpdateCompanyRoleOutput

+
+
+
+
Description
+

Contains the response to the request to update the company role.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
role - CompanyRole! + The updated company role instance.
+
+
+
+
+
Example
+ 
{"role": CompanyRole}
+
+
+
+
+
+
+
+ Types +
+

UpdateCompanyStructureOutput

+
+
+
+
Description
+

Contains the response to the request to update the company structure.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
company - Company! + The updated company instance.
+
+
+
+
+
Example
+ 
{"company": Company}
+
+
+
+
+
+
+
+ Types +
+

UpdateCompanyTeamOutput

+
+
+
+
Description
+

Contains the response to the request to update a company team.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
team - CompanyTeam! + The updated company team instance.
+
+
+
+
+
Example
+ 
{"team": CompanyTeam}
+
+
+
+
+
+
+
+ Types +
+

UpdateCompanyUserOutput

+
+
+
+
Description
+

Contains the response to the request to update the company user.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
user - Customer! + The updated company user instance.
+
+
+
+
+
Example
+ 
{"user": Customer}
+
+
+
+
+
+
+
+ Types +
+

UpdateGiftRegistryInput

+
+
+
+
Description
+

Defines updates to a GiftRegistry object.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ dynamic_attributes - [GiftRegistryDynamicAttributeInput] + Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed.
+ event_name - String + The updated name of the event.
+ message - String + The updated message describing the event.
+ privacy_settings - GiftRegistryPrivacySettings + Indicates whether the gift registry is PRIVATE or PUBLIC.
+ shipping_address - GiftRegistryShippingAddressInput + The updated shipping address for all gift registry items.
+ status - GiftRegistryStatus + Indicates whether the gift registry is ACTIVE or INACTIVE.
+
+
+
+
+
Example
+ 
{
+  "dynamic_attributes": [
+    GiftRegistryDynamicAttributeInput
+  ],
+  "event_name": "abc123",
+  "message": "xyz789",
+  "privacy_settings": "PRIVATE",
+  "shipping_address": GiftRegistryShippingAddressInput,
+  "status": "ACTIVE"
+}
+
+
+
+
+
+
+
+ Types +
+

UpdateGiftRegistryItemInput

+
+
+
+
Description
+

Defines updates to an item in a gift registry.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ gift_registry_item_uid - ID! + The unique ID of a giftRegistryItem object.
+ note - String + The updated description of the item.
+ quantity - Float! + The updated quantity of the gift registry item.
+
+
+
+
+
Example
+ 
{
+  "gift_registry_item_uid": "4",
+  "note": "xyz789",
+  "quantity": 123.45
+}
+
+
+
+
+
+
+
+ Types +
+

UpdateGiftRegistryItemsOutput

+
+
+
+
Description
+

Contains the results of a request to update gift registry items.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
gift_registry - GiftRegistry + The gift registry after updating updating items.
+
+
+
+
+
Example
+ 
{"gift_registry": GiftRegistry}
+
+
+
+
+
+
+
+ Types +
+

UpdateGiftRegistryOutput

+
+
+
+
Description
+

Contains the results of a request to update a gift registry.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
gift_registry - GiftRegistry + The updated gift registry.
+
+
+
+
+
Example
+ 
{"gift_registry": GiftRegistry}
+
+
+
+
+
+
+
+ Types +
+

UpdateGiftRegistryRegistrantInput

+
+
+
+
Description
+

Defines updates to an existing registrant.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ dynamic_attributes - [GiftRegistryDynamicAttributeInput] + As a result of the update, only the values of provided attributes will be affected. If the attribute is missing in the request, its value will not be changed.
+ email - String + The updated email address of the registrant.
+ firstname - String + The updated first name of the registrant.
+ gift_registry_registrant_uid - ID! + The unique ID of a giftRegistryRegistrant object.
+ lastname - String + The updated last name of the registrant.
+
+
+
+
+
Example
+ 
{
+  "dynamic_attributes": [
+    GiftRegistryDynamicAttributeInput
+  ],
+  "email": "abc123",
+  "firstname": "xyz789",
+  "gift_registry_registrant_uid": "4",
+  "lastname": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

UpdateGiftRegistryRegistrantsOutput

+
+
+
+
Description
+

Contains the results a request to update registrants.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
gift_registry - GiftRegistry + The gift registry after updating registrants.
+
+
+
+
+
Example
+ 
{"gift_registry": GiftRegistry}
+
+
+
+
+
+
+
+ Types +
+

UpdateNegotiableQuoteItemsQuantityOutput

+
+
+
+
Description
+

Contains the updated negotiable quote.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
quote - NegotiableQuote + The updated negotiable quote.
+
+
+
+
+
Example
+ 
{"quote": NegotiableQuote}
+
+
+
+
+
+
+
+ Types +
+

UpdateNegotiableQuoteQuantitiesInput

+
+
+
+
Description
+

Specifies the items to update.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ items - [NegotiableQuoteItemQuantityInput]! + An array of items to update.
+ quote_uid - ID! + The unique ID of a NegotiableQuote object.
+
+
+
+
+
Example
+ 
{
+  "items": [NegotiableQuoteItemQuantityInput],
+  "quote_uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

UpdateNegotiableQuoteTemplateItemsQuantityOutput

+
+
+
+
Description
+

Contains the updated negotiable quote template.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
quote_template - NegotiableQuoteTemplate + The updated negotiable quote template.
+
+
+
+
+
Example
+ 
{"quote_template": NegotiableQuoteTemplate}
+
+
+
+
+
+
+
+ Types +
+

UpdateNegotiableQuoteTemplateQuantitiesInput

+
+
+
+
Description
+

Specifies the items to update.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ items - [NegotiableQuoteTemplateItemQuantityInput]! + An array of items to update.
+ template_id - ID! + The unique ID of a NegotiableQuoteTemplate object.
+
+
+
+
+
Example
+ 
{
+  "items": [NegotiableQuoteTemplateItemQuantityInput],
+  "template_id": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

UpdateProductsInWishlistOutput

+
+
+
+
Description
+

Contains the customer's wish list and any errors encountered.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
user_errors - [WishListUserInputError]! + An array of errors encountered while updating products in a wish list.
wishlist - Wishlist! + Contains the wish list with all items that were successfully updated.
+
+
+
+
+
Example
+ 
{
+  "user_errors": [WishListUserInputError],
+  "wishlist": Wishlist
+}
+
+
+
+
+
+
+
+ Types +
+

UpdatePurchaseOrderApprovalRuleInput

+
+
+
+
Description
+

Defines the changes to be made to an approval rule.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ applies_to - [ID] + An updated list of company user role IDs to which this purchase order approval rule should be applied. When an empty array is provided, the rule is applied to all user roles in the system, including those created in the future.
+ approvers - [ID] + An updated list of B2B user roles that can approve this purchase order approval rule.
+ condition - CreatePurchaseOrderApprovalRuleConditionInput + The updated condition of the purchase order approval rule.
+ description - String + The updated approval rule description.
+ name - String + The updated approval rule name.
+ status - PurchaseOrderApprovalRuleStatus + The updated status of the purchase order approval rule.
+ uid - ID! + Unique identifier for the purchase order approval rule.
+
+
+
+
+
Example
+ 
{
+  "applies_to": ["4"],
+  "approvers": [4],
+  "condition": CreatePurchaseOrderApprovalRuleConditionInput,
+  "description": "xyz789",
+  "name": "abc123",
+  "status": "ENABLED",
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

UpdateRequisitionListInput

+
+
+
+
Description
+

An input object that defines which requistion list characteristics to update.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ description - String + The updated description of the requisition list.
+ name - String! + The new name of the requisition list.
+
+
+
+
+
Example
+ 
{
+  "description": "abc123",
+  "name": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

UpdateRequisitionListItemsInput

+
+
+
+
Description
+

Defines which items in a requisition list to update.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ entered_options - [EnteredOptionInput] + An array of customer-entered options.
+ item_id - ID! + The ID of the requisition list item to update.
+ quantity - Float + The new quantity of the item.
+ selected_options - [String] + An array of selected option IDs.
+
+
+
+
+
Example
+ 
{
+  "entered_options": [EnteredOptionInput],
+  "item_id": "4",
+  "quantity": 987.65,
+  "selected_options": ["xyz789"]
+}
+
+
+
+
+
+
+
+ Types +
+

UpdateRequisitionListItemsOutput

+
+
+
+
Description
+

Output of the request to update items in the specified requisition list.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
requisition_list - RequisitionList + The requisition list after updating items.
+
+
+
+
+
Example
+ 
{"requisition_list": RequisitionList}
+
+
+
+
+
+
+
+ Types +
+

UpdateRequisitionListOutput

+
+
+
+
Description
+

Output of the request to rename the requisition list.

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
requisition_list - RequisitionList + The renamed requisition list.
+
+
+
+
+
Example
+ 
{"requisition_list": RequisitionList}
+
+
+
+
+
+
+
+ Types +
+

UpdateWishlistOutput

+
+
+
+
Description
+

Contains the name and visibility of an updated wish list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
name - String! + The wish list name.
uid - ID! + The unique ID of a Wishlist object.
visibility - WishlistVisibilityEnum! + Indicates whether the wish list is public or private.
+
+
+
+
+
Example
+ 
{
+  "name": "xyz789",
+  "uid": 4,
+  "visibility": "PUBLIC"
+}
+
+
+
+
+
+
+
+ Types +
+

UrlRewrite

+
+
+
+
Description
+

Contains URL rewrite details.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
parameters - [HttpQueryParameter] + An array of request parameters.
url - String + The request URL.
+
+
+
+
+
Example
+ 
{
+  "parameters": [HttpQueryParameter],
+  "url": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

UrlRewriteEntityTypeEnum

+
+
+
+
Description
+

This enumeration defines the entity type.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

CMS_PAGE

+ 		+
+

PRODUCT

+ 		+
+

CATEGORY

+ 		+
+
+
+
+
+
Example
+ 
"CMS_PAGE"
+
+
+
+
+
+
+
+ Types +
+

UseInLayeredNavigationOptions

+
+
+
+
Description
+

Defines whether the attribute is filterable in layered navigation.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

NO

+ 		+
+

FILTERABLE_WITH_RESULTS

+ 		+
+

FILTERABLE_NO_RESULT

+ 		+
+
+
+
+
+
Example
+ 
"NO"
+
+
+
+
+
+
+
+ Types +
+

UserCompaniesInput

+
+
+
+
Description
+

Defines the input for returning matching companies the customer is assigned to.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ currentPage - Int + Specifies which page of results to return. The default value is 1.
+ pageSize - Int + Specifies the maximum number of results to return at once. This attribute is optional.
+ sort - [CompaniesSortInput] + Defines the sorting of the results.
+
+
+
+
+
Example
+ 
{
+  "currentPage": 123,
+  "pageSize": 123,
+  "sort": [CompaniesSortInput]
+}
+
+
+
+
+
+
+
+ Types +
+

UserCompaniesOutput

+
+
+
+
Description
+

An object that contains a list of companies customer is assigned to.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
items - [CompanyBasicInfo]! + An array of companies customer is assigned to.
page_info - SearchResultPageInfo! + Provides navigation for the query response.
+
+
+
+
+
Example
+ 
{
+  "items": [CompanyBasicInfo],
+  "page_info": SearchResultPageInfo
+}
+
+
+
+
+
+
+
+ Types +
+

ValidatePurchaseOrderError

+
+
+
+
Description
+

Contains details about a failed validation attempt.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
message - String! + The returned error message.
type - ValidatePurchaseOrderErrorType! + Error type.
+
+
+
+
+
Example
+ 
{"message": "xyz789", "type": "NOT_FOUND"}
+
+
+
+
+
+
+
+ Types +
+

ValidatePurchaseOrderErrorType

+
+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

NOT_FOUND

+ 		+
+

OPERATION_NOT_APPLICABLE

+ 		+
+

COULD_NOT_SAVE

+ 		+
+

NOT_VALID_DATA

+ 		+
+

UNDEFINED

+ 		+
+
+
+
+
+
Example
+ 
"NOT_FOUND"
+
+
+
+
+
+
+
+ Types +
+

ValidatePurchaseOrdersInput

+
+
+
+
Description
+

Defines the purchase orders to be validated.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ purchase_order_uids - [ID]! + An array of the purchase order IDs.
+
+
+
+
+
Example
+ 
{"purchase_order_uids": ["4"]}
+
+
+
+
+
+
+
+ Types +
+

ValidatePurchaseOrdersOutput

+
+
+
+
Description
+

Contains the results of validation attempts.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
errors - [ValidatePurchaseOrderError]! + An array of error messages encountered while performing the operation.
purchase_orders - [PurchaseOrder]! + An array of the purchase orders in the request.
+
+
+
+
+
Example
+ 
{
+  "errors": [ValidatePurchaseOrderError],
+  "purchase_orders": [PurchaseOrder]
+}
+
+
+
+
+
+
+
+ Types +
+

ValidationRule

+
+
+
+
Description
+

Defines a customer attribute validation rule.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
name - ValidationRuleEnum + Validation rule name applied to a customer attribute.
value - String + Validation rule value.
+
+
+
+
+
Example
+ 
{
+  "name": "DATE_RANGE_MAX",
+  "value": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

ValidationRuleEnum

+
+
+
+
Description
+

List of validation rule names applied to a customer attribute.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

DATE_RANGE_MAX

+ 		+
+

DATE_RANGE_MIN

+ 		+
+

FILE_EXTENSIONS

+ 		+
+

INPUT_VALIDATION

+ 		+
+

MAX_TEXT_LENGTH

+ 		+
+

MIN_TEXT_LENGTH

+ 		+
+

MAX_FILE_SIZE

+ 		+
+

MAX_IMAGE_HEIGHT

+ 		+
+

MAX_IMAGE_WIDTH

+ 		+
+
+
+
+
+
Example
+ 
"DATE_RANGE_MAX"
+
+
+
+
+
+
+
+ Types +
+

VaultConfigOutput

+
+
+
+
Description
+

Retrieves the vault configuration

+
+
+
Fields
+ + + + + + + + + + + + + +
Field NameDescription
credit_card - VaultCreditCardConfig + Credit card vault method configuration
+
+
+
+
+
Example
+ 
{"credit_card": VaultCreditCardConfig}
+
+
+
+
+
+
+
+ Types +
+

VaultCreditCardConfig

+
+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
is_vault_enabled - Boolean + Is vault enabled
sdk_params - [SDKParams] + The parameters required to load the Paypal JS SDK
three_ds_mode - ThreeDSMode + 3DS mode
+
+
+
+
+
Example
+ 
{
+  "is_vault_enabled": true,
+  "sdk_params": [SDKParams],
+  "three_ds_mode": "OFF"
+}
+
+
+
+
+
+
+
+ Types +
+

VaultMethodInput

+
+
+
+
Description
+

Vault payment inputs

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ payment_source - String + The payment source for the payment method
+ payments_order_id - String + The payment services order ID
+ paypal_order_id - String + PayPal order ID
+ public_hash - String + The public hash of the token.
+
+
+
+
+
Example
+ 
{
+  "payment_source": "abc123",
+  "payments_order_id": "abc123",
+  "paypal_order_id": "abc123",
+  "public_hash": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

VaultSetupTokenInput

+
+
+
+
Description
+

The payment source information

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ payment_source - PaymentSourceInput! + The payment source information
+
+
+
+
+
Example
+ 
{"payment_source": PaymentSourceInput}
+
+
+
+
+
+
+
+ Types +
+

VaultTokenInput

+
+
+
+
Description
+

Contains required input for payment methods with Vault support.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ public_hash - String! + The public hash of the payment token.
+
+
+
+
+
Example
+ 
{"public_hash": "abc123"}
+
+
+
+
+
+
+
+ Types +
+

VirtualCartItem

+
+
+
+
Description
+

An implementation for virtual product cart items.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
customizable_options - [SelectedCustomizableOption]! + An array containing customizable options the shopper selected.
discount - [Discount] + Contains discount for quote line item.
errors - [CartItemError] + An array of errors encountered while loading the cart item
id - String! + + Use uid instead. +
is_available - Boolean! + True if requested quantity is less than available stock, false otherwise.
max_qty - Float + Line item max qty in quote template
min_qty - Float + Line item min qty in quote template
not_available_message - String + Message to display when the product is not available with this selected option.
note_from_buyer - [ItemNote] + The buyer's quote line item note.
note_from_seller - [ItemNote] + The seller's quote line item note.
prices - CartItemPrices + Contains details about the price of the item, including taxes and discounts.
product - ProductInterface! + Details about an item in the cart.
quantity - Float! + The quantity of this item in the cart.
uid - ID! + The unique ID for a CartItemInterface object.
+
+
+
+
+
Example
+ 
{
+  "customizable_options": [SelectedCustomizableOption],
+  "discount": [Discount],
+  "errors": [CartItemError],
+  "id": "xyz789",
+  "is_available": true,
+  "max_qty": 987.65,
+  "min_qty": 987.65,
+  "not_available_message": "xyz789",
+  "note_from_buyer": [ItemNote],
+  "note_from_seller": [ItemNote],
+  "prices": CartItemPrices,
+  "product": ProductInterface,
+  "quantity": 987.65,
+  "uid": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

VirtualProduct

+
+
+
+
Description
+

Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
activity - String + + Use the custom_attributes field instead. +
attribute_set_id - Int + The attribute set assigned to the product. The field should not be used on the storefront. +
canonical_url - String + The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled.
categories - [CategoryInterface] + The categories assigned to a product.
category_gear - String + + Use the custom_attributes field instead. +
climate - String + + Use the custom_attributes field instead. +
collar - String + + Use the custom_attributes field instead. +
color - Int + + Use the custom_attributes field instead. +
country_of_manufacture - String + The product's country of origin.
created_at - String + Timestamp indicating when the product was created. The field should not be used on the storefront. +
crosssell_products - [ProductInterface] + An array of cross-sell products.
custom_attributesV2 - ProductCustomAttributes + Product custom attributes.
+
+
Arguments
+
+
+
filters - AttributeFilterInput +
+
+
+
+
description - ComplexTextValue + Detailed information about the product. The value can include simple HTML tags.
eco_collection - Int + + Use the custom_attributes field instead. +
erin_recommends - Int + + Use the custom_attributes field instead. +
features_bags - String + + Use the custom_attributes field instead. +
format - Int + + Use the custom_attributes field instead. +
gender - String + + Use the custom_attributes field instead. +
gift_message_available - Boolean! + Returns a value indicating gift message availability for the product.
gift_wrapping_available - Boolean! + Returns a value indicating gift wrapping availability for the product.
gift_wrapping_price - Money + Returns value and currency indicating gift wrapping price for the product.
id - Int + The ID number assigned to the product. Use the uid field instead. +
image - ProductImage + The relative path to the main image on the product page.
is_returnable - String + Indicates whether the product can be returned.
manufacturer - Int + A number representing the product's manufacturer. Use the custom_attributes field instead. +
material - String + + Use the custom_attributes field instead. +
max_sale_qty - Float + Maximum Qty Allowed in Shopping Cart
media_gallery - [MediaGalleryInterface] + An array of media gallery objects.
media_gallery_entries - [MediaGalleryEntry] + An array of MediaGalleryEntry objects. Use media_gallery instead. +
meta_description - String + A brief overview of the product for search results listings, maximum 255 characters.
meta_keyword - String + A comma-separated list of keywords that are visible only to search engines.
meta_title - String + A string that is displayed in the title bar and tab of the browser and in search results lists.
min_sale_qty - Float + Minimum Qty Allowed in Shopping Cart
name - String + The product name. Customers use this name to identify the product.
new - Int + + Use the custom_attributes field instead. +
new_from_date - String + The beginning date for new product listings, and determines if the product is featured as a new product.
new_to_date - String + The end date for new product listings.
only_x_left_in_stock - Float + Product stock only x left count
options - [CustomizableOptionInterface] + An array of options for a customizable product.
options_container - String + If the product has multiple options, determines where they appear on the product page.
pattern - String + + Use the custom_attributes field instead. +
performance_fabric - Int + + Use the custom_attributes field instead. +
price - ProductPrices + Indicates the price of an item. Use price_range for product price information. +
price_range - PriceRange! + The range of prices for the product
price_tiers - [TierPrice] + An array of TierPrice objects.
product_links - [ProductLinksInterface] + An array of ProductLinks objects.
purpose - Int + + Use the custom_attributes field instead. +
quantity - Float + Amount of available stock
rating_summary - Float! + The average of all the ratings given to the product.
redirect_code - Int! + Contains 0 when there is no redirect error. A value of 301 indicates the URL of the requested resource has been changed permanently, while a value of 302 indicates a temporary redirect.
related_products - [ProductInterface] + An array of related products.
relative_url - String + The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original.
review_count - Int! + The total count of all the reviews given to the product.
reviews - ProductReviews! + The list of products reviews.
+
+
Arguments
+
+
+
pageSize - Int +
+

The maximum number of results to return at once. The default is 20.

+
+
+
currentPage - Int +
+

The page of results to return. The default is 1.

+
+
+
+
sale - Int + + Use the custom_attributes field instead. +
short_description - ComplexTextValue + A short description of the product. Its use depends on the theme.
size - Int + + Use the custom_attributes field instead. +
sku - String + A number or code assigned to a product to identify the product, options, price, and manufacturer.
sleeve - String + + Use the custom_attributes field instead. +
small_image - ProductImage + The relative path to the small image, which is used on catalog pages.
special_from_date - String + The beginning date that a product has a special price. The field should not be used on the storefront. +
special_price - Float + The discounted price of the product.
special_to_date - String + The end date for a product with a special price.
staged - Boolean! + Indicates whether the product is staged for a future campaign.
stock_status - ProductStockStatus + Stock status of the product
strap_bags - String + + Use the custom_attributes field instead. +
style_bags - String + + Use the custom_attributes field instead. +
style_bottom - String + + Use the custom_attributes field instead. +
style_general - String + + Use the custom_attributes field instead. +
swatch_image - String + The file name of a swatch image.
thumbnail - ProductImage + The relative path to the product's thumbnail image.
tier_price - Float + The price when tier pricing is in effect and the items purchased threshold has been reached. Use price_tiers for product tier price information. +
tier_prices - [ProductTierPrices] + An array of ProductTierPrices objects. Use price_tiers for product tier price information. +
type - UrlRewriteEntityTypeEnum + One of PRODUCT, CATEGORY, or CMS_PAGE.
type_id - String + One of simple, virtual, bundle, downloadable, grouped, or configurable. Use __typename instead. +
uid - ID! + The unique ID for a ProductInterface object.
updated_at - String + Timestamp indicating when the product was updated. The field should not be used on the storefront. +
upsell_products - [ProductInterface] + An array of up-sell products.
url_key - String + The part of the URL that identifies the product
url_path - String + + Use product's canonical_url or url rewrites instead +
url_rewrites - [UrlRewrite] + URL rewrites list
url_suffix - String + The part of the product URL that is appended after the url key
websites - [Website] + An array of websites in which the product is available. The field should not be used on the storefront. +
+
+
+
+
+
Example
+ 
{
+  "activity": "abc123",
+  "attribute_set_id": 987,
+  "canonical_url": "abc123",
+  "categories": [CategoryInterface],
+  "category_gear": "xyz789",
+  "climate": "abc123",
+  "collar": "xyz789",
+  "color": 987,
+  "country_of_manufacture": "abc123",
+  "created_at": "xyz789",
+  "crosssell_products": [ProductInterface],
+  "custom_attributesV2": ProductCustomAttributes,
+  "description": ComplexTextValue,
+  "eco_collection": 123,
+  "erin_recommends": 987,
+  "features_bags": "xyz789",
+  "format": 987,
+  "gender": "abc123",
+  "gift_message_available": false,
+  "gift_wrapping_available": false,
+  "gift_wrapping_price": Money,
+  "id": 123,
+  "image": ProductImage,
+  "is_returnable": "abc123",
+  "manufacturer": 987,
+  "material": "abc123",
+  "max_sale_qty": 987.65,
+  "media_gallery": [MediaGalleryInterface],
+  "media_gallery_entries": [MediaGalleryEntry],
+  "meta_description": "xyz789",
+  "meta_keyword": "abc123",
+  "meta_title": "xyz789",
+  "min_sale_qty": 987.65,
+  "name": "xyz789",
+  "new": 987,
+  "new_from_date": "abc123",
+  "new_to_date": "abc123",
+  "only_x_left_in_stock": 123.45,
+  "options": [CustomizableOptionInterface],
+  "options_container": "xyz789",
+  "pattern": "abc123",
+  "performance_fabric": 987,
+  "price": ProductPrices,
+  "price_range": PriceRange,
+  "price_tiers": [TierPrice],
+  "product_links": [ProductLinksInterface],
+  "purpose": 987,
+  "quantity": 123.45,
+  "rating_summary": 987.65,
+  "redirect_code": 987,
+  "related_products": [ProductInterface],
+  "relative_url": "abc123",
+  "review_count": 123,
+  "reviews": ProductReviews,
+  "sale": 987,
+  "short_description": ComplexTextValue,
+  "size": 123,
+  "sku": "xyz789",
+  "sleeve": "xyz789",
+  "small_image": ProductImage,
+  "special_from_date": "xyz789",
+  "special_price": 987.65,
+  "special_to_date": "abc123",
+  "staged": true,
+  "stock_status": "IN_STOCK",
+  "strap_bags": "abc123",
+  "style_bags": "xyz789",
+  "style_bottom": "xyz789",
+  "style_general": "abc123",
+  "swatch_image": "abc123",
+  "thumbnail": ProductImage,
+  "tier_price": 987.65,
+  "tier_prices": [ProductTierPrices],
+  "type": "CMS_PAGE",
+  "type_id": "xyz789",
+  "uid": 4,
+  "updated_at": "abc123",
+  "upsell_products": [ProductInterface],
+  "url_key": "xyz789",
+  "url_path": "xyz789",
+  "url_rewrites": [UrlRewrite],
+  "url_suffix": "abc123",
+  "websites": [Website]
+}
+
+
+
+
+
+
+
+ Types +
+

VirtualProductCartItemInput

+
+
+
+
Description
+

Defines a single product to add to the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ customizable_options - [CustomizableOptionInput] + An array that defines customizable options for the product.
+ data - CartItemInput! + An object containing the sku, quantity, and other relevant information about the product.
+
+
+
+
+
Example
+ 
{
+  "customizable_options": [CustomizableOptionInput],
+  "data": CartItemInput
+}
+
+
+
+
+
+
+
+ Types +
+

VirtualRequisitionListItem

+
+
+
+
Description
+

Contains details about virtual products added to a requisition list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
customizable_options - [SelectedCustomizableOption]! + Selected custom options for an item in the requisition list.
product - ProductInterface! + Details about a requisition list item.
quantity - Float! + The amount added.
uid - ID! + The unique ID for the requisition list item.
+
+
+
+
+
Example
+ 
{
+  "customizable_options": [SelectedCustomizableOption],
+  "product": ProductInterface,
+  "quantity": 123.45,
+  "uid": 4
+}
+
+
+
+
+
+
+
+ Types +
+

VirtualWishlistItem

+
+
+
+
Description
+

Contains a virtual product wish list item.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
added_at - String! + The date and time the item was added to the wish list.
customizable_options - [SelectedCustomizableOption]! + Custom options selected for the wish list item.
description - String + The description of the item.
id - ID! + The unique ID for a WishlistItemInterface object.
product - ProductInterface + Product details of the wish list item.
quantity - Float! + The quantity of this wish list item.
+
+
+
+
+
Example
+ 
{
+  "added_at": "abc123",
+  "customizable_options": [SelectedCustomizableOption],
+  "description": "abc123",
+  "id": "4",
+  "product": ProductInterface,
+  "quantity": 987.65
+}
+
+
+
+
+
+
+
+ Types +
+

Website

+
+
+
+
Description
+

Deprecated. It should not be used on the storefront. Contains information about a website.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
code - String + A code assigned to the website to identify it. The field should not be used on the storefront. +
default_group_id - String + The default group ID of the website. The field should not be used on the storefront. +
id - Int + The ID number assigned to the website. The field should not be used on the storefront. +
is_default - Boolean + Indicates whether this is the default website. The field should not be used on the storefront. +
name - String + The website name. Websites use this name to identify it easier. The field should not be used on the storefront. +
sort_order - Int + The attribute to use for sorting websites. The field should not be used on the storefront. +
+
+
+
+
+
Example
+ 
{
+  "code": "abc123",
+  "default_group_id": "xyz789",
+  "id": 123,
+  "is_default": true,
+  "name": "xyz789",
+  "sort_order": 123
+}
+
+
+
+
+
+
+
+ Types +
+

WishListUserInputError

+
+
+
+
Description
+

An error encountered while performing operations with WishList.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
code - WishListUserInputErrorType! + A wish list-specific error code.
message - String! + A localized error message.
+
+
+
+
+
Example
+ 
{
+  "code": "PRODUCT_NOT_FOUND",
+  "message": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

WishListUserInputErrorType

+
+
+
+
Description
+

A list of possible error types.

+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

PRODUCT_NOT_FOUND

+ 		+
+

UNDEFINED

+ 		+
+
+
+
+
+
Example
+ 
"PRODUCT_NOT_FOUND"
+
+
+
+
+
+
+
+ Types +
+

Wishlist

+
+
+
+
Description
+

Contains a customer wish list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
id - ID + The unique ID for a Wishlist object.
items - [WishlistItem] + + Use the items_v2 field instead. +
items_count - Int + The number of items in the wish list.
items_v2 - WishlistItems + An array of items in the customer's wish list.
+
+
Arguments
+
+
+
currentPage - Int +
+
+
+
pageSize - Int +
+
+
+
+
name - String + The name of the wish list.
sharing_code - String + An encrypted code that Magento uses to link to the wish list.
updated_at - String + The time of the last modification to the wish list.
visibility - WishlistVisibilityEnum! + Indicates whether the wish list is public or private.
+
+
+
+
+
Example
+ 
{
+  "id": "4",
+  "items": [WishlistItem],
+  "items_count": 987,
+  "items_v2": WishlistItems,
+  "name": "xyz789",
+  "sharing_code": "abc123",
+  "updated_at": "xyz789",
+  "visibility": "PUBLIC"
+}
+
+
+
+
+
+
+
+ Types +
+

WishlistCartUserInputError

+
+
+
+
Description
+

Contains details about errors encountered when a customer added wish list items to the cart.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
code - WishlistCartUserInputErrorType! + An error code that describes the error encountered.
message - String! + A localized error message.
wishlistId - ID! + The unique ID of the Wishlist object containing an error.
wishlistItemId - ID! + The unique ID of the wish list item containing an error.
+
+
+
+
+
Example
+ 
{
+  "code": "PRODUCT_NOT_FOUND",
+  "message": "xyz789",
+  "wishlistId": 4,
+  "wishlistItemId": 4
+}
+
+
+
+
+
+
+
+ Types +
+

WishlistCartUserInputErrorType

+
+
+
+
Description
+

A list of possible error types.

+
+
+
Values
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

PRODUCT_NOT_FOUND

+ 		+
+

REQUIRED_PARAMETER_MISSING

+ 		+
+

NOT_SALABLE

+ 		+
+

INSUFFICIENT_STOCK

+ 		+
+

UNDEFINED

+ 		+
+
+
+
+
+
Example
+ 
"PRODUCT_NOT_FOUND"
+
+
+
+
+
+
+
+ Types +
+

WishlistItem

+
+
+
+
Description
+

Contains details about a wish list item.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
added_at - String + The time when the customer added the item to the wish list.
description - String + The customer's comment about this item.
id - Int + The unique ID for a WishlistItem object.
product - ProductInterface + Details about the wish list item.
qty - Float + The quantity of this wish list item
+
+
+
+
+
Example
+ 
{
+  "added_at": "xyz789",
+  "description": "xyz789",
+  "id": 123,
+  "product": ProductInterface,
+  "qty": 987.65
+}
+
+
+
+
+
+
+
+ Types +
+

WishlistItemCopyInput

+
+
+
+
Description
+

Specifies the IDs of items to copy and their quantities.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ quantity - Float + The quantity of this item to copy to the destination wish list. This value can't be greater than the quantity in the source wish list.
+ wishlist_item_id - ID! + The unique ID of the WishlistItemInterface object to be copied.
+
+
+
+
+
Example
+ 
{
+  "quantity": 987.65,
+  "wishlist_item_id": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

WishlistItemInput

+
+
+
+
Description
+

Defines the items to add to a wish list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ entered_options - [EnteredOptionInput] + An array of options that the customer entered.
+ parent_sku - String + For complex product types, the SKU of the parent product.
+ quantity - Float! + The amount or number of items to add.
+ selected_options - [ID] + An array of strings corresponding to options the customer selected.
+ sku - String! + The SKU of the product to add. For complex product types, specify the child product SKU.
+
+
+
+
+
Example
+ 
{
+  "entered_options": [EnteredOptionInput],
+  "parent_sku": "abc123",
+  "quantity": 123.45,
+  "selected_options": [4],
+  "sku": "abc123"
+}
+
+
+
+
+
+
+
+ Types +
+

WishlistItemInterface

+
+
+
+
Description
+

The interface for wish list items.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
added_at - String! + The date and time the item was added to the wish list.
customizable_options - [SelectedCustomizableOption]! + Custom options selected for the wish list item.
description - String + The description of the item.
id - ID! + The unique ID for a WishlistItemInterface object.
product - ProductInterface + Product details of the wish list item.
quantity - Float! + The quantity of this wish list item.
+
+
+
Possible Types
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
WishlistItemInterface Types
+

SimpleWishlistItem

+
+

VirtualWishlistItem

+
+

ConfigurableWishlistItem

+
+

DownloadableWishlistItem

+
+

BundleWishlistItem

+
+

GiftCardWishlistItem

+
+

GroupedProductWishlistItem

+
+
+
+
+
+
Example
+ 
{
+  "added_at": "xyz789",
+  "customizable_options": [SelectedCustomizableOption],
+  "description": "abc123",
+  "id": 4,
+  "product": ProductInterface,
+  "quantity": 987.65
+}
+
+
+
+
+
+
+
+ Types +
+

WishlistItemMoveInput

+
+
+
+
Description
+

Specifies the IDs of the items to move and their quantities.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Input FieldDescription
+ quantity - Float + The quantity of this item to move to the destination wish list. This value can't be greater than the quantity in the source wish list.
+ wishlist_item_id - ID! + The unique ID of the WishlistItemInterface object to be moved.
+
+
+
+
+
Example
+ 
{"quantity": 123.45, "wishlist_item_id": 4}
+
+
+
+
+
+
+
+ Types +
+

WishlistItemUpdateInput

+
+
+
+
Description
+

Defines updates to items in a wish list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Input FieldDescription
+ description - String + Customer-entered comments about the item.
+ entered_options - [EnteredOptionInput] + An array of options that the customer entered.
+ quantity - Float + The new amount or number of this item.
+ selected_options - [ID] + An array of strings corresponding to options the customer selected.
+ wishlist_item_id - ID! + The unique ID for a WishlistItemInterface object.
+
+
+
+
+
Example
+ 
{
+  "description": "abc123",
+  "entered_options": [EnteredOptionInput],
+  "quantity": 987.65,
+  "selected_options": ["4"],
+  "wishlist_item_id": "4"
+}
+
+
+
+
+
+
+
+ Types +
+

WishlistItems

+
+
+
+
Description
+

Contains an array of items in a wish list.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + +
Field NameDescription
items - [WishlistItemInterface]! + A list of items in the wish list.
page_info - SearchResultPageInfo + Contains pagination metadata.
+
+
+
+
+
Example
+ 
{
+  "items": [WishlistItemInterface],
+  "page_info": SearchResultPageInfo
+}
+
+
+
+
+
+
+
+ Types +
+

WishlistOutput

+
+
+
+
Description
+

Deprecated: Use the Wishlist type instead.

+
+
+
Fields
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field NameDescription
items - [WishlistItem] + An array of items in the customer's wish list Use the Wishlist.items field instead. +
items_count - Int + The number of items in the wish list. Use the Wishlist.items_count field instead. +
name - String + When multiple wish lists are enabled, the name the customer assigns to the wishlist. This field is related to Commerce functionality and is always null in Open Source. +
sharing_code - String + An encrypted code that links to the wish list. Use the Wishlist.sharing_code field instead. +
updated_at - String + The time of the last modification to the wish list. Use the Wishlist.updated_at field instead. +
+
+
+
+
+
Example
+ 
{
+  "items": [WishlistItem],
+  "items_count": 987,
+  "name": "xyz789",
+  "sharing_code": "abc123",
+  "updated_at": "xyz789"
+}
+
+
+
+
+
+
+
+ Types +
+

WishlistVisibilityEnum

+
+
+
+
Description
+

Defines the wish list visibility types.

+
+
+
Values
+ + + + + + + + + + + + + + + + + +
Enum ValueDescription
+

PUBLIC

+ 		+
+

PRIVATE

+ 		+
+
+
+
+
+
Example
+ 
"PUBLIC"
+
+
+
+
+
+
+
+ Types +
+

createEmptyCartInput

+
+
+
+
Description
+

Assigns a specific cart_id to the empty cart.

+
+
+
Fields
+ + + + + + + + + + + + + +
Input FieldDescription
+ cart_id - String + The ID to assign to the cart.
+
+
+
+
+
Example
+ 
{"cart_id": "xyz789"}
+
+
+
+
+
+
+
+ Documentation by Anvil SpectaQL +
+
+
+
+
+
+ + \ No newline at end of file diff --git a/static/graphql-api/2.4.9-beta-1/javascripts/spectaql.min.js b/static/graphql-api/2.4.9-beta-1/javascripts/spectaql.min.js new file mode 100644 index 000000000..6ef3202c2 --- /dev/null +++ b/static/graphql-api/2.4.9-beta-1/javascripts/spectaql.min.js @@ -0,0 +1 @@ +function scrollSpy(){var l=5,e=document.querySelector("html"),c=(e&&(e=window.getComputedStyle(e).scrollPaddingTop)&&"string"==typeof e&&"auto"!==e&&e.endsWith("px")&&(l+=parseInt(e.split("px")[0])),"nav-scroll-active"),i=null,d=[];function t(){i=null;var e=document.querySelectorAll("[data-traverse-target]");Array.prototype.forEach.call(e,function(e){d.push({id:e.id,top:e.offsetTop})})}var n=debounce(function(){t(),o()},500),o=debounce(function(){var e,t,n,o,r=(e=>{for(var t=e+l,n=0;n=d[n].top&&(!o||t{toggleMenu(),scrollSpy()}); \ No newline at end of file diff --git a/static/graphql-api/2.4.9-beta-1/stylesheets/spectaql.min.css b/static/graphql-api/2.4.9-beta-1/stylesheets/spectaql.min.css new file mode 100644 index 000000000..5859df82f --- /dev/null +++ b/static/graphql-api/2.4.9-beta-1/stylesheets/spectaql.min.css @@ -0,0 +1 @@ +#spectaql{padding:0;margin:0}#spectaql pre{overflow:auto;margin-top:0;margin-bottom:20px}#spectaql pre code{display:block;background:#ccc}#spectaql table{width:100%;table-layout:fixed;text-align:left;border-collapse:collapse}#spectaql table td,#spectaql table th{margin:0;padding:0}#spectaql #introduction .example-section>*,#spectaql .definition-heading,#spectaql .doc-heading,#spectaql .introduction-item-title,#spectaql .operation-heading{overflow:hidden;text-overflow:ellipsis}#spectaql #page{display:flex}#spectaql #page *{box-sizing:border-box}#spectaql #page.drawer-open #sidebar{z-index:1000;transform:translateX(0)}#spectaql #page.drawer-open .drawer-overlay{display:block;background:rgba(0,0,0,.5);z-index:10}#spectaql #sidebar{position:fixed;min-width:250px;max-width:250px;flex-shrink:0;transition:transform .2s ease-out;transform:translateX(-100%);z-index:10;padding-top:20px;background:#fff}@media (min-width:48em){#spectaql #sidebar{position:relative;transform:none}}@media (min-width:64em){#spectaql #sidebar{min-width:300px;max-width:300px}}#spectaql .sidebar-top-container{display:flex;align-items:center;padding:0 20px}#spectaql #mobile-navbar{display:flex;align-items:center;position:sticky;top:0}@media (min-width:48em){#spectaql #mobile-navbar{display:none}}#spectaql .sidebar-open-button{display:flex;align-items:flex-start;margin:0;padding:0;border:none;background:0 0}#spectaql .sidebar-open-button .hamburger{width:16px;height:14px;cursor:pointer}#spectaql .sidebar-open-button .hamburger::after{display:block;content:"";height:2px;background:#222;box-shadow:0 5px 0 #222,0 10px 0 #222}#spectaql .sidebar-open-button .sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border:0}#spectaql .close-button{display:block}#spectaql .close-button .sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border:0}@media (min-width:48em){#spectaql .close-button{display:none}}#spectaql .drawer-overlay{display:none;position:absolute;top:0;left:0;bottom:0;right:0;background:rgba(0,0,0,0)}@media (min-width:48em){#spectaql .drawer-overlay{display:none!important}}#spectaql #nav{display:flex;flex-direction:column;max-height:calc(100vh - 0px);padding:0 20px;padding-bottom:20px;position:sticky;top:0;overflow:auto}#spectaql #logo{margin-right:auto}#spectaql #logo img{display:block;width:100%;max-width:100%}#spectaql .nav-group-items,#spectaql .nav-group-section-items{padding:0;margin:0}#spectaql .nav-group-items>li,#spectaql .nav-group-section-items>li{list-style:none}#spectaql .nav-group-items .nav-group-section-title,#spectaql .nav-group-items>li,#spectaql .nav-group-section-items .nav-group-section-title,#spectaql .nav-group-section-items>li{overflow:hidden;text-overflow:ellipsis}#spectaql .nav-group-section-items{display:none}#spectaql .nav-scroll-expand .nav-group-section-items{display:block}#spectaql #docs{position:relative;margin:0 auto;min-width:100px;max-width:88em;flex-grow:1;flex-shrink:1;padding:20px}@media (min-width:48em){#spectaql .doc-row{display:flex;flex-wrap:wrap}}#spectaql .doc-row .doc-copy,#spectaql .doc-row .doc-examples{width:100%}@media (min-width:48em){#spectaql .doc-row .doc-copy,#spectaql .doc-row .doc-examples{width:50%}}@media (min-width:48em){#spectaql .doc-row .doc-copy{padding-right:20px}}@media (min-width:48em){#spectaql .doc-row .doc-examples{padding-left:20px}}.hljs{display:block;overflow-x:auto;padding:.5em;background:#23241f}.hljs,.hljs-subst,.hljs-tag{color:#f8f8f2}.hljs-emphasis,.hljs-strong{color:#a8a8a2}.hljs-bullet,.hljs-link,.hljs-literal,.hljs-number,.hljs-quote,.hljs-regexp{color:#ae81ff}.hljs-code,.hljs-section,.hljs-selector-class,.hljs-title{color:#a6e22e}.hljs-strong{font-weight:700}.hljs-emphasis{font-style:italic}.hljs-attr,.hljs-keyword,.hljs-name,.hljs-selector-tag{color:#f92672}.hljs-attribute,.hljs-symbol{color:#66d9ef}.hljs-class .hljs-title,.hljs-params{color:#f8f8f2}.hljs-addition,.hljs-built_in,.hljs-builtin-name,.hljs-selector-attr,.hljs-selector-id,.hljs-selector-pseudo,.hljs-string,.hljs-template-variable,.hljs-type,.hljs-variable{color:#e6db74}.hljs-comment,.hljs-deletion,.hljs-meta{color:#75715e}#spectaql{font-family:-apple-system,BlinkMacSystemFont,system-ui,"Segoe UI",Roboto,Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";font-size:14px;line-height:1.6;background:#fff;color:#222}@media (min-width:32em){#spectaql{font-size:16px}}#spectaql a{color:#0298bf;text-decoration:none}#spectaql a:hover{color:#0182a2}#spectaql a:active,#spectaql a:focus{color:#0298bf}#spectaql code{font-size:.875em;font-family:Consolas,Monaco,Andale Mono,Ubuntu Mono,monospace}#spectaql pre{color:#fff}#spectaql pre code{background:#222}#spectaql pre code,#spectaql pre code.hljs{font-size:.82em;line-height:1.4;padding:15px 20px}#spectaql .doc-heading{line-height:1.2;font-size:2.25em;margin-top:10px}@media (min-width:48em){#spectaql .doc-heading{margin-top:-10px}}#spectaql .close-button{background:0 0;border:none;padding:5px;font-size:16px;font-weight:700;color:#222}#spectaql #introduction{margin-bottom:60px}#spectaql #introduction .example-section:not(.example-section-is-code){margin-bottom:20px}#spectaql #introduction .example-section:not(.example-section-is-code) h5,#spectaql #introduction .example-section:not(.example-section-is-code) p{margin:0;font-size:1em}#spectaql #docs,#spectaql #mobile-navbar,#spectaql #sidebar{padding-top:20px;padding-bottom:20px}@media (min-width:32em){#spectaql #docs,#spectaql #mobile-navbar,#spectaql #sidebar{padding-top:30px;padding-bottom:30px}}@media (min-width:48em){#spectaql #docs,#spectaql #mobile-navbar,#spectaql #sidebar{padding-top:40px;padding-bottom:40px}}#spectaql #docs,#spectaql #mobile-navbar,#spectaql #nav,#spectaql .sidebar-top-container{padding-left:20px;padding-right:20px}@media (min-width:32em){#spectaql #docs,#spectaql #mobile-navbar,#spectaql #nav,#spectaql .sidebar-top-container{padding-left:30px;padding-right:30px}}@media (min-width:48em){#spectaql #docs,#spectaql #mobile-navbar,#spectaql #nav,#spectaql .sidebar-top-container{padding-left:50px;padding-right:50px}}#spectaql #sidebar{padding-bottom:0;background:#fff}#spectaql #sidebar a{color:#222}#spectaql #sidebar a.nav-scroll-active,#spectaql #sidebar a:hover{font-weight:700}#spectaql #sidebar a.nav-scroll-active{color:#222}#spectaql #sidebar a:hover{color:#0182a2}@media (min-width:48em){#spectaql #sidebar{border-right:2px solid #d8d8d8}}#spectaql #mobile-navbar{background:#fff;margin-top:-20px;margin-left:-20px;margin-right:-20px}@media (min-width:32em){#spectaql #mobile-navbar{margin-top:-30px;margin-left:-30px;margin-right:-30px}}#spectaql #mobile-navbar .sidebar-open-button::after{display:block;content:"All Topics";margin-left:10px;color:#222}#spectaql #nav .nav-group{margin-top:20px}#spectaql #nav .nav-group li{margin-bottom:5px}#spectaql #nav .nav-group-title{font-size:.875em;font-weight:400;margin:0 0 6px 0;color:#999}#spectaql #nav .nav-group-section-title{font-size:inherit;margin:0;margin-bottom:5px;font-weight:400}#spectaql #nav .nav-group-section-items{margin-left:.75em}#spectaql .definition,#spectaql .operation{margin-bottom:60px}#spectaql .definition .definition-heading,#spectaql .definition .operation-heading,#spectaql .operation .definition-heading,#spectaql .operation .operation-heading{font-size:1.72em}#spectaql .definition .definition-heading code,#spectaql .definition .operation-heading code,#spectaql .operation .definition-heading code,#spectaql .operation .operation-heading code{font-family:inherit;font-size:inherit;font-weight:inherit}@media (min-width:32em){#spectaql .definition .definition-heading,#spectaql .definition .operation-heading,#spectaql .operation .definition-heading,#spectaql .operation .operation-heading{font-size:2.25em}}#spectaql .definition-group-name,#spectaql .group-heading,#spectaql .operation-group-name{border-top:2px solid #d8d8d8;padding-top:3px;color:#999;font-size:inherit;font-weight:inherit}#spectaql .definition-group-name a,#spectaql .group-heading a,#spectaql .operation-group-name a{color:#999}#spectaql .definition-group-name a:hover,#spectaql .group-heading a:hover,#spectaql .operation-group-name a:hover{font-weight:700}#spectaql .doc-examples{margin-top:20px}#spectaql .doc-examples .example-heading{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border:0}#spectaql .doc-examples .example-section-is-code h5{color:#999;text-transform:uppercase;background:#000;font-size:.75em;font-weight:700;padding:.6em 0 .6em 20px;margin:0;opacity:1}@media (min-width:48em){#spectaql .doc-examples{margin-top:0}}#spectaql .doc-copy p{margin:0 0 20px 0}#spectaql .doc-copy p:last-child{margin-bottom:0}#spectaql .doc-copy table tr th{font-weight:400;border-bottom:2px solid #d8d8d8}#spectaql .doc-copy table tr td{border-bottom:1px solid #e0e0e0}#spectaql .doc-copy table tr.row-has-field-arguments td,#spectaql .doc-copy table tr:last-child td{border-bottom:none}#spectaql .doc-copy table tr td,#spectaql .doc-copy table tr th{padding:5px}#spectaql .doc-copy table tr td:first-child,#spectaql .doc-copy table tr th:first-child{padding-left:0}#spectaql .doc-copy table tr td:last-child,#spectaql .doc-copy table tr th:last-child{padding-right:0}#spectaql .doc-copy .doc-copy-section{margin-bottom:30px}#spectaql .doc-copy .doc-copy-section>h5{margin:0 0 5px 0;font-size:inherit;font-weight:inherit;color:#999}#spectaql .doc-copy .definition-description>h5,#spectaql .doc-copy .definition-properties>h5,#spectaql .doc-copy .operation-description>h5{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border:0}#spectaql .field-arguments{font-size:.875em;background-color:#fafbfc;border:1px solid #e0e0e0;padding:10px;margin-bottom:5px}#spectaql .field-arguments p{margin:10px 0 0 0}#spectaql .field-arguments h5.field-arguments-heading{margin:0;padding:0 0 10px 0;font-weight:inherit;color:#999}#spectaql .field-arguments .field-argument{border-top:1px #e0e0e0 solid;padding:10px 0}#spectaql .field-arguments .field-argument:last-child{padding-bottom:0}#spectaql .field-arguments .field-argument-name{margin:0;font-size:inherit;font-weight:inherit}#spectaql .deprecation-reason{word-break:break-word}#spectaql .deprecation-reason::before{display:inline;content:"Deprecated";padding:2px 5px;margin-right:5px;background:#fed7d8;color:#c60609;font-weight:700;font-size:.875em} \ No newline at end of file diff --git a/static/graphql-api/index.html b/static/graphql-api/index.html index c1f13b2fd..a284d836c 100644 --- a/static/graphql-api/index.html +++ b/static/graphql-api/index.html @@ -6,7 +6,7 @@ GraphQL API - +
@@ -27,7 +27,6 @@

Introduction

@@ -1112,13 +1111,12 @@

Adobe Commerce GraphQL API

-
API Endpoints
+
API Endpoint
https://<your store>/graphql
-
+
Headers
- 
# Your API token from the dashboard. Must be included in all API calls.
-Authorization: Bearer <YOUR_TOKEN_HERE>
+
For header information, refer to GraphQL headers.
Version
@@ -1171,9 +1169,7 @@
Arguments

Example

Query
- - - 
query attributesForm($formCode: String!) {
+                  
query attributesForm($formCode: String!) {
   attributesForm(formCode: $formCode) {
     errors {
       ...AttributeMetadataErrorFragment
@@ -1184,23 +1180,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"formCode": "abc123"}
+                  
{"formCode": "xyz789"}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "attributesForm": {
       "errors": [AttributeMetadataError],
@@ -1209,8 +1197,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -1268,9 +1254,7 @@
Arguments

Example

Query
- - - 
query attributesList(
+                  
query attributesList(
   $entityType: AttributeEntityTypeEnum!,
   $filters: AttributeFilterInput
 ) {
@@ -1287,26 +1271,18 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
+                  
{
   "entityType": "CATALOG_PRODUCT",
   "filters": AttributeFilterInput
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "attributesList": {
       "errors": [AttributeMetadataError],
@@ -1315,8 +1291,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -1368,9 +1342,7 @@
Arguments

Example

Query
- - - 
query availableStores($useCurrentGroup: Boolean) {
+                  
query availableStores($useCurrentGroup: Boolean) {
   availableStores(useCurrentGroup: $useCurrentGroup) {
     absolute_footer
     allow_gift_receipt
@@ -1624,278 +1596,268 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"useCurrentGroup": true}
+                  
{"useCurrentGroup": false}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "availableStores": [
       {
         "absolute_footer": "abc123",
-        "allow_gift_receipt": "abc123",
+        "allow_gift_receipt": "xyz789",
         "allow_gift_wrapping_on_order": "xyz789",
-        "allow_gift_wrapping_on_order_items": "abc123",
-        "allow_guests_to_write_product_reviews": "abc123",
+        "allow_gift_wrapping_on_order_items": "xyz789",
+        "allow_guests_to_write_product_reviews": "xyz789",
         "allow_items": "abc123",
         "allow_order": "xyz789",
         "allow_printed_card": "abc123",
         "autocomplete_on_storefront": true,
         "base_currency_code": "abc123",
         "base_link_url": "abc123",
-        "base_media_url": "abc123",
-        "base_static_url": "abc123",
-        "base_url": "abc123",
+        "base_media_url": "xyz789",
+        "base_static_url": "xyz789",
+        "base_url": "xyz789",
         "braintree_3dsecure_allowspecific": true,
         "braintree_3dsecure_always_request_3ds": false,
         "braintree_3dsecure_specificcountry": "xyz789",
-        "braintree_3dsecure_threshold_amount": "abc123",
+        "braintree_3dsecure_threshold_amount": "xyz789",
         "braintree_3dsecure_verify_3dsecure": false,
         "braintree_ach_direct_debit_vault_active": false,
-        "braintree_applepay_merchant_name": "abc123",
+        "braintree_applepay_merchant_name": "xyz789",
         "braintree_applepay_vault_active": false,
         "braintree_cc_vault_active": "xyz789",
         "braintree_cc_vault_cvv": false,
         "braintree_environment": "xyz789",
-        "braintree_googlepay_btn_color": "abc123",
+        "braintree_googlepay_btn_color": "xyz789",
         "braintree_googlepay_cctypes": "xyz789",
-        "braintree_googlepay_merchant_id": "xyz789",
-        "braintree_googlepay_vault_active": true,
+        "braintree_googlepay_merchant_id": "abc123",
+        "braintree_googlepay_vault_active": false,
         "braintree_local_payment_allowed_methods": "abc123",
-        "braintree_local_payment_fallback_button_text": "xyz789",
+        "braintree_local_payment_fallback_button_text": "abc123",
         "braintree_local_payment_redirect_on_fail": "xyz789",
-        "braintree_merchant_account_id": "xyz789",
-        "braintree_paypal_button_location_cart_type_credit_color": "abc123",
+        "braintree_merchant_account_id": "abc123",
+        "braintree_paypal_button_location_cart_type_credit_color": "xyz789",
         "braintree_paypal_button_location_cart_type_credit_label": "abc123",
         "braintree_paypal_button_location_cart_type_credit_shape": "xyz789",
         "braintree_paypal_button_location_cart_type_credit_show": true,
         "braintree_paypal_button_location_cart_type_messaging_layout": "abc123",
-        "braintree_paypal_button_location_cart_type_messaging_logo": "abc123",
-        "braintree_paypal_button_location_cart_type_messaging_logo_position": "xyz789",
-        "braintree_paypal_button_location_cart_type_messaging_show": false,
+        "braintree_paypal_button_location_cart_type_messaging_logo": "xyz789",
+        "braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123",
+        "braintree_paypal_button_location_cart_type_messaging_show": true,
         "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123",
         "braintree_paypal_button_location_cart_type_paylater_color": "abc123",
-        "braintree_paypal_button_location_cart_type_paylater_label": "abc123",
+        "braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
         "braintree_paypal_button_location_cart_type_paylater_shape": "xyz789",
-        "braintree_paypal_button_location_cart_type_paylater_show": true,
-        "braintree_paypal_button_location_cart_type_paypal_color": "abc123",
-        "braintree_paypal_button_location_cart_type_paypal_label": "abc123",
-        "braintree_paypal_button_location_cart_type_paypal_shape": "abc123",
+        "braintree_paypal_button_location_cart_type_paylater_show": false,
+        "braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
+        "braintree_paypal_button_location_cart_type_paypal_label": "xyz789",
+        "braintree_paypal_button_location_cart_type_paypal_shape": "xyz789",
         "braintree_paypal_button_location_cart_type_paypal_show": true,
         "braintree_paypal_button_location_checkout_type_credit_color": "abc123",
-        "braintree_paypal_button_location_checkout_type_credit_label": "abc123",
-        "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789",
-        "braintree_paypal_button_location_checkout_type_credit_show": true,
+        "braintree_paypal_button_location_checkout_type_credit_label": "xyz789",
+        "braintree_paypal_button_location_checkout_type_credit_shape": "abc123",
+        "braintree_paypal_button_location_checkout_type_credit_show": false,
         "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789",
-        "braintree_paypal_button_location_checkout_type_messaging_logo": "abc123",
-        "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789",
+        "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789",
+        "braintree_paypal_button_location_checkout_type_messaging_logo_position": "abc123",
         "braintree_paypal_button_location_checkout_type_messaging_show": true,
         "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123",
-        "braintree_paypal_button_location_checkout_type_paylater_color": "abc123",
-        "braintree_paypal_button_location_checkout_type_paylater_label": "abc123",
-        "braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789",
+        "braintree_paypal_button_location_checkout_type_paylater_color": "xyz789",
+        "braintree_paypal_button_location_checkout_type_paylater_label": "xyz789",
+        "braintree_paypal_button_location_checkout_type_paylater_shape": "abc123",
         "braintree_paypal_button_location_checkout_type_paylater_show": true,
         "braintree_paypal_button_location_checkout_type_paypal_color": "abc123",
         "braintree_paypal_button_location_checkout_type_paypal_label": "abc123",
         "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789",
-        "braintree_paypal_button_location_checkout_type_paypal_show": false,
-        "braintree_paypal_button_location_productpage_type_credit_color": "xyz789",
-        "braintree_paypal_button_location_productpage_type_credit_label": "abc123",
+        "braintree_paypal_button_location_checkout_type_paypal_show": true,
+        "braintree_paypal_button_location_productpage_type_credit_color": "abc123",
+        "braintree_paypal_button_location_productpage_type_credit_label": "xyz789",
         "braintree_paypal_button_location_productpage_type_credit_shape": "abc123",
-        "braintree_paypal_button_location_productpage_type_credit_show": false,
+        "braintree_paypal_button_location_productpage_type_credit_show": true,
         "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789",
         "braintree_paypal_button_location_productpage_type_messaging_logo": "abc123",
         "braintree_paypal_button_location_productpage_type_messaging_logo_position": "abc123",
-        "braintree_paypal_button_location_productpage_type_messaging_show": false,
-        "braintree_paypal_button_location_productpage_type_messaging_text_color": "xyz789",
-        "braintree_paypal_button_location_productpage_type_paylater_color": "abc123",
-        "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789",
-        "braintree_paypal_button_location_productpage_type_paylater_shape": "xyz789",
+        "braintree_paypal_button_location_productpage_type_messaging_show": true,
+        "braintree_paypal_button_location_productpage_type_messaging_text_color": "abc123",
+        "braintree_paypal_button_location_productpage_type_paylater_color": "xyz789",
+        "braintree_paypal_button_location_productpage_type_paylater_label": "abc123",
+        "braintree_paypal_button_location_productpage_type_paylater_shape": "abc123",
         "braintree_paypal_button_location_productpage_type_paylater_show": false,
         "braintree_paypal_button_location_productpage_type_paypal_color": "xyz789",
         "braintree_paypal_button_location_productpage_type_paypal_label": "xyz789",
         "braintree_paypal_button_location_productpage_type_paypal_shape": "abc123",
-        "braintree_paypal_button_location_productpage_type_paypal_show": false,
-        "braintree_paypal_credit_uk_merchant_name": "xyz789",
+        "braintree_paypal_button_location_productpage_type_paypal_show": true,
+        "braintree_paypal_credit_uk_merchant_name": "abc123",
         "braintree_paypal_display_on_shopping_cart": false,
-        "braintree_paypal_merchant_country": "xyz789",
+        "braintree_paypal_merchant_country": "abc123",
         "braintree_paypal_merchant_name_override": "xyz789",
-        "braintree_paypal_require_billing_address": false,
+        "braintree_paypal_require_billing_address": true,
         "braintree_paypal_send_cart_line_items": false,
         "braintree_paypal_vault_active": true,
-        "cart_expires_in_days": 987,
+        "cart_expires_in_days": 123,
         "cart_gift_wrapping": "abc123",
-        "cart_printed_card": "abc123",
+        "cart_printed_card": "xyz789",
         "cart_summary_display_quantity": 987,
-        "catalog_default_sort_by": "xyz789",
+        "catalog_default_sort_by": "abc123",
         "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-        "category_url_suffix": "abc123",
+        "category_url_suffix": "xyz789",
         "check_money_order_enable_for_specific_countries": true,
         "check_money_order_enabled": false,
-        "check_money_order_make_check_payable_to": "xyz789",
+        "check_money_order_make_check_payable_to": "abc123",
         "check_money_order_max_order_total": "xyz789",
         "check_money_order_min_order_total": "abc123",
         "check_money_order_new_order_status": "xyz789",
-        "check_money_order_payment_from_specific_countries": "xyz789",
-        "check_money_order_send_check_to": "xyz789",
+        "check_money_order_payment_from_specific_countries": "abc123",
+        "check_money_order_send_check_to": "abc123",
         "check_money_order_sort_order": 987,
-        "check_money_order_title": "xyz789",
-        "cms_home_page": "abc123",
+        "check_money_order_title": "abc123",
+        "cms_home_page": "xyz789",
         "cms_no_cookies": "xyz789",
-        "cms_no_route": "xyz789",
+        "cms_no_route": "abc123",
         "code": "abc123",
         "configurable_product_image": "ITSELF",
         "configurable_thumbnail_source": "abc123",
-        "contact_enabled": true,
+        "contact_enabled": false,
         "copyright": "abc123",
         "countries_with_required_region": "abc123",
-        "create_account_confirmation": true,
-        "customer_access_token_lifetime": 987.65,
+        "create_account_confirmation": false,
+        "customer_access_token_lifetime": 123.45,
         "default_country": "xyz789",
         "default_description": "abc123",
         "default_display_currency_code": "xyz789",
-        "default_keywords": "abc123",
-        "default_title": "abc123",
-        "demonotice": 987,
-        "display_product_prices_in_catalog": 987,
+        "default_keywords": "xyz789",
+        "default_title": "xyz789",
+        "demonotice": 123,
+        "display_product_prices_in_catalog": 123,
         "display_shipping_prices": 123,
-        "display_state_if_optional": true,
-        "enable_multiple_wishlists": "abc123",
-        "fixed_product_taxes_apply_tax_to_fpt": true,
+        "display_state_if_optional": false,
+        "enable_multiple_wishlists": "xyz789",
+        "fixed_product_taxes_apply_tax_to_fpt": false,
         "fixed_product_taxes_display_prices_in_emails": 123,
-        "fixed_product_taxes_display_prices_in_product_lists": 123,
+        "fixed_product_taxes_display_prices_in_product_lists": 987,
         "fixed_product_taxes_display_prices_in_sales_modules": 123,
-        "fixed_product_taxes_display_prices_on_product_view_page": 987,
+        "fixed_product_taxes_display_prices_on_product_view_page": 123,
         "fixed_product_taxes_enable": true,
         "fixed_product_taxes_include_fpt_in_subtotal": false,
-        "front": "abc123",
-        "graphql_share_all_customer_groups": true,
-        "graphql_share_customer_group": true,
+        "front": "xyz789",
+        "graphql_share_all_customer_groups": false,
+        "graphql_share_customer_group": false,
         "grid_per_page": 123,
         "grid_per_page_values": "xyz789",
         "grouped_product_image": "ITSELF",
-        "head_includes": "abc123",
-        "head_shortcut_icon": "xyz789",
+        "head_includes": "xyz789",
+        "head_shortcut_icon": "abc123",
         "header_logo_src": "abc123",
         "id": 987,
-        "is_checkout_agreements_enabled": true,
-        "is_default_store": false,
-        "is_default_store_group": false,
+        "is_checkout_agreements_enabled": false,
+        "is_default_store": true,
+        "is_default_store_group": true,
         "is_guest_checkout_enabled": true,
         "is_negotiable_quote_active": true,
         "is_one_page_checkout_enabled": true,
-        "is_requisition_list_active": "abc123",
-        "list_mode": "abc123",
-        "list_per_page": 123,
+        "is_requisition_list_active": "xyz789",
+        "list_mode": "xyz789",
+        "list_per_page": 987,
         "list_per_page_values": "xyz789",
         "locale": "abc123",
-        "logo_alt": "abc123",
+        "logo_alt": "xyz789",
         "logo_height": 987,
         "logo_width": 123,
         "magento_reward_general_is_enabled": "xyz789",
         "magento_reward_general_is_enabled_on_front": "abc123",
-        "magento_reward_general_min_points_balance": "abc123",
-        "magento_reward_general_publish_history": "xyz789",
-        "magento_reward_points_invitation_customer": "xyz789",
-        "magento_reward_points_invitation_customer_limit": "abc123",
+        "magento_reward_general_min_points_balance": "xyz789",
+        "magento_reward_general_publish_history": "abc123",
+        "magento_reward_points_invitation_customer": "abc123",
+        "magento_reward_points_invitation_customer_limit": "xyz789",
         "magento_reward_points_invitation_order": "xyz789",
-        "magento_reward_points_invitation_order_limit": "abc123",
+        "magento_reward_points_invitation_order_limit": "xyz789",
         "magento_reward_points_newsletter": "xyz789",
-        "magento_reward_points_order": "xyz789",
+        "magento_reward_points_order": "abc123",
         "magento_reward_points_register": "abc123",
         "magento_reward_points_review": "xyz789",
-        "magento_reward_points_review_limit": "xyz789",
-        "magento_wishlist_general_is_enabled": "abc123",
-        "max_items_in_order_summary": 987,
-        "maximum_number_of_wishlists": "abc123",
+        "magento_reward_points_review_limit": "abc123",
+        "magento_wishlist_general_is_enabled": "xyz789",
+        "max_items_in_order_summary": 123,
+        "maximum_number_of_wishlists": "xyz789",
         "minicart_display": false,
         "minicart_max_items": 987,
-        "minimum_password_length": "abc123",
+        "minimum_password_length": "xyz789",
         "newsletter_enabled": false,
         "no_route": "xyz789",
-        "optional_zip_countries": "xyz789",
+        "optional_zip_countries": "abc123",
         "order_cancellation_enabled": false,
         "order_cancellation_reasons": [
           CancellationReason
         ],
-        "orders_invoices_credit_memos_display_full_summary": true,
+        "orders_invoices_credit_memos_display_full_summary": false,
         "orders_invoices_credit_memos_display_grandtotal": false,
         "orders_invoices_credit_memos_display_price": 123,
-        "orders_invoices_credit_memos_display_shipping_amount": 123,
-        "orders_invoices_credit_memos_display_subtotal": 987,
+        "orders_invoices_credit_memos_display_shipping_amount": 987,
+        "orders_invoices_credit_memos_display_subtotal": 123,
         "orders_invoices_credit_memos_display_zero_tax": true,
-        "payment_payflowpro_cc_vault_active": "abc123",
+        "payment_payflowpro_cc_vault_active": "xyz789",
         "printed_card_price": "abc123",
         "printed_card_priceV2": Money,
         "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
         "product_reviews_enabled": "abc123",
         "product_url_suffix": "abc123",
-        "quickorder_active": false,
+        "quickorder_active": true,
         "required_character_classes_number": "xyz789",
         "returns_enabled": "xyz789",
-        "root_category_id": 987,
+        "root_category_id": 123,
         "root_category_uid": 4,
         "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
         "sales_gift_wrapping": "abc123",
-        "sales_printed_card": "abc123",
+        "sales_printed_card": "xyz789",
         "secure_base_link_url": "abc123",
         "secure_base_media_url": "abc123",
-        "secure_base_static_url": "abc123",
+        "secure_base_static_url": "xyz789",
         "secure_base_url": "xyz789",
         "send_friend": SendFriendConfiguration,
         "share_all_catalog_rules": false,
         "share_all_sales_rule": false,
-        "share_applied_catalog_rules": false,
-        "share_applied_sales_rule": false,
-        "shopping_cart_display_full_summary": true,
-        "shopping_cart_display_grand_total": false,
+        "share_applied_catalog_rules": true,
+        "share_applied_sales_rule": true,
+        "shopping_cart_display_full_summary": false,
+        "shopping_cart_display_grand_total": true,
         "shopping_cart_display_price": 123,
-        "shopping_cart_display_shipping": 987,
+        "shopping_cart_display_shipping": 123,
         "shopping_cart_display_subtotal": 987,
         "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
         "shopping_cart_display_zero_tax": true,
         "show_cms_breadcrumbs": 987,
-        "store_code": 4,
-        "store_group_code": 4,
-        "store_group_name": "abc123",
-        "store_name": "xyz789",
-        "store_sort_order": 123,
-        "timezone": "xyz789",
+        "store_code": "4",
+        "store_group_code": "4",
+        "store_group_name": "xyz789",
+        "store_name": "abc123",
+        "store_sort_order": 987,
+        "timezone": "abc123",
         "title_prefix": "xyz789",
-        "title_separator": "abc123",
-        "title_suffix": "xyz789",
-        "use_store_in_url": true,
-        "website_code": 4,
-        "website_id": 123,
-        "website_name": "xyz789",
-        "weight_unit": "abc123",
-        "welcome": "abc123",
+        "title_separator": "xyz789",
+        "title_suffix": "abc123",
+        "use_store_in_url": false,
+        "website_code": "4",
+        "website_id": 987,
+        "website_name": "abc123",
+        "weight_unit": "xyz789",
+        "welcome": "xyz789",
         "zero_subtotal_enable_for_specific_countries": true,
-        "zero_subtotal_enabled": false,
+        "zero_subtotal_enabled": true,
         "zero_subtotal_new_order_status": "abc123",
         "zero_subtotal_payment_action": "xyz789",
         "zero_subtotal_payment_from_specific_countries": "abc123",
         "zero_subtotal_sort_order": 123,
-        "zero_subtotal_title": "xyz789"
+        "zero_subtotal_title": "abc123"
       }
     ]
   }
 }
 

-                    
-
back to top @@ -1947,9 +1909,7 @@
Arguments

Example

Query
- - - 
query cart($cart_id: String!) {
+                  
query cart($cart_id: String!) {
   cart(cart_id: $cart_id) {
     applied_coupon {
       ...AppliedCouponFragment
@@ -2008,23 +1968,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"cart_id": "xyz789"}
+                  
{"cart_id": "abc123"}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "cart": {
       "applied_coupon": AppliedCoupon,
@@ -2037,26 +1989,24 @@ 
Response

         AvailablePaymentMethod
       ],
       "billing_address": BillingCartAddress,
-      "email": "xyz789",
+      "email": "abc123",
       "gift_message": GiftMessage,
       "gift_receipt_included": true,
       "gift_wrapping": GiftWrapping,
-      "id": 4,
+      "id": "4",
       "is_virtual": true,
       "items": [CartItemInterface],
       "itemsV2": CartItems,
       "prices": CartPrices,
-      "printed_card_included": true,
+      "printed_card_included": false,
       "rules": [CartRule],
       "selected_payment_method": SelectedPaymentMethod,
       "shipping_addresses": [ShippingCartAddress],
-      "total_quantity": 987.65
+      "total_quantity": 123.45
     }
   }
 }
 

-                    
-
back to top @@ -2120,9 +2070,7 @@
Arguments

Example

Query
- - - 
query categories(
+                  
query categories(
   $filters: CategoryFilterInput,
   $pageSize: Int,
   $currentPage: Int
@@ -2142,38 +2090,28 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
+                  
{
   "filters": CategoryFilterInput,
   "pageSize": 20,
   "currentPage": 1
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "categories": {
       "items": [CategoryTree],
       "page_info": SearchResultPageInfo,
-      "total_count": 987
+      "total_count": 123
     }
   }
 }
 

-                    
-
back to top @@ -2232,9 +2170,7 @@
Arguments

Example

Query
- - - 
query category($id: Int) {
+                  
query category($id: Int) {
   category(id: $id) {
     automatic_sorting
     available_sort_by
@@ -2284,68 +2220,58 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"id": 987}
+                  
{"id": 123}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "category": {
       "automatic_sorting": "xyz789",
-      "available_sort_by": ["xyz789"],
+      "available_sort_by": ["abc123"],
       "breadcrumbs": [Breadcrumb],
       "canonical_url": "xyz789",
       "children": [CategoryTree],
-      "children_count": "abc123",
+      "children_count": "xyz789",
       "cms_block": CmsBlock,
-      "created_at": "abc123",
+      "created_at": "xyz789",
       "custom_layout_update_file": "xyz789",
       "default_sort_by": "abc123",
-      "description": "abc123",
+      "description": "xyz789",
       "display_mode": "xyz789",
-      "filter_price_range": 123.45,
-      "id": 123,
-      "image": "xyz789",
+      "filter_price_range": 987.65,
+      "id": 987,
+      "image": "abc123",
       "include_in_menu": 123,
       "is_anchor": 987,
       "landing_page": 987,
       "level": 987,
-      "meta_description": "xyz789",
-      "meta_keywords": "abc123",
+      "meta_description": "abc123",
+      "meta_keywords": "xyz789",
       "meta_title": "xyz789",
       "name": "xyz789",
-      "path": "abc123",
-      "path_in_store": "abc123",
+      "path": "xyz789",
+      "path_in_store": "xyz789",
       "position": 987,
       "product_count": 987,
       "products": CategoryProducts,
-      "redirect_code": 987,
-      "relative_url": "xyz789",
-      "staged": false,
+      "redirect_code": 123,
+      "relative_url": "abc123",
+      "staged": true,
       "type": "CMS_PAGE",
       "uid": "4",
-      "updated_at": "abc123",
+      "updated_at": "xyz789",
       "url_key": "abc123",
-      "url_path": "abc123",
-      "url_suffix": "abc123"
+      "url_path": "xyz789",
+      "url_suffix": "xyz789"
     }
   }
 }
 

-                    
-
back to top @@ -2416,9 +2342,7 @@
Arguments

Example

Query
- - - 
query categoryList(
+                  
query categoryList(
   $filters: CategoryFilterInput,
   $pageSize: Int,
   $currentPage: Int
@@ -2476,74 +2400,64 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
+                  
{
   "filters": CategoryFilterInput,
   "pageSize": 20,
   "currentPage": 1
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "categoryList": [
       {
         "automatic_sorting": "xyz789",
-        "available_sort_by": ["abc123"],
+        "available_sort_by": ["xyz789"],
         "breadcrumbs": [Breadcrumb],
-        "canonical_url": "xyz789",
+        "canonical_url": "abc123",
         "children": [CategoryTree],
-        "children_count": "abc123",
+        "children_count": "xyz789",
         "cms_block": CmsBlock,
         "created_at": "xyz789",
-        "custom_layout_update_file": "xyz789",
+        "custom_layout_update_file": "abc123",
         "default_sort_by": "xyz789",
         "description": "xyz789",
-        "display_mode": "abc123",
+        "display_mode": "xyz789",
         "filter_price_range": 123.45,
         "id": 987,
         "image": "xyz789",
-        "include_in_menu": 987,
+        "include_in_menu": 123,
         "is_anchor": 123,
-        "landing_page": 123,
-        "level": 123,
-        "meta_description": "xyz789",
-        "meta_keywords": "abc123",
+        "landing_page": 987,
+        "level": 987,
+        "meta_description": "abc123",
+        "meta_keywords": "xyz789",
         "meta_title": "abc123",
         "name": "abc123",
-        "path": "abc123",
-        "path_in_store": "abc123",
-        "position": 123,
-        "product_count": 987,
+        "path": "xyz789",
+        "path_in_store": "xyz789",
+        "position": 987,
+        "product_count": 123,
         "products": CategoryProducts,
-        "redirect_code": 123,
-        "relative_url": "abc123",
+        "redirect_code": 987,
+        "relative_url": "xyz789",
         "staged": true,
         "type": "CMS_PAGE",
-        "uid": 4,
+        "uid": "4",
         "updated_at": "xyz789",
-        "url_key": "xyz789",
-        "url_path": "abc123",
-        "url_suffix": "abc123"
+        "url_key": "abc123",
+        "url_path": "xyz789",
+        "url_suffix": "xyz789"
       }
     ]
   }
 }
 

-                    
-
back to top @@ -2576,9 +2490,7 @@
Response

Example

Query
- - - 
query checkoutAgreements {
+                  
query checkoutAgreements {
   checkoutAgreements {
     agreement_id
     checkbox_text
@@ -2590,31 +2502,25 @@ 
Query

   }
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "checkoutAgreements": [
       {
         "agreement_id": 987,
         "checkbox_text": "abc123",
-        "content": "abc123",
-        "content_height": "xyz789",
-        "is_html": true,
+        "content": "xyz789",
+        "content_height": "abc123",
+        "is_html": false,
         "mode": "AUTO",
-        "name": "abc123"
+        "name": "xyz789"
       }
     ]
   }
 }
 

-                    
-
back to top @@ -2666,9 +2572,7 @@
Arguments

Example

Query
- - - 
query cmsBlocks($identifiers: [String]) {
+                  
query cmsBlocks($identifiers: [String]) {
   cmsBlocks(identifiers: $identifiers) {
     items {
       ...CmsBlockFragment
@@ -2676,26 +2580,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"identifiers": ["abc123"]}
+                  
{"identifiers": ["abc123"]}
 

-                    
-
Response
- - - 
{"data": {"cmsBlocks": {"items": [CmsBlock]}}}
+                  
{"data": {"cmsBlocks": {"items": [CmsBlock]}}}
 

-                    
-
back to top @@ -2753,9 +2647,7 @@
Arguments

Example

Query
- - - 
query cmsPage(
+                  
query cmsPage(
   $id: Int,
   $identifier: String
 ) {
@@ -2778,43 +2670,33 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"id": 987, "identifier": "abc123"}
+                  
{"id": 987, "identifier": "abc123"}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "cmsPage": {
       "content": "xyz789",
       "content_heading": "abc123",
-      "identifier": "xyz789",
-      "meta_description": "abc123",
-      "meta_keywords": "abc123",
-      "meta_title": "xyz789",
-      "page_layout": "abc123",
-      "redirect_code": 987,
-      "relative_url": "xyz789",
+      "identifier": "abc123",
+      "meta_description": "xyz789",
+      "meta_keywords": "xyz789",
+      "meta_title": "abc123",
+      "page_layout": "xyz789",
+      "redirect_code": 123,
+      "relative_url": "abc123",
       "title": "xyz789",
       "type": "CMS_PAGE",
-      "url_key": "xyz789"
+      "url_key": "abc123"
     }
   }
 }
 

-                    
-
back to top @@ -2847,9 +2729,7 @@
Response

Example

Query
- - - 
query company {
+                  
query company {
   company {
     acl_resources {
       ...CompanyAclResourceFragment
@@ -2897,14 +2777,10 @@ 
Query

   }
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "company": {
       "acl_resources": [CompanyAclResource],
@@ -2914,9 +2790,9 @@ 
Response

       "email": "abc123",
       "id": 4,
       "legal_address": CompanyLegalAddress,
-      "legal_name": "abc123",
+      "legal_name": "xyz789",
       "name": "xyz789",
-      "payment_methods": ["xyz789"],
+      "payment_methods": ["abc123"],
       "reseller_id": "xyz789",
       "role": CompanyRole,
       "roles": CompanyRoles,
@@ -2925,13 +2801,11 @@ 
Response

       "team": CompanyTeam,
       "user": Customer,
       "users": CompanyUsers,
-      "vat_tax_id": "abc123"
+      "vat_tax_id": "xyz789"
     }
   }
 }
 

-                    
-
back to top @@ -2983,9 +2857,7 @@
Arguments

Example

Query
- - - 
query compareList($uid: ID!) {
+                  
query compareList($uid: ID!) {
   compareList(uid: $uid) {
     attributes {
       ...ComparableAttributeFragment
@@ -2998,23 +2870,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"uid": 4}
+                  
{"uid": 4}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "compareList": {
       "attributes": [ComparableAttribute],
@@ -3025,8 +2889,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -3059,9 +2921,7 @@
Response

Example

Query
- - - 
query countries {
+                  
query countries {
   countries {
     available_regions {
       ...RegionFragment
@@ -3074,20 +2934,16 @@ 
Query

   }
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "countries": [
       {
         "available_regions": [Region],
         "full_name_english": "xyz789",
-        "full_name_locale": "xyz789",
+        "full_name_locale": "abc123",
         "id": "xyz789",
         "three_letter_abbreviation": "abc123",
         "two_letter_abbreviation": "xyz789"
@@ -3096,8 +2952,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -3150,9 +3004,7 @@
Arguments

Example

Query
- - - 
query country($id: String) {
+                  
query country($id: String) {
   country(id: $id) {
     available_regions {
       ...RegionFragment
@@ -3165,37 +3017,27 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"id": "abc123"}
+                  
{"id": "xyz789"}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "country": {
       "available_regions": [Region],
-      "full_name_english": "xyz789",
+      "full_name_english": "abc123",
       "full_name_locale": "abc123",
       "id": "xyz789",
-      "three_letter_abbreviation": "xyz789",
-      "two_letter_abbreviation": "abc123"
+      "three_letter_abbreviation": "abc123",
+      "two_letter_abbreviation": "xyz789"
     }
   }
 }
 

-                    
-
back to top @@ -3228,9 +3070,7 @@
Response

Example

Query
- - - 
query currency {
+                  
query currency {
   currency {
     available_currency_codes
     base_currency_code
@@ -3245,32 +3085,26 @@ 
Query

   }
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "currency": {
       "available_currency_codes": [
-        "xyz789"
+        "abc123"
       ],
-      "base_currency_code": "xyz789",
-      "base_currency_symbol": "xyz789",
+      "base_currency_code": "abc123",
+      "base_currency_symbol": "abc123",
       "default_display_currecy_code": "xyz789",
-      "default_display_currecy_symbol": "xyz789",
+      "default_display_currecy_symbol": "abc123",
       "default_display_currency_code": "abc123",
-      "default_display_currency_symbol": "xyz789",
+      "default_display_currency_symbol": "abc123",
       "exchange_rates": [ExchangeRate]
     }
   }
 }
 

-                    
-
back to top @@ -3329,9 +3163,7 @@
Arguments

Example

Query
- - - 
query customAttributeMetadata($attributes: [AttributeInput!]!) {
+                  
query customAttributeMetadata($attributes: [AttributeInput!]!) {
   customAttributeMetadata(attributes: $attributes) {
     items {
       ...AttributeFragment
@@ -3339,30 +3171,20 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"attributes": [AttributeInput]}
+                  
{"attributes": [AttributeInput]}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "customAttributeMetadata": {"items": [Attribute]}
   }
 }
 

-                    
-
back to top @@ -3415,9 +3237,7 @@
Arguments

Example

Query
- - - 
query customAttributeMetadataV2($attributes: [AttributeInput!]) {
+                  
query customAttributeMetadataV2($attributes: [AttributeInput!]) {
   customAttributeMetadataV2(attributes: $attributes) {
     errors {
       ...AttributeMetadataErrorFragment
@@ -3428,23 +3248,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"attributes": [AttributeInput]}
+                  
{"attributes": [AttributeInput]}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "customAttributeMetadataV2": {
       "errors": [AttributeMetadataError],
@@ -3453,8 +3265,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -3487,9 +3297,7 @@
Response

Example

Query
- - - 
query customer {
+                  
query customer {
   customer {
     addresses {
       ...CustomerAddressFragment
@@ -3595,19 +3403,15 @@ 
Query

   }
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "customer": {
       "addresses": [CustomerAddress],
       "addressesV2": CustomerAddresses,
-      "allow_remote_shopping_assistance": true,
+      "allow_remote_shopping_assistance": false,
       "companies": UserCompaniesOutput,
       "compare_list": CompareList,
       "confirmation_status": "ACCOUNT_CONFIRMED",
@@ -3615,22 +3419,22 @@ 
Response

       "custom_attributes": [AttributeValueInterface],
       "date_of_birth": "xyz789",
       "default_billing": "xyz789",
-      "default_shipping": "xyz789",
-      "dob": "abc123",
+      "default_shipping": "abc123",
+      "dob": "xyz789",
       "email": "abc123",
       "firstname": "xyz789",
-      "gender": 987,
+      "gender": 123,
       "gift_registries": [GiftRegistry],
       "gift_registry": GiftRegistry,
       "group": CustomerGroup,
-      "group_id": 123,
-      "id": 123,
+      "group_id": 987,
+      "id": 987,
       "is_subscribed": false,
-      "job_title": "abc123",
+      "job_title": "xyz789",
       "lastname": "xyz789",
       "middlename": "abc123",
       "orders": CustomerOrders,
-      "prefix": "xyz789",
+      "prefix": "abc123",
       "purchase_order": PurchaseOrder,
       "purchase_order_approval_rule": PurchaseOrderApprovalRule,
       "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
@@ -3648,9 +3452,9 @@ 
Response

       "store_credit": CustomerStoreCredit,
       "structure_id": "4",
       "suffix": "abc123",
-      "taxvat": "xyz789",
+      "taxvat": "abc123",
       "team": CompanyTeam,
-      "telephone": "xyz789",
+      "telephone": "abc123",
       "wishlist": Wishlist,
       "wishlist_v2": Wishlist,
       "wishlists": [Wishlist]
@@ -3658,8 +3462,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -3692,9 +3494,7 @@
Response

Example

Query
- - - 
query customerCart {
+                  
query customerCart {
   customerCart {
     applied_coupon {
       ...AppliedCouponFragment
@@ -3753,14 +3553,10 @@ 
Query

   }
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "customerCart": {
       "applied_coupon": AppliedCoupon,
@@ -3775,14 +3571,14 @@ 
Response

       "billing_address": BillingCartAddress,
       "email": "abc123",
       "gift_message": GiftMessage,
-      "gift_receipt_included": false,
+      "gift_receipt_included": true,
       "gift_wrapping": GiftWrapping,
       "id": "4",
       "is_virtual": false,
       "items": [CartItemInterface],
       "itemsV2": CartItems,
       "prices": CartPrices,
-      "printed_card_included": false,
+      "printed_card_included": true,
       "rules": [CartRule],
       "selected_payment_method": SelectedPaymentMethod,
       "shipping_addresses": [ShippingCartAddress],
@@ -3791,8 +3587,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -3825,9 +3619,7 @@
Response

Example

Query
- - - 
query customerDownloadableProducts {
+                  
query customerDownloadableProducts {
   customerDownloadableProducts {
     items {
       ...CustomerDownloadableProductFragment
@@ -3835,14 +3627,10 @@ 
Query

   }
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "customerDownloadableProducts": {
       "items": [CustomerDownloadableProduct]
@@ -3850,8 +3638,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -3883,9 +3669,7 @@
Response

Example

Query
- - - 
query customerOrders {
+                  
query customerOrders {
   customerOrders {
     date_of_first_order
     items {
@@ -3898,14 +3682,10 @@ 
Query

   }
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "customerOrders": {
       "date_of_first_order": "abc123",
@@ -3916,8 +3696,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -3950,9 +3728,7 @@
Response

Example

Query
- - - 
query customerPaymentTokens {
+                  
query customerPaymentTokens {
   customerPaymentTokens {
     items {
       ...PaymentTokenFragment
@@ -3960,21 +3736,15 @@ 
Query

   }
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "customerPaymentTokens": {"items": [PaymentToken]}
   }
 }
 

-                    
-
back to top @@ -4038,9 +3808,7 @@
Arguments

Example

Query
- - - 
query dynamicBlocks(
+                  
query dynamicBlocks(
   $input: DynamicBlocksFilterInput,
   $pageSize: Int,
   $currentPage: Int
@@ -4060,38 +3828,28 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
+                  
{
   "input": DynamicBlocksFilterInput,
   "pageSize": 20,
   "currentPage": 1
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "dynamicBlocks": {
       "items": [DynamicBlock],
       "page_info": SearchResultPageInfo,
-      "total_count": 987
+      "total_count": 123
     }
   }
 }
 

-                    
-
back to top @@ -4143,40 +3901,28 @@
Arguments

Example

Query
- - - 
query getHostedProUrl($input: HostedProUrlInput!) {
+                  
query getHostedProUrl($input: HostedProUrlInput!) {
   getHostedProUrl(input: $input) {
     secure_form_url
   }
 }
 

-                    
-
Variables
- - - 
{"input": HostedProUrlInput}
+                  
{"input": HostedProUrlInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "getHostedProUrl": {
-      "secure_form_url": "xyz789"
+      "secure_form_url": "abc123"
     }
   }
 }
 

-                    
-
back to top @@ -4228,9 +3974,7 @@
Arguments

Example

Query
- - - 
query getPayflowLinkToken($input: PayflowLinkTokenInput!) {
+                  
query getPayflowLinkToken($input: PayflowLinkTokenInput!) {
   getPayflowLinkToken(input: $input) {
     mode
     paypal_url
@@ -4239,23 +3983,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": PayflowLinkTokenInput}
+                  
{"input": PayflowLinkTokenInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "getPayflowLinkToken": {
       "mode": "TEST",
@@ -4266,8 +4002,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -4319,9 +4053,7 @@
Arguments

Example

Query
- - - 
query getPaymentConfig($location: PaymentLocation!) {
+                  
query getPaymentConfig($location: PaymentLocation!) {
   getPaymentConfig(location: $location) {
     apple_pay {
       ...ApplePayConfigFragment
@@ -4338,23 +4070,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"location": "PRODUCT_DETAIL"}
+                  
{"location": "PRODUCT_DETAIL"}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "getPaymentConfig": {
       "apple_pay": ApplePayConfig,
@@ -4365,8 +4089,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -4424,9 +4146,7 @@
Arguments

Example

Query
- - - 
query getPaymentOrder(
+                  
query getPaymentOrder(
   $cartId: String!,
   $id: String!
 ) {
@@ -4443,29 +4163,21 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
-  "cartId": "xyz789",
+                  
{
+  "cartId": "abc123",
   "id": "abc123"
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "getPaymentOrder": {
-      "id": "xyz789",
+      "id": "abc123",
       "mp_order_id": "abc123",
       "payment_source_details": PaymentSourceDetails,
       "status": "abc123"
@@ -4473,8 +4185,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -4526,9 +4236,7 @@
Arguments

Example

Query
- - - 
query getPaymentSDK($location: PaymentLocation!) {
+                  
query getPaymentSDK($location: PaymentLocation!) {
   getPaymentSDK(location: $location) {
     sdkParams {
       ...PaymentSDKParamsItemFragment
@@ -4536,30 +4244,20 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"location": "PRODUCT_DETAIL"}
+                  
{"location": "PRODUCT_DETAIL"}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "getPaymentSDK": {"sdkParams": [PaymentSDKParamsItem]}
   }
 }
 

-                    
-
back to top @@ -4592,9 +4290,7 @@
Response

Example

Query
- - - 
query getVaultConfig {
+                  
query getVaultConfig {
   getVaultConfig {
     credit_card {
       ...VaultCreditCardConfigFragment
@@ -4602,14 +4298,10 @@ 
Query

   }
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "getVaultConfig": {
       "credit_card": VaultCreditCardConfig
@@ -4617,8 +4309,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -4670,9 +4360,7 @@
Arguments

Example

Query
- - - 
query giftCardAccount($input: GiftCardAccountInput!) {
+                  
query giftCardAccount($input: GiftCardAccountInput!) {
   giftCardAccount(input: $input) {
     balance {
       ...MoneyFragment
@@ -4682,34 +4370,24 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": GiftCardAccountInput}
+                  
{"input": GiftCardAccountInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "giftCardAccount": {
       "balance": Money,
-      "code": "xyz789",
-      "expiration_date": "xyz789"
+      "code": "abc123",
+      "expiration_date": "abc123"
     }
   }
 }
 

-                    
-
back to top @@ -4761,9 +4439,7 @@
Arguments

Example

Query
- - - 
query giftRegistry($giftRegistryUid: ID!) {
+                  
query giftRegistry($giftRegistryUid: ID!) {
   giftRegistry(giftRegistryUid: $giftRegistryUid) {
     created_at
     dynamic_attributes {
@@ -4790,45 +4466,35 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"giftRegistryUid": 4}
+                  
{"giftRegistryUid": "4"}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "giftRegistry": {
-      "created_at": "abc123",
+      "created_at": "xyz789",
       "dynamic_attributes": [
         GiftRegistryDynamicAttribute
       ],
-      "event_name": "abc123",
+      "event_name": "xyz789",
       "items": [GiftRegistryItemInterface],
-      "message": "xyz789",
-      "owner_name": "xyz789",
+      "message": "abc123",
+      "owner_name": "abc123",
       "privacy_settings": "PRIVATE",
       "registrants": [GiftRegistryRegistrant],
       "shipping_address": CustomerAddress,
       "status": "ACTIVE",
       "type": GiftRegistryType,
-      "uid": "4"
+      "uid": 4
     }
   }
 }
 

-                    
-
back to top @@ -4880,9 +4546,7 @@
Arguments

Example

Query
- - - 
query giftRegistryEmailSearch($email: String!) {
+                  
query giftRegistryEmailSearch($email: String!) {
   giftRegistryEmailSearch(email: $email) {
     event_date
     event_title
@@ -4893,29 +4557,21 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"email": "xyz789"}
+                  
{"email": "abc123"}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "giftRegistryEmailSearch": [
       {
         "event_date": "xyz789",
-        "event_title": "abc123",
-        "gift_registry_uid": 4,
+        "event_title": "xyz789",
+        "gift_registry_uid": "4",
         "location": "abc123",
         "name": "xyz789",
         "type": "xyz789"
@@ -4924,8 +4580,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -4977,9 +4631,7 @@
Arguments

Example

Query
- - - 
query giftRegistryIdSearch($giftRegistryUid: ID!) {
+                  
query giftRegistryIdSearch($giftRegistryUid: ID!) {
   giftRegistryIdSearch(giftRegistryUid: $giftRegistryUid) {
     event_date
     event_title
@@ -4990,39 +4642,29 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"giftRegistryUid": 4}
+                  
{"giftRegistryUid": "4"}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "giftRegistryIdSearch": [
       {
-        "event_date": "xyz789",
-        "event_title": "xyz789",
+        "event_date": "abc123",
+        "event_title": "abc123",
         "gift_registry_uid": 4,
         "location": "abc123",
-        "name": "abc123",
+        "name": "xyz789",
         "type": "xyz789"
       }
     ]
   }
 }
 

-                    
-
back to top @@ -5086,9 +4728,7 @@
Arguments

Example

Query
- - - 
query giftRegistryTypeSearch(
+                  
query giftRegistryTypeSearch(
   $firstName: String!,
   $lastName: String!,
   $giftRegistryTypeUid: ID
@@ -5107,43 +4747,33 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
-  "firstName": "xyz789",
+                  
{
+  "firstName": "abc123",
   "lastName": "xyz789",
-  "giftRegistryTypeUid": 4
+  "giftRegistryTypeUid": "4"
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "giftRegistryTypeSearch": [
       {
-        "event_date": "xyz789",
+        "event_date": "abc123",
         "event_title": "xyz789",
-        "gift_registry_uid": "4",
+        "gift_registry_uid": 4,
         "location": "abc123",
         "name": "abc123",
-        "type": "abc123"
+        "type": "xyz789"
       }
     ]
   }
 }
 

-                    
-
back to top @@ -5176,9 +4806,7 @@
Response

Example

Query
- - - 
query giftRegistryTypes {
+                  
query giftRegistryTypes {
   giftRegistryTypes {
     dynamic_attributes_metadata {
       ...GiftRegistryDynamicAttributeMetadataInterfaceFragment
@@ -5188,29 +4816,23 @@ 
Query

   }
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "giftRegistryTypes": [
       {
         "dynamic_attributes_metadata": [
           GiftRegistryDynamicAttributeMetadataInterface
         ],
-        "label": "abc123",
-        "uid": 4
+        "label": "xyz789",
+        "uid": "4"
       }
     ]
   }
 }
 

-                    
-
back to top @@ -5263,9 +4885,7 @@
Arguments

Example

Query
- - - 
query guestOrder($input: OrderInformationInput!) {
+                  
query guestOrder($input: OrderInformationInput!) {
   guestOrder(input: $input) {
     applied_coupons {
       ...AppliedCouponFragment
@@ -5335,35 +4955,27 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": OrderInformationInput}
+                  
{"input": OrderInformationInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "guestOrder": {
       "applied_coupons": [AppliedCoupon],
       "applied_gift_cards": [ApplyGiftCardToOrder],
       "available_actions": ["REORDER"],
       "billing_address": OrderAddress,
-      "carrier": "xyz789",
+      "carrier": "abc123",
       "comments": [SalesCommentItem],
-      "created_at": "abc123",
+      "created_at": "xyz789",
       "credit_memos": [CreditMemo],
       "customer_info": OrderCustomerInfo,
-      "email": "abc123",
+      "email": "xyz789",
       "gift_message": GiftMessage,
       "gift_receipt_included": true,
       "gift_wrapping": GiftWrapping,
@@ -5371,28 +4983,26 @@ 
Response

       "id": 4,
       "increment_id": "xyz789",
       "invoices": [Invoice],
-      "is_virtual": true,
+      "is_virtual": false,
       "items": [OrderItemInterface],
       "items_eligible_for_return": [OrderItemInterface],
       "number": "xyz789",
-      "order_date": "abc123",
-      "order_number": "xyz789",
+      "order_date": "xyz789",
+      "order_number": "abc123",
       "order_status_change_date": "xyz789",
       "payment_methods": [OrderPaymentMethod],
-      "printed_card_included": false,
+      "printed_card_included": true,
       "returns": Returns,
       "shipments": [OrderShipment],
       "shipping_address": OrderAddress,
-      "shipping_method": "xyz789",
-      "status": "abc123",
+      "shipping_method": "abc123",
+      "status": "xyz789",
       "token": "abc123",
       "total": OrderTotal
     }
   }
 }
 

-                    
-
back to top @@ -5445,9 +5055,7 @@
Arguments

Example

Query
- - - 
query guestOrderByToken($input: OrderTokenInput!) {
+                  
query guestOrderByToken($input: OrderTokenInput!) {
   guestOrderByToken(input: $input) {
     applied_coupons {
       ...AppliedCouponFragment
@@ -5517,23 +5125,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": OrderTokenInput}
+                  
{"input": OrderTokenInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "guestOrderByToken": {
       "applied_coupons": [AppliedCoupon],
@@ -5549,14 +5149,14 @@ 
Response

       "gift_message": GiftMessage,
       "gift_receipt_included": true,
       "gift_wrapping": GiftWrapping,
-      "grand_total": 987.65,
-      "id": 4,
+      "grand_total": 123.45,
+      "id": "4",
       "increment_id": "xyz789",
       "invoices": [Invoice],
-      "is_virtual": true,
+      "is_virtual": false,
       "items": [OrderItemInterface],
       "items_eligible_for_return": [OrderItemInterface],
-      "number": "abc123",
+      "number": "xyz789",
       "order_date": "xyz789",
       "order_number": "xyz789",
       "order_status_change_date": "xyz789",
@@ -5566,15 +5166,13 @@ 
Response

       "shipments": [OrderShipment],
       "shipping_address": OrderAddress,
       "shipping_method": "abc123",
-      "status": "xyz789",
-      "token": "xyz789",
+      "status": "abc123",
+      "token": "abc123",
       "total": OrderTotal
     }
   }
 }
 

-                    
-
back to top @@ -5627,34 +5225,22 @@
Arguments

Example

Query
- - - 
query isCompanyAdminEmailAvailable($email: String!) {
+                  
query isCompanyAdminEmailAvailable($email: String!) {
   isCompanyAdminEmailAvailable(email: $email) {
     is_email_available
   }
 }
 

-                    
-
Variables
- - - 
{"email": "abc123"}
+                  
{"email": "abc123"}
 

-                    
-
Response
- - - 
{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}}
+                  
{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}}
 

-                    
-
back to top @@ -5707,34 +5293,22 @@
Arguments

Example

Query
- - - 
query isCompanyEmailAvailable($email: String!) {
+                  
query isCompanyEmailAvailable($email: String!) {
   isCompanyEmailAvailable(email: $email) {
     is_email_available
   }
 }
 

-                    
-
Variables
- - - 
{"email": "abc123"}
+                  
{"email": "abc123"}
 

-                    
-
Response
- - - 
{"data": {"isCompanyEmailAvailable": {"is_email_available": false}}}
+                  
{"data": {"isCompanyEmailAvailable": {"is_email_available": true}}}
 

-                    
-
back to top @@ -5787,34 +5361,22 @@
Arguments

Example

Query
- - - 
query isCompanyRoleNameAvailable($name: String!) {
+                  
query isCompanyRoleNameAvailable($name: String!) {
   isCompanyRoleNameAvailable(name: $name) {
     is_role_name_available
   }
 }
 

-                    
-
Variables
- - - 
{"name": "abc123"}
+                  
{"name": "xyz789"}
 

-                    
-
Response
- - - 
{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": false}}}
+                  
{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}}
 

-                    
-
back to top @@ -5867,34 +5429,22 @@
Arguments

Example

Query
- - - 
query isCompanyUserEmailAvailable($email: String!) {
+                  
query isCompanyUserEmailAvailable($email: String!) {
   isCompanyUserEmailAvailable(email: $email) {
     is_email_available
   }
 }
 

-                    
-
Variables
- - - 
{"email": "xyz789"}
+                  
{"email": "abc123"}
 

-                    
-
Response
- - - 
{"data": {"isCompanyUserEmailAvailable": {"is_email_available": false}}}
+                  
{"data": {"isCompanyUserEmailAvailable": {"is_email_available": true}}}
 

-                    
-
back to top @@ -5946,34 +5496,22 @@
Arguments

Example

Query
- - - 
query isEmailAvailable($email: String!) {
+                  
query isEmailAvailable($email: String!) {
   isEmailAvailable(email: $email) {
     is_email_available
   }
 }
 

-                    
-
Variables
- - - 
{"email": "abc123"}
+                  
{"email": "xyz789"}
 

-                    
-
Response
- - - 
{"data": {"isEmailAvailable": {"is_email_available": false}}}
+                  
{"data": {"isEmailAvailable": {"is_email_available": false}}}
 

-                    
-
back to top @@ -6026,9 +5564,7 @@
Arguments

Example

Query
- - - 
query negotiableQuote($uid: ID!) {
+                  
query negotiableQuote($uid: ID!) {
   negotiableQuote(uid: $uid) {
     available_payment_methods {
       ...AvailablePaymentMethodFragment
@@ -6068,23 +5604,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"uid": "4"}
+                  
{"uid": 4}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "negotiableQuote": {
       "available_payment_methods": [
@@ -6093,7 +5621,7 @@ 
Response

       "billing_address": NegotiableQuoteBillingAddress,
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
-      "created_at": "xyz789",
+      "created_at": "abc123",
       "email": "abc123",
       "history": [NegotiableQuoteHistoryEntry],
       "is_virtual": false,
@@ -6107,13 +5635,11 @@ 
Response

       "status": "SUBMITTED",
       "total_quantity": 987.65,
       "uid": "4",
-      "updated_at": "abc123"
+      "updated_at": "xyz789"
     }
   }
 }
 

-                    
-
back to top @@ -6166,9 +5692,7 @@
Arguments

Example

Query
- - - 
query negotiableQuoteTemplate($templateId: ID!) {
+                  
query negotiableQuoteTemplate($templateId: ID!) {
   negotiableQuoteTemplate(templateId: $templateId) {
     buyer {
       ...NegotiableQuoteUserFragment
@@ -6206,33 +5730,25 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"templateId": 4}
+                  
{"templateId": 4}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "negotiableQuoteTemplate": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
-      "expiration_date": "xyz789",
+      "expiration_date": "abc123",
       "history": [NegotiableQuoteHistoryEntry],
       "is_min_max_qty_used": false,
       "is_virtual": false,
       "items": [CartItemInterface],
-      "max_order_commitment": 123,
+      "max_order_commitment": 987,
       "min_order_commitment": 123,
       "name": "xyz789",
       "notifications": [QuoteTemplateNotificationMessage],
@@ -6250,8 +5766,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -6321,9 +5835,7 @@
Arguments

Example

Query
- - - 
query negotiableQuoteTemplates(
+                  
query negotiableQuoteTemplates(
   $filter: NegotiableQuoteTemplateFilterInput,
   $pageSize: Int,
   $currentPage: Int,
@@ -6348,28 +5860,20 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
+                  
{
   "filter": NegotiableQuoteTemplateFilterInput,
   "pageSize": 20,
   "currentPage": 1,
   "sort": NegotiableQuoteTemplateSortInput
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "negotiableQuoteTemplates": {
       "items": [NegotiableQuoteTemplateGridItem],
@@ -6380,8 +5884,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -6451,9 +5953,7 @@
Arguments

Example

Query
- - - 
query negotiableQuotes(
+                  
query negotiableQuotes(
   $filter: NegotiableQuoteFilterInput,
   $pageSize: Int,
   $currentPage: Int,
@@ -6478,40 +5978,30 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
+                  
{
   "filter": NegotiableQuoteFilterInput,
   "pageSize": 20,
   "currentPage": 1,
   "sort": NegotiableQuoteSortInput
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "negotiableQuotes": {
       "items": [NegotiableQuote],
       "page_info": SearchResultPageInfo,
       "sort_fields": SortFields,
-      "total_count": 987
+      "total_count": 123
     }
   }
 }
 

-                    
-
back to top @@ -6593,9 +6083,7 @@
Arguments

Example

Query
- - - 
query pickupLocations(
+                  
query pickupLocations(
   $area: AreaInput,
   $filters: PickupLocationFilterInput,
   $sort: PickupLocationSortInput,
@@ -6621,14 +6109,10 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
+                  
{
   "area": AreaInput,
   "filters": PickupLocationFilterInput,
   "sort": PickupLocationSortInput,
@@ -6637,25 +6121,19 @@ 
Variables

   "productsInfo": [ProductInfoInput]
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "pickupLocations": {
       "items": [PickupLocation],
       "page_info": SearchResultPageInfo,
-      "total_count": 123
+      "total_count": 987
     }
   }
 }
 

-                    
-
back to top @@ -6688,9 +6166,7 @@
Response

Example

Query
- - - 
query productReviewRatingsMetadata {
+                  
query productReviewRatingsMetadata {
   productReviewRatingsMetadata {
     items {
       ...ProductReviewRatingMetadataFragment
@@ -6698,14 +6174,10 @@ 
Query

   }
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "productReviewRatingsMetadata": {
       "items": [ProductReviewRatingMetadata]
@@ -6713,8 +6185,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -6790,9 +6260,7 @@
Arguments

Example

Query
- - - 
query products(
+                  
query products(
   $search: String,
   $filter: ProductAttributeFilterInput,
   $pageSize: Int,
@@ -6828,14 +6296,10 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
+                  
{
   "search": "abc123",
   "filter": ProductAttributeFilterInput,
   "pageSize": 20,
@@ -6843,14 +6307,10 @@ 
Variables

   "sort": ProductAttributeSortInput
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "products": {
       "aggregations": [Aggregation],
@@ -6859,13 +6319,11 @@ 
Response

       "page_info": SearchResultPageInfo,
       "sort_fields": SortFields,
       "suggestions": [SearchSuggestion],
-      "total_count": 987
+      "total_count": 123
     }
   }
 }
 

-                    
-
back to top @@ -6910,9 +6368,7 @@
Arguments

Example

Query
- - - 
query recaptchaFormConfig($formType: ReCaptchaFormEnum!) {
+                  
query recaptchaFormConfig($formType: ReCaptchaFormEnum!) {
   recaptchaFormConfig(formType: $formType) {
     configurations {
       ...ReCaptchaConfigurationFragment
@@ -6921,23 +6377,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"formType": "PLACE_ORDER"}
+                  
{"formType": "PLACE_ORDER"}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "recaptchaFormConfig": {
       "configurations": ReCaptchaConfiguration,
@@ -6946,8 +6394,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -6980,9 +6426,7 @@
Response

Example

Query
- - - 
query recaptchaV3Config {
+                  
query recaptchaV3Config {
   recaptchaV3Config {
     badge_position
     failure_message
@@ -6995,30 +6439,24 @@ 
Query

   }
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "recaptchaV3Config": {
-      "badge_position": "abc123",
-      "failure_message": "abc123",
+      "badge_position": "xyz789",
+      "failure_message": "xyz789",
       "forms": ["PLACE_ORDER"],
-      "is_enabled": false,
-      "language_code": "xyz789",
+      "is_enabled": true,
+      "language_code": "abc123",
       "minimum_score": 123.45,
       "theme": "xyz789",
-      "website_key": "abc123"
+      "website_key": "xyz789"
     }
   }
 }
 

-                    
-
back to top @@ -7070,9 +6508,7 @@
Arguments

Example

Query
- - - 
query route($url: String!) {
+                  
query route($url: String!) {
   route(url: $url) {
     redirect_code
     relative_url
@@ -7080,23 +6516,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"url": "xyz789"}
+                  
{"url": "abc123"}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "route": {
       "redirect_code": 987,
@@ -7106,8 +6534,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -7140,9 +6566,7 @@
Response

Example

Query
- - - 
query storeConfig {
+                  
query storeConfig {
   storeConfig {
     absolute_footer
     allow_gift_receipt
@@ -7396,72 +6820,68 @@ 
Query

   }
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "storeConfig": {
       "absolute_footer": "xyz789",
       "allow_gift_receipt": "xyz789",
-      "allow_gift_wrapping_on_order": "abc123",
-      "allow_gift_wrapping_on_order_items": "abc123",
-      "allow_guests_to_write_product_reviews": "xyz789",
+      "allow_gift_wrapping_on_order": "xyz789",
+      "allow_gift_wrapping_on_order_items": "xyz789",
+      "allow_guests_to_write_product_reviews": "abc123",
       "allow_items": "abc123",
-      "allow_order": "xyz789",
-      "allow_printed_card": "abc123",
+      "allow_order": "abc123",
+      "allow_printed_card": "xyz789",
       "autocomplete_on_storefront": true,
-      "base_currency_code": "xyz789",
-      "base_link_url": "xyz789",
+      "base_currency_code": "abc123",
+      "base_link_url": "abc123",
       "base_media_url": "xyz789",
       "base_static_url": "abc123",
-      "base_url": "xyz789",
+      "base_url": "abc123",
       "braintree_3dsecure_allowspecific": true,
-      "braintree_3dsecure_always_request_3ds": true,
-      "braintree_3dsecure_specificcountry": "abc123",
+      "braintree_3dsecure_always_request_3ds": false,
+      "braintree_3dsecure_specificcountry": "xyz789",
       "braintree_3dsecure_threshold_amount": "abc123",
       "braintree_3dsecure_verify_3dsecure": false,
-      "braintree_ach_direct_debit_vault_active": false,
-      "braintree_applepay_merchant_name": "abc123",
-      "braintree_applepay_vault_active": false,
-      "braintree_cc_vault_active": "xyz789",
-      "braintree_cc_vault_cvv": true,
+      "braintree_ach_direct_debit_vault_active": true,
+      "braintree_applepay_merchant_name": "xyz789",
+      "braintree_applepay_vault_active": true,
+      "braintree_cc_vault_active": "abc123",
+      "braintree_cc_vault_cvv": false,
       "braintree_environment": "abc123",
       "braintree_googlepay_btn_color": "abc123",
       "braintree_googlepay_cctypes": "xyz789",
       "braintree_googlepay_merchant_id": "abc123",
       "braintree_googlepay_vault_active": true,
-      "braintree_local_payment_allowed_methods": "xyz789",
+      "braintree_local_payment_allowed_methods": "abc123",
       "braintree_local_payment_fallback_button_text": "abc123",
       "braintree_local_payment_redirect_on_fail": "xyz789",
       "braintree_merchant_account_id": "xyz789",
       "braintree_paypal_button_location_cart_type_credit_color": "abc123",
-      "braintree_paypal_button_location_cart_type_credit_label": "xyz789",
-      "braintree_paypal_button_location_cart_type_credit_shape": "abc123",
+      "braintree_paypal_button_location_cart_type_credit_label": "abc123",
+      "braintree_paypal_button_location_cart_type_credit_shape": "xyz789",
       "braintree_paypal_button_location_cart_type_credit_show": true,
       "braintree_paypal_button_location_cart_type_messaging_layout": "abc123",
       "braintree_paypal_button_location_cart_type_messaging_logo": "abc123",
       "braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123",
       "braintree_paypal_button_location_cart_type_messaging_show": true,
-      "braintree_paypal_button_location_cart_type_messaging_text_color": "xyz789",
-      "braintree_paypal_button_location_cart_type_paylater_color": "xyz789",
-      "braintree_paypal_button_location_cart_type_paylater_label": "abc123",
-      "braintree_paypal_button_location_cart_type_paylater_shape": "xyz789",
-      "braintree_paypal_button_location_cart_type_paylater_show": true,
+      "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123",
+      "braintree_paypal_button_location_cart_type_paylater_color": "abc123",
+      "braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
+      "braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
+      "braintree_paypal_button_location_cart_type_paylater_show": false,
       "braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
       "braintree_paypal_button_location_cart_type_paypal_label": "abc123",
       "braintree_paypal_button_location_cart_type_paypal_shape": "abc123",
       "braintree_paypal_button_location_cart_type_paypal_show": false,
-      "braintree_paypal_button_location_checkout_type_credit_color": "abc123",
+      "braintree_paypal_button_location_checkout_type_credit_color": "xyz789",
       "braintree_paypal_button_location_checkout_type_credit_label": "abc123",
-      "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789",
-      "braintree_paypal_button_location_checkout_type_credit_show": false,
+      "braintree_paypal_button_location_checkout_type_credit_shape": "abc123",
+      "braintree_paypal_button_location_checkout_type_credit_show": true,
       "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789",
-      "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789",
+      "braintree_paypal_button_location_checkout_type_messaging_logo": "abc123",
       "braintree_paypal_button_location_checkout_type_messaging_logo_position": "abc123",
       "braintree_paypal_button_location_checkout_type_messaging_show": true,
       "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123",
@@ -7473,188 +6893,186 @@ 
Response

       "braintree_paypal_button_location_checkout_type_paypal_label": "abc123",
       "braintree_paypal_button_location_checkout_type_paypal_shape": "abc123",
       "braintree_paypal_button_location_checkout_type_paypal_show": false,
-      "braintree_paypal_button_location_productpage_type_credit_color": "xyz789",
+      "braintree_paypal_button_location_productpage_type_credit_color": "abc123",
       "braintree_paypal_button_location_productpage_type_credit_label": "abc123",
       "braintree_paypal_button_location_productpage_type_credit_shape": "xyz789",
       "braintree_paypal_button_location_productpage_type_credit_show": true,
       "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789",
       "braintree_paypal_button_location_productpage_type_messaging_logo": "xyz789",
-      "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789",
-      "braintree_paypal_button_location_productpage_type_messaging_show": false,
+      "braintree_paypal_button_location_productpage_type_messaging_logo_position": "abc123",
+      "braintree_paypal_button_location_productpage_type_messaging_show": true,
       "braintree_paypal_button_location_productpage_type_messaging_text_color": "xyz789",
       "braintree_paypal_button_location_productpage_type_paylater_color": "abc123",
       "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789",
-      "braintree_paypal_button_location_productpage_type_paylater_shape": "abc123",
-      "braintree_paypal_button_location_productpage_type_paylater_show": true,
+      "braintree_paypal_button_location_productpage_type_paylater_shape": "xyz789",
+      "braintree_paypal_button_location_productpage_type_paylater_show": false,
       "braintree_paypal_button_location_productpage_type_paypal_color": "abc123",
-      "braintree_paypal_button_location_productpage_type_paypal_label": "abc123",
+      "braintree_paypal_button_location_productpage_type_paypal_label": "xyz789",
       "braintree_paypal_button_location_productpage_type_paypal_shape": "xyz789",
       "braintree_paypal_button_location_productpage_type_paypal_show": true,
       "braintree_paypal_credit_uk_merchant_name": "abc123",
       "braintree_paypal_display_on_shopping_cart": true,
-      "braintree_paypal_merchant_country": "xyz789",
+      "braintree_paypal_merchant_country": "abc123",
       "braintree_paypal_merchant_name_override": "xyz789",
       "braintree_paypal_require_billing_address": false,
-      "braintree_paypal_send_cart_line_items": true,
-      "braintree_paypal_vault_active": false,
-      "cart_expires_in_days": 123,
+      "braintree_paypal_send_cart_line_items": false,
+      "braintree_paypal_vault_active": true,
+      "cart_expires_in_days": 987,
       "cart_gift_wrapping": "abc123",
-      "cart_printed_card": "abc123",
+      "cart_printed_card": "xyz789",
       "cart_summary_display_quantity": 123,
       "catalog_default_sort_by": "xyz789",
       "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-      "category_url_suffix": "abc123",
+      "category_url_suffix": "xyz789",
       "check_money_order_enable_for_specific_countries": false,
-      "check_money_order_enabled": false,
+      "check_money_order_enabled": true,
       "check_money_order_make_check_payable_to": "xyz789",
       "check_money_order_max_order_total": "abc123",
       "check_money_order_min_order_total": "xyz789",
-      "check_money_order_new_order_status": "xyz789",
+      "check_money_order_new_order_status": "abc123",
       "check_money_order_payment_from_specific_countries": "xyz789",
       "check_money_order_send_check_to": "abc123",
-      "check_money_order_sort_order": 123,
-      "check_money_order_title": "abc123",
-      "cms_home_page": "xyz789",
+      "check_money_order_sort_order": 987,
+      "check_money_order_title": "xyz789",
+      "cms_home_page": "abc123",
       "cms_no_cookies": "abc123",
       "cms_no_route": "xyz789",
-      "code": "abc123",
+      "code": "xyz789",
       "configurable_product_image": "ITSELF",
-      "configurable_thumbnail_source": "xyz789",
+      "configurable_thumbnail_source": "abc123",
       "contact_enabled": true,
-      "copyright": "xyz789",
-      "countries_with_required_region": "abc123",
-      "create_account_confirmation": true,
+      "copyright": "abc123",
+      "countries_with_required_region": "xyz789",
+      "create_account_confirmation": false,
       "customer_access_token_lifetime": 123.45,
       "default_country": "abc123",
       "default_description": "abc123",
       "default_display_currency_code": "xyz789",
       "default_keywords": "abc123",
-      "default_title": "xyz789",
-      "demonotice": 987,
+      "default_title": "abc123",
+      "demonotice": 123,
       "display_product_prices_in_catalog": 123,
-      "display_shipping_prices": 987,
-      "display_state_if_optional": true,
+      "display_shipping_prices": 123,
+      "display_state_if_optional": false,
       "enable_multiple_wishlists": "xyz789",
       "fixed_product_taxes_apply_tax_to_fpt": true,
-      "fixed_product_taxes_display_prices_in_emails": 123,
-      "fixed_product_taxes_display_prices_in_product_lists": 987,
+      "fixed_product_taxes_display_prices_in_emails": 987,
+      "fixed_product_taxes_display_prices_in_product_lists": 123,
       "fixed_product_taxes_display_prices_in_sales_modules": 123,
-      "fixed_product_taxes_display_prices_on_product_view_page": 123,
-      "fixed_product_taxes_enable": false,
+      "fixed_product_taxes_display_prices_on_product_view_page": 987,
+      "fixed_product_taxes_enable": true,
       "fixed_product_taxes_include_fpt_in_subtotal": false,
-      "front": "abc123",
-      "graphql_share_all_customer_groups": false,
-      "graphql_share_customer_group": true,
+      "front": "xyz789",
+      "graphql_share_all_customer_groups": true,
+      "graphql_share_customer_group": false,
       "grid_per_page": 987,
-      "grid_per_page_values": "xyz789",
+      "grid_per_page_values": "abc123",
       "grouped_product_image": "ITSELF",
       "head_includes": "xyz789",
-      "head_shortcut_icon": "xyz789",
-      "header_logo_src": "xyz789",
+      "head_shortcut_icon": "abc123",
+      "header_logo_src": "abc123",
       "id": 123,
       "is_checkout_agreements_enabled": true,
       "is_default_store": true,
-      "is_default_store_group": false,
-      "is_guest_checkout_enabled": false,
+      "is_default_store_group": true,
+      "is_guest_checkout_enabled": true,
       "is_negotiable_quote_active": true,
-      "is_one_page_checkout_enabled": false,
-      "is_requisition_list_active": "abc123",
+      "is_one_page_checkout_enabled": true,
+      "is_requisition_list_active": "xyz789",
       "list_mode": "xyz789",
       "list_per_page": 987,
-      "list_per_page_values": "abc123",
-      "locale": "abc123",
-      "logo_alt": "xyz789",
+      "list_per_page_values": "xyz789",
+      "locale": "xyz789",
+      "logo_alt": "abc123",
       "logo_height": 987,
       "logo_width": 987,
-      "magento_reward_general_is_enabled": "abc123",
+      "magento_reward_general_is_enabled": "xyz789",
       "magento_reward_general_is_enabled_on_front": "abc123",
-      "magento_reward_general_min_points_balance": "abc123",
+      "magento_reward_general_min_points_balance": "xyz789",
       "magento_reward_general_publish_history": "abc123",
       "magento_reward_points_invitation_customer": "abc123",
       "magento_reward_points_invitation_customer_limit": "abc123",
-      "magento_reward_points_invitation_order": "abc123",
+      "magento_reward_points_invitation_order": "xyz789",
       "magento_reward_points_invitation_order_limit": "abc123",
-      "magento_reward_points_newsletter": "xyz789",
-      "magento_reward_points_order": "abc123",
-      "magento_reward_points_register": "xyz789",
+      "magento_reward_points_newsletter": "abc123",
+      "magento_reward_points_order": "xyz789",
+      "magento_reward_points_register": "abc123",
       "magento_reward_points_review": "xyz789",
-      "magento_reward_points_review_limit": "xyz789",
-      "magento_wishlist_general_is_enabled": "xyz789",
+      "magento_reward_points_review_limit": "abc123",
+      "magento_wishlist_general_is_enabled": "abc123",
       "max_items_in_order_summary": 123,
       "maximum_number_of_wishlists": "abc123",
       "minicart_display": true,
-      "minicart_max_items": 123,
-      "minimum_password_length": "abc123",
+      "minicart_max_items": 987,
+      "minimum_password_length": "xyz789",
       "newsletter_enabled": false,
       "no_route": "abc123",
-      "optional_zip_countries": "abc123",
-      "order_cancellation_enabled": false,
+      "optional_zip_countries": "xyz789",
+      "order_cancellation_enabled": true,
       "order_cancellation_reasons": [CancellationReason],
       "orders_invoices_credit_memos_display_full_summary": false,
-      "orders_invoices_credit_memos_display_grandtotal": true,
+      "orders_invoices_credit_memos_display_grandtotal": false,
       "orders_invoices_credit_memos_display_price": 987,
       "orders_invoices_credit_memos_display_shipping_amount": 123,
-      "orders_invoices_credit_memos_display_subtotal": 987,
-      "orders_invoices_credit_memos_display_zero_tax": true,
-      "payment_payflowpro_cc_vault_active": "xyz789",
+      "orders_invoices_credit_memos_display_subtotal": 123,
+      "orders_invoices_credit_memos_display_zero_tax": false,
+      "payment_payflowpro_cc_vault_active": "abc123",
       "printed_card_price": "xyz789",
       "printed_card_priceV2": Money,
       "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
       "product_reviews_enabled": "abc123",
-      "product_url_suffix": "xyz789",
-      "quickorder_active": false,
-      "required_character_classes_number": "xyz789",
+      "product_url_suffix": "abc123",
+      "quickorder_active": true,
+      "required_character_classes_number": "abc123",
       "returns_enabled": "abc123",
-      "root_category_id": 123,
-      "root_category_uid": "4",
+      "root_category_id": 987,
+      "root_category_uid": 4,
       "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
       "sales_gift_wrapping": "xyz789",
-      "sales_printed_card": "abc123",
-      "secure_base_link_url": "xyz789",
+      "sales_printed_card": "xyz789",
+      "secure_base_link_url": "abc123",
       "secure_base_media_url": "abc123",
-      "secure_base_static_url": "xyz789",
+      "secure_base_static_url": "abc123",
       "secure_base_url": "abc123",
       "send_friend": SendFriendConfiguration,
-      "share_all_catalog_rules": true,
+      "share_all_catalog_rules": false,
       "share_all_sales_rule": false,
-      "share_applied_catalog_rules": false,
+      "share_applied_catalog_rules": true,
       "share_applied_sales_rule": false,
-      "shopping_cart_display_full_summary": false,
+      "shopping_cart_display_full_summary": true,
       "shopping_cart_display_grand_total": true,
-      "shopping_cart_display_price": 123,
+      "shopping_cart_display_price": 987,
       "shopping_cart_display_shipping": 123,
       "shopping_cart_display_subtotal": 987,
       "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
-      "shopping_cart_display_zero_tax": false,
+      "shopping_cart_display_zero_tax": true,
       "show_cms_breadcrumbs": 987,
       "store_code": "4",
       "store_group_code": 4,
       "store_group_name": "abc123",
       "store_name": "xyz789",
-      "store_sort_order": 123,
+      "store_sort_order": 987,
       "timezone": "xyz789",
-      "title_prefix": "xyz789",
+      "title_prefix": "abc123",
       "title_separator": "abc123",
       "title_suffix": "abc123",
       "use_store_in_url": true,
       "website_code": "4",
-      "website_id": 123,
+      "website_id": 987,
       "website_name": "xyz789",
-      "weight_unit": "xyz789",
-      "welcome": "xyz789",
+      "weight_unit": "abc123",
+      "welcome": "abc123",
       "zero_subtotal_enable_for_specific_countries": false,
       "zero_subtotal_enabled": true,
-      "zero_subtotal_new_order_status": "abc123",
-      "zero_subtotal_payment_action": "xyz789",
-      "zero_subtotal_payment_from_specific_countries": "xyz789",
+      "zero_subtotal_new_order_status": "xyz789",
+      "zero_subtotal_payment_action": "abc123",
+      "zero_subtotal_payment_from_specific_countries": "abc123",
       "zero_subtotal_sort_order": 123,
       "zero_subtotal_title": "abc123"
     }
   }
 }
 

-                    
-
back to top @@ -7713,9 +7131,7 @@
Arguments

Example

Query
- - - 
query urlResolver($url: String!) {
+                  
query urlResolver($url: String!) {
   urlResolver(url: $url) {
     canonical_url
     entity_uid
@@ -7726,37 +7142,27 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"url": "xyz789"}
+                  
{"url": "xyz789"}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "urlResolver": {
-      "canonical_url": "abc123",
-      "entity_uid": 4,
-      "id": 987,
-      "redirectCode": 123,
+      "canonical_url": "xyz789",
+      "entity_uid": "4",
+      "id": 123,
+      "redirectCode": 987,
       "relative_url": "xyz789",
       "type": "CMS_PAGE"
     }
   }
 }
 

-                    
-
back to top @@ -7796,9 +7202,7 @@
Response

Example

Query
- - - 
query wishlist {
+                  
query wishlist {
   wishlist {
     items {
       ...WishlistItemFragment
@@ -7810,27 +7214,21 @@ 
Query

   }
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "wishlist": {
       "items": [WishlistItem],
       "items_count": 987,
       "name": "abc123",
       "sharing_code": "xyz789",
-      "updated_at": "xyz789"
+      "updated_at": "abc123"
     }
   }
 }
 

-                    
-
back to top @@ -7881,34 +7279,22 @@
Arguments

Example

Query
- - - 
mutation acceptCompanyInvitation($input: CompanyInvitationInput!) {
+                  
mutation acceptCompanyInvitation($input: CompanyInvitationInput!) {
   acceptCompanyInvitation(input: $input) {
     success
   }
 }
 

-                    
-
Variables
- - - 
{"input": CompanyInvitationInput}
+                  
{"input": CompanyInvitationInput}
 

-                    
-
Response
- - - 
{"data": {"acceptCompanyInvitation": {"success": false}}}
+                  
{"data": {"acceptCompanyInvitation": {"success": false}}}
 

-                    
-
back to top @@ -7960,9 +7346,7 @@
Arguments

Example

Query
- - - 
mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInput!) {
+                  
mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInput!) {
   acceptNegotiableQuoteTemplate(input: $input) {
     buyer {
       ...NegotiableQuoteUserFragment
@@ -8000,34 +7384,26 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": AcceptNegotiableQuoteTemplateInput}
+                  
{"input": AcceptNegotiableQuoteTemplateInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "acceptNegotiableQuoteTemplate": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
-      "expiration_date": "xyz789",
+      "expiration_date": "abc123",
       "history": [NegotiableQuoteHistoryEntry],
       "is_min_max_qty_used": true,
       "is_virtual": true,
       "items": [CartItemInterface],
       "max_order_commitment": 123,
-      "min_order_commitment": 123,
+      "min_order_commitment": 987,
       "name": "abc123",
       "notifications": [QuoteTemplateNotificationMessage],
       "prices": CartPrices,
@@ -8039,13 +7415,11 @@ 
Response

       ],
       "status": "abc123",
       "template_id": 4,
-      "total_quantity": 987.65
+      "total_quantity": 123.45
     }
   }
 }
 

-                    
-
back to top @@ -8097,9 +7471,7 @@
Arguments

Example

Query
- - - 
mutation addBundleProductsToCart($input: AddBundleProductsToCartInput) {
+                  
mutation addBundleProductsToCart($input: AddBundleProductsToCartInput) {
   addBundleProductsToCart(input: $input) {
     cart {
       ...CartFragment
@@ -8107,26 +7479,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": AddBundleProductsToCartInput}
+                  
{"input": AddBundleProductsToCartInput}
 

-                    
-
Response
- - - 
{"data": {"addBundleProductsToCart": {"cart": Cart}}}
+                  
{"data": {"addBundleProductsToCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -8178,9 +7540,7 @@
Arguments

Example

Query
- - - 
mutation addConfigurableProductsToCart($input: AddConfigurableProductsToCartInput) {
+                  
mutation addConfigurableProductsToCart($input: AddConfigurableProductsToCartInput) {
   addConfigurableProductsToCart(input: $input) {
     cart {
       ...CartFragment
@@ -8188,30 +7548,20 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": AddConfigurableProductsToCartInput}
+                  
{"input": AddConfigurableProductsToCartInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "addConfigurableProductsToCart": {"cart": Cart}
   }
 }
 

-                    
-
back to top @@ -8263,9 +7613,7 @@
Arguments

Example

Query
- - - 
mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInput) {
+                  
mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInput) {
   addDownloadableProductsToCart(input: $input) {
     cart {
       ...CartFragment
@@ -8273,30 +7621,20 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": AddDownloadableProductsToCartInput}
+                  
{"input": AddDownloadableProductsToCartInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "addDownloadableProductsToCart": {"cart": Cart}
   }
 }
 

-                    
-
back to top @@ -8354,9 +7692,7 @@
Arguments

Example

Query
- - - 
mutation addGiftRegistryRegistrants(
+                  
mutation addGiftRegistryRegistrants(
   $giftRegistryUid: ID!,
   $registrants: [AddGiftRegistryRegistrantInput!]!
 ) {
@@ -8370,26 +7706,18 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
-  "giftRegistryUid": "4",
+                  
{
+  "giftRegistryUid": 4,
   "registrants": [AddGiftRegistryRegistrantInput]
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "addGiftRegistryRegistrants": {
       "gift_registry": GiftRegistry
@@ -8397,8 +7725,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -8456,9 +7782,7 @@
Arguments

Example

Query
- - - 
mutation addProductsToCart(
+                  
mutation addProductsToCart(
   $cartId: String!,
   $cartItems: [CartItemInput!]!
 ) {
@@ -8475,26 +7799,18 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
+                  
{
   "cartId": "abc123",
   "cartItems": [CartItemInput]
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "addProductsToCart": {
       "cart": Cart,
@@ -8503,8 +7819,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -8556,9 +7870,7 @@
Arguments

Example

Query
- - - 
mutation addProductsToCompareList($input: AddProductsToCompareListInput) {
+                  
mutation addProductsToCompareList($input: AddProductsToCompareListInput) {
   addProductsToCompareList(input: $input) {
     attributes {
       ...ComparableAttributeFragment
@@ -8571,35 +7883,25 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": AddProductsToCompareListInput}
+                  
{"input": AddProductsToCompareListInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "addProductsToCompareList": {
       "attributes": [ComparableAttribute],
-      "item_count": 123,
+      "item_count": 987,
       "items": [ComparableItem],
       "uid": 4
     }
   }
 }
 

-                    
-
back to top @@ -8657,9 +7959,7 @@
Arguments

Example

Query
- - - 
mutation addProductsToRequisitionList(
+                  
mutation addProductsToRequisitionList(
   $requisitionListUid: ID!,
   $requisitionListItems: [RequisitionListItemsInput!]!
 ) {
@@ -8673,26 +7973,18 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
+                  
{
   "requisitionListUid": 4,
   "requisitionListItems": [RequisitionListItemsInput]
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "addProductsToRequisitionList": {
       "requisition_list": RequisitionList
@@ -8700,8 +7992,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -8759,9 +8049,7 @@
Arguments

Example

Query
- - - 
mutation addProductsToWishlist(
+                  
mutation addProductsToWishlist(
   $wishlistId: ID!,
   $wishlistItems: [WishlistItemInput!]!
 ) {
@@ -8778,23 +8066,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"wishlistId": 4, "wishlistItems": [WishlistItemInput]}
+                  
{"wishlistId": 4, "wishlistItems": [WishlistItemInput]}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "addProductsToWishlist": {
       "user_errors": [WishListUserInputError],
@@ -8803,8 +8083,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -8857,9 +8135,7 @@
Arguments

Example

Query
- - - 
mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) {
+                  
mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) {
   addPurchaseOrderComment(input: $input) {
     comment {
       ...PurchaseOrderCommentFragment
@@ -8867,23 +8143,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": AddPurchaseOrderCommentInput}
+                  
{"input": AddPurchaseOrderCommentInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "addPurchaseOrderComment": {
       "comment": PurchaseOrderComment
@@ -8891,8 +8159,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -8945,9 +8211,7 @@
Arguments

Example

Query
- - - 
mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) {
+                  
mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) {
   addPurchaseOrderItemsToCart(input: $input) {
     cart {
       ...CartFragment
@@ -8958,23 +8222,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": AddPurchaseOrderItemsToCartInput}
+                  
{"input": AddPurchaseOrderItemsToCartInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "addPurchaseOrderItemsToCart": {
       "cart": Cart,
@@ -8983,8 +8239,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -9042,9 +8296,7 @@
Arguments

Example

Query
- - - 
mutation addRequisitionListItemsToCart(
+                  
mutation addRequisitionListItemsToCart(
   $requisitionListUid: ID!,
   $requisitionListItemUids: [ID!]
 ) {
@@ -9062,23 +8314,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"requisitionListUid": 4, "requisitionListItemUids": [4]}
+                  
{"requisitionListUid": 4, "requisitionListItemUids": [4]}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "addRequisitionListItemsToCart": {
       "add_requisition_list_items_to_cart_user_errors": [
@@ -9090,8 +8334,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -9143,9 +8385,7 @@
Arguments

Example

Query
- - - 
mutation addReturnComment($input: AddReturnCommentInput!) {
+                  
mutation addReturnComment($input: AddReturnCommentInput!) {
   addReturnComment(input: $input) {
     return {
       ...ReturnFragment
@@ -9153,26 +8393,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": AddReturnCommentInput}
+                  
{"input": AddReturnCommentInput}
 

-                    
-
Response
- - - 
{"data": {"addReturnComment": {"return": Return}}}
+                  
{"data": {"addReturnComment": {"return": Return}}}
 

-                    
-
back to top @@ -9224,9 +8454,7 @@
Arguments

Example

Query
- - - 
mutation addReturnTracking($input: AddReturnTrackingInput!) {
+                  
mutation addReturnTracking($input: AddReturnTrackingInput!) {
   addReturnTracking(input: $input) {
     return {
       ...ReturnFragment
@@ -9237,23 +8465,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": AddReturnTrackingInput}
+                  
{"input": AddReturnTrackingInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "addReturnTracking": {
       "return": Return,
@@ -9262,8 +8482,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -9315,9 +8533,7 @@
Arguments

Example

Query
- - - 
mutation addSimpleProductsToCart($input: AddSimpleProductsToCartInput) {
+                  
mutation addSimpleProductsToCart($input: AddSimpleProductsToCartInput) {
   addSimpleProductsToCart(input: $input) {
     cart {
       ...CartFragment
@@ -9325,26 +8541,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": AddSimpleProductsToCartInput}
+                  
{"input": AddSimpleProductsToCartInput}
 

-                    
-
Response
- - - 
{"data": {"addSimpleProductsToCart": {"cart": Cart}}}
+                  
{"data": {"addSimpleProductsToCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -9396,9 +8602,7 @@
Arguments

Example

Query
- - - 
mutation addVirtualProductsToCart($input: AddVirtualProductsToCartInput) {
+                  
mutation addVirtualProductsToCart($input: AddVirtualProductsToCartInput) {
   addVirtualProductsToCart(input: $input) {
     cart {
       ...CartFragment
@@ -9406,26 +8610,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": AddVirtualProductsToCartInput}
+                  
{"input": AddVirtualProductsToCartInput}
 

-                    
-
Response
- - - 
{"data": {"addVirtualProductsToCart": {"cart": Cart}}}
+                  
{"data": {"addVirtualProductsToCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -9483,9 +8677,7 @@
Arguments

Example

Query
- - - 
mutation addWishlistItemsToCart(
+                  
mutation addWishlistItemsToCart(
   $wishlistId: ID!,
   $wishlistItemIds: [ID!]
 ) {
@@ -9503,36 +8695,26 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"wishlistId": 4, "wishlistItemIds": [4]}
+                  
{"wishlistId": "4", "wishlistItemIds": [4]}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "addWishlistItemsToCart": {
       "add_wishlist_items_to_cart_user_errors": [
         WishlistCartUserInputError
       ],
-      "status": false,
+      "status": true,
       "wishlist": Wishlist
     }
   }
 }
 

-                    
-
back to top @@ -9584,9 +8766,7 @@
Arguments

Example

Query
- - - 
mutation applyCouponToCart($input: ApplyCouponToCartInput) {
+                  
mutation applyCouponToCart($input: ApplyCouponToCartInput) {
   applyCouponToCart(input: $input) {
     cart {
       ...CartFragment
@@ -9594,26 +8774,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": ApplyCouponToCartInput}
+                  
{"input": ApplyCouponToCartInput}
 

-                    
-
Response
- - - 
{"data": {"applyCouponToCart": {"cart": Cart}}}
+                  
{"data": {"applyCouponToCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -9665,9 +8835,7 @@
Arguments

Example

Query
- - - 
mutation applyCouponsToCart($input: ApplyCouponsToCartInput) {
+                  
mutation applyCouponsToCart($input: ApplyCouponsToCartInput) {
   applyCouponsToCart(input: $input) {
     cart {
       ...CartFragment
@@ -9675,26 +8843,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": ApplyCouponsToCartInput}
+                  
{"input": ApplyCouponsToCartInput}
 

-                    
-
Response
- - - 
{"data": {"applyCouponsToCart": {"cart": Cart}}}
+                  
{"data": {"applyCouponsToCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -9746,9 +8904,7 @@
Arguments

Example

Query
- - - 
mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) {
+                  
mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) {
   applyGiftCardToCart(input: $input) {
     cart {
       ...CartFragment
@@ -9756,26 +8912,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": ApplyGiftCardToCartInput}
+                  
{"input": ApplyGiftCardToCartInput}
 

-                    
-
Response
- - - 
{"data": {"applyGiftCardToCart": {"cart": Cart}}}
+                  
{"data": {"applyGiftCardToCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -9828,9 +8974,7 @@
Arguments

Example

Query
- - - 
mutation applyRewardPointsToCart($cartId: ID!) {
+                  
mutation applyRewardPointsToCart($cartId: ID!) {
   applyRewardPointsToCart(cartId: $cartId) {
     cart {
       ...CartFragment
@@ -9838,26 +8982,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"cartId": 4}
+                  
{"cartId": "4"}
 

-                    
-
Response
- - - 
{"data": {"applyRewardPointsToCart": {"cart": Cart}}}
+                  
{"data": {"applyRewardPointsToCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -9909,9 +9043,7 @@
Arguments

Example

Query
- - - 
mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) {
+                  
mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) {
   applyStoreCreditToCart(input: $input) {
     cart {
       ...CartFragment
@@ -9919,26 +9051,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": ApplyStoreCreditToCartInput}
+                  
{"input": ApplyStoreCreditToCartInput}
 

-                    
-
Response
- - - 
{"data": {"applyStoreCreditToCart": {"cart": Cart}}}
+                  
{"data": {"applyStoreCreditToCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -9991,9 +9113,7 @@
Arguments

Example

Query
- - - 
mutation approvePurchaseOrders($input: PurchaseOrdersActionInput!) {
+                  
mutation approvePurchaseOrders($input: PurchaseOrdersActionInput!) {
   approvePurchaseOrders(input: $input) {
     errors {
       ...PurchaseOrderActionErrorFragment
@@ -10004,23 +9124,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": PurchaseOrdersActionInput}
+                  
{"input": PurchaseOrdersActionInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "approvePurchaseOrders": {
       "errors": [PurchaseOrderActionError],
@@ -10029,8 +9141,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -10082,9 +9192,7 @@
Arguments

Example

Query
- - - 
mutation assignCompareListToCustomer($uid: ID!) {
+                  
mutation assignCompareListToCustomer($uid: ID!) {
   assignCompareListToCustomer(uid: $uid) {
     compare_list {
       ...CompareListFragment
@@ -10093,33 +9201,23 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"uid": 4}
+                  
{"uid": 4}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "assignCompareListToCustomer": {
       "compare_list": CompareList,
-      "result": false
+      "result": true
     }
   }
 }
 

-                    
-
back to top @@ -10172,9 +9270,7 @@
Arguments

Example

Query
- - - 
mutation assignCustomerToGuestCart($cart_id: String!) {
+                  
mutation assignCustomerToGuestCart($cart_id: String!) {
   assignCustomerToGuestCart(cart_id: $cart_id) {
     applied_coupon {
       ...AppliedCouponFragment
@@ -10233,23 +9329,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"cart_id": "xyz789"}
+                  
{"cart_id": "xyz789"}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "assignCustomerToGuestCart": {
       "applied_coupon": AppliedCoupon,
@@ -10262,12 +9350,12 @@ 
Response

         AvailablePaymentMethod
       ],
       "billing_address": BillingCartAddress,
-      "email": "xyz789",
+      "email": "abc123",
       "gift_message": GiftMessage,
-      "gift_receipt_included": true,
+      "gift_receipt_included": false,
       "gift_wrapping": GiftWrapping,
-      "id": 4,
-      "is_virtual": true,
+      "id": "4",
+      "is_virtual": false,
       "items": [CartItemInterface],
       "itemsV2": CartItems,
       "prices": CartPrices,
@@ -10275,13 +9363,11 @@ 
Response

       "rules": [CartRule],
       "selected_payment_method": SelectedPaymentMethod,
       "shipping_addresses": [ShippingCartAddress],
-      "total_quantity": 123.45
+      "total_quantity": 987.65
     }
   }
 }
 

-                    
-
back to top @@ -10333,9 +9419,7 @@
Arguments

Example

Query
- - - 
mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInput!) {
+                  
mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInput!) {
   cancelNegotiableQuoteTemplate(input: $input) {
     buyer {
       ...NegotiableQuoteUserFragment
@@ -10373,31 +9457,23 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CancelNegotiableQuoteTemplateInput}
+                  
{"input": CancelNegotiableQuoteTemplateInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "cancelNegotiableQuoteTemplate": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
       "expiration_date": "xyz789",
       "history": [NegotiableQuoteHistoryEntry],
-      "is_min_max_qty_used": true,
-      "is_virtual": false,
+      "is_min_max_qty_used": false,
+      "is_virtual": true,
       "items": [CartItemInterface],
       "max_order_commitment": 123,
       "min_order_commitment": 123,
@@ -10412,13 +9488,11 @@ 
Response

       ],
       "status": "xyz789",
       "template_id": 4,
-      "total_quantity": 123.45
+      "total_quantity": 987.65
     }
   }
 }
 

-                    
-
back to top @@ -10471,9 +9545,7 @@
Arguments

Example

Query
- - - 
mutation cancelOrder($input: CancelOrderInput!) {
+                  
mutation cancelOrder($input: CancelOrderInput!) {
   cancelOrder(input: $input) {
     error
     errorV2 {
@@ -10485,23 +9557,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CancelOrderInput}
+                  
{"input": CancelOrderInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "cancelOrder": {
       "error": "xyz789",
@@ -10511,8 +9575,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -10565,9 +9627,7 @@
Arguments

Example

Query
- - - 
mutation cancelPurchaseOrders($input: PurchaseOrdersActionInput!) {
+                  
mutation cancelPurchaseOrders($input: PurchaseOrdersActionInput!) {
   cancelPurchaseOrders(input: $input) {
     errors {
       ...PurchaseOrderActionErrorFragment
@@ -10578,23 +9638,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": PurchaseOrdersActionInput}
+                  
{"input": PurchaseOrdersActionInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "cancelPurchaseOrders": {
       "errors": [PurchaseOrderActionError],
@@ -10603,8 +9655,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -10662,9 +9712,7 @@
Arguments

Example

Query
- - - 
mutation changeCustomerPassword(
+                  
mutation changeCustomerPassword(
   $currentPassword: String!,
   $newPassword: String!
 ) {
@@ -10776,26 +9824,18 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
-  "currentPassword": "xyz789",
-  "newPassword": "abc123"
+                  
{
+  "currentPassword": "abc123",
+  "newPassword": "xyz789"
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "changeCustomerPassword": {
       "addresses": [CustomerAddress],
@@ -10806,21 +9846,21 @@ 
Response

       "confirmation_status": "ACCOUNT_CONFIRMED",
       "created_at": "xyz789",
       "custom_attributes": [AttributeValueInterface],
-      "date_of_birth": "xyz789",
+      "date_of_birth": "abc123",
       "default_billing": "abc123",
-      "default_shipping": "xyz789",
-      "dob": "abc123",
-      "email": "xyz789",
+      "default_shipping": "abc123",
+      "dob": "xyz789",
+      "email": "abc123",
       "firstname": "abc123",
-      "gender": 987,
+      "gender": 123,
       "gift_registries": [GiftRegistry],
       "gift_registry": GiftRegistry,
       "group": CustomerGroup,
-      "group_id": 987,
-      "id": 123,
+      "group_id": 123,
+      "id": 987,
       "is_subscribed": true,
       "job_title": "xyz789",
-      "lastname": "abc123",
+      "lastname": "xyz789",
       "middlename": "abc123",
       "orders": CustomerOrders,
       "prefix": "abc123",
@@ -10829,7 +9869,7 @@ 
Response

       "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
       "purchase_order_approval_rules": PurchaseOrderApprovalRules,
       "purchase_orders": PurchaseOrders,
-      "purchase_orders_enabled": false,
+      "purchase_orders_enabled": true,
       "requisition_lists": RequisitionLists,
       "return": Return,
       "returns": Returns,
@@ -10839,9 +9879,9 @@ 
Response

       "segments": [CustomerSegment],
       "status": "ACTIVE",
       "store_credit": CustomerStoreCredit,
-      "structure_id": 4,
+      "structure_id": "4",
       "suffix": "xyz789",
-      "taxvat": "xyz789",
+      "taxvat": "abc123",
       "team": CompanyTeam,
       "telephone": "xyz789",
       "wishlist": Wishlist,
@@ -10851,8 +9891,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -10904,9 +9942,7 @@
Arguments

Example

Query
- - - 
mutation clearCart($input: ClearCartInput!) {
+                  
mutation clearCart($input: ClearCartInput!) {
   clearCart(input: $input) {
     cart {
       ...CartFragment
@@ -10917,23 +9953,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": ClearCartInput}
+                  
{"input": ClearCartInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "clearCart": {
       "cart": Cart,
@@ -10942,8 +9970,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -10995,9 +10021,7 @@
Arguments

Example

Query
- - - 
mutation clearCustomerCart($cartUid: String!) {
+                  
mutation clearCustomerCart($cartUid: String!) {
   clearCustomerCart(cartUid: $cartUid) {
     cart {
       ...CartFragment
@@ -11006,30 +10030,20 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"cartUid": "abc123"}
+                  
{"cartUid": "xyz789"}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
-    "clearCustomerCart": {"cart": Cart, "status": true}
+    "clearCustomerCart": {"cart": Cart, "status": false}
   }
 }
 

-                    
-
back to top @@ -11081,9 +10095,7 @@
Arguments

Example

Query
- - - 
mutation closeNegotiableQuotes($input: CloseNegotiableQuotesInput!) {
+                  
mutation closeNegotiableQuotes($input: CloseNegotiableQuotesInput!) {
   closeNegotiableQuotes(input: $input) {
     closed_quotes {
       ...NegotiableQuoteFragment
@@ -11103,23 +10115,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CloseNegotiableQuotesInput}
+                  
{"input": CloseNegotiableQuotesInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "closeNegotiableQuotes": {
       "closed_quotes": [NegotiableQuote],
@@ -11132,8 +10136,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -11186,9 +10188,7 @@
Arguments

Example

Query
- - - 
mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) {
+                  
mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) {
   confirmCancelOrder(input: $input) {
     error
     errorV2 {
@@ -11200,34 +10200,24 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": ConfirmCancelOrderInput}
+                  
{"input": ConfirmCancelOrderInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "confirmCancelOrder": {
-      "error": "abc123",
+      "error": "xyz789",
       "errorV2": CancelOrderError,
       "order": CustomerOrder
     }
   }
 }
 

-                    
-
back to top @@ -11279,9 +10269,7 @@
Arguments

Example

Query
- - - 
mutation confirmEmail($input: ConfirmEmailInput!) {
+                  
mutation confirmEmail($input: ConfirmEmailInput!) {
   confirmEmail(input: $input) {
     customer {
       ...CustomerFragment
@@ -11289,26 +10277,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": ConfirmEmailInput}
+                  
{"input": ConfirmEmailInput}
 

-                    
-
Response
- - - 
{"data": {"confirmEmail": {"customer": Customer}}}
+                  
{"data": {"confirmEmail": {"customer": Customer}}}
 

-                    
-
back to top @@ -11361,9 +10339,7 @@
Arguments

Example

Query
- - - 
mutation confirmReturn($input: ConfirmReturnInput!) {
+                  
mutation confirmReturn($input: ConfirmReturnInput!) {
   confirmReturn(input: $input) {
     return {
       ...ReturnFragment
@@ -11374,23 +10350,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": ConfirmReturnInput}
+                  
{"input": ConfirmReturnInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "confirmReturn": {
       "return": Return,
@@ -11399,8 +10367,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -11452,34 +10418,22 @@
Arguments

Example

Query
- - - 
mutation contactUs($input: ContactUsInput!) {
+                  
mutation contactUs($input: ContactUsInput!) {
   contactUs(input: $input) {
     status
   }
 }
 

-                    
-
Variables
- - - 
{"input": ContactUsInput}
+                  
{"input": ContactUsInput}
 

-                    
-
Response
- - - 
{"data": {"contactUs": {"status": false}}}
+                  
{"data": {"contactUs": {"status": false}}}
 

-                    
-
back to top @@ -11543,9 +10497,7 @@
Arguments

Example

Query
- - - 
mutation copyItemsBetweenRequisitionLists(
+                  
mutation copyItemsBetweenRequisitionLists(
   $sourceRequisitionListUid: ID!,
   $destinationRequisitionListUid: ID,
   $requisitionListItem: CopyItemsBetweenRequisitionListsInput
@@ -11561,27 +10513,19 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
-  "sourceRequisitionListUid": "4",
+                  
{
+  "sourceRequisitionListUid": 4,
   "destinationRequisitionListUid": "4",
   "requisitionListItem": CopyItemsBetweenRequisitionListsInput
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "copyItemsBetweenRequisitionLists": {
       "requisition_list": RequisitionList
@@ -11589,8 +10533,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -11654,9 +10596,7 @@
Arguments

Example

Query
- - - 
mutation copyProductsBetweenWishlists(
+                  
mutation copyProductsBetweenWishlists(
   $sourceWishlistUid: ID!,
   $destinationWishlistUid: ID!,
   $wishlistItems: [WishlistItemCopyInput!]!
@@ -11678,27 +10618,19 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
-  "sourceWishlistUid": "4",
+                  
{
+  "sourceWishlistUid": 4,
   "destinationWishlistUid": "4",
   "wishlistItems": [WishlistItemCopyInput]
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "copyProductsBetweenWishlists": {
       "destination_wishlist": Wishlist,
@@ -11708,8 +10640,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -11742,27 +10672,19 @@
Response

Example

Query
- - - 
mutation createBraintreeClientToken {
+                  
mutation createBraintreeClientToken {
   createBraintreeClientToken
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
-    "createBraintreeClientToken": "abc123"
+    "createBraintreeClientToken": "xyz789"
   }
 }
 

-                    
-
back to top @@ -11795,27 +10717,19 @@
Response

Example

Query
- - - 
mutation createBraintreePayPalClientToken {
+                  
mutation createBraintreePayPalClientToken {
   createBraintreePayPalClientToken
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
-    "createBraintreePayPalClientToken": "xyz789"
+    "createBraintreePayPalClientToken": "abc123"
   }
 }
 

-                    
-
back to top @@ -11868,36 +10782,24 @@
Arguments

Example

Query
- - - 
mutation createBraintreePayPalVaultClientToken($input: BraintreeVaultInput) {
+                  
mutation createBraintreePayPalVaultClientToken($input: BraintreeVaultInput) {
   createBraintreePayPalVaultClientToken(input: $input)
 }
 

-                    
-
Variables
- - - 
{"input": BraintreeVaultInput}
+                  
{"input": BraintreeVaultInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "createBraintreePayPalVaultClientToken": "xyz789"
   }
 }
 

-                    
-
back to top @@ -11950,9 +10852,7 @@
Arguments

Example

Query
- - - 
mutation createCompany($input: CompanyCreateInput!) {
+                  
mutation createCompany($input: CompanyCreateInput!) {
   createCompany(input: $input) {
     company {
       ...CompanyFragment
@@ -11960,26 +10860,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CompanyCreateInput}
+                  
{"input": CompanyCreateInput}
 

-                    
-
Response
- - - 
{"data": {"createCompany": {"company": Company}}}
+                  
{"data": {"createCompany": {"company": Company}}}
 

-                    
-
back to top @@ -12032,9 +10922,7 @@
Arguments

Example

Query
- - - 
mutation createCompanyRole($input: CompanyRoleCreateInput!) {
+                  
mutation createCompanyRole($input: CompanyRoleCreateInput!) {
   createCompanyRole(input: $input) {
     role {
       ...CompanyRoleFragment
@@ -12042,26 +10930,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CompanyRoleCreateInput}
+                  
{"input": CompanyRoleCreateInput}
 

-                    
-
Response
- - - 
{"data": {"createCompanyRole": {"role": CompanyRole}}}
+                  
{"data": {"createCompanyRole": {"role": CompanyRole}}}
 

-                    
-
back to top @@ -12114,9 +10992,7 @@
Arguments

Example

Query
- - - 
mutation createCompanyTeam($input: CompanyTeamCreateInput!) {
+                  
mutation createCompanyTeam($input: CompanyTeamCreateInput!) {
   createCompanyTeam(input: $input) {
     team {
       ...CompanyTeamFragment
@@ -12124,26 +11000,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CompanyTeamCreateInput}
+                  
{"input": CompanyTeamCreateInput}
 

-                    
-
Response
- - - 
{"data": {"createCompanyTeam": {"team": CompanyTeam}}}
+                  
{"data": {"createCompanyTeam": {"team": CompanyTeam}}}
 

-                    
-
back to top @@ -12196,9 +11062,7 @@
Arguments

Example

Query
- - - 
mutation createCompanyUser($input: CompanyUserCreateInput!) {
+                  
mutation createCompanyUser($input: CompanyUserCreateInput!) {
   createCompanyUser(input: $input) {
     user {
       ...CustomerFragment
@@ -12206,26 +11070,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CompanyUserCreateInput}
+                  
{"input": CompanyUserCreateInput}
 

-                    
-
Response
- - - 
{"data": {"createCompanyUser": {"user": Customer}}}
+                  
{"data": {"createCompanyUser": {"user": Customer}}}
 

-                    
-
back to top @@ -12278,9 +11132,7 @@
Arguments

Example

Query
- - - 
mutation createCompareList($input: CreateCompareListInput) {
+                  
mutation createCompareList($input: CreateCompareListInput) {
   createCompareList(input: $input) {
     attributes {
       ...ComparableAttributeFragment
@@ -12293,35 +11145,25 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CreateCompareListInput}
+                  
{"input": CreateCompareListInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "createCompareList": {
       "attributes": [ComparableAttribute],
-      "item_count": 123,
+      "item_count": 987,
       "items": [ComparableItem],
-      "uid": "4"
+      "uid": 4
     }
   }
 }
 

-                    
-
back to top @@ -12372,9 +11214,7 @@
Arguments

Example

Query
- - - 
mutation createCustomer($input: CustomerInput!) {
+                  
mutation createCustomer($input: CustomerInput!) {
   createCustomer(input: $input) {
     customer {
       ...CustomerFragment
@@ -12382,26 +11222,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CustomerInput}
+                  
{"input": CustomerInput}
 

-                    
-
Response
- - - 
{"data": {"createCustomer": {"customer": Customer}}}
+                  
{"data": {"createCustomer": {"customer": Customer}}}
 

-                    
-
back to top @@ -12454,9 +11284,7 @@
Arguments

Example

Query
- - - 
mutation createCustomerAddress($input: CustomerAddressInput!) {
+                  
mutation createCustomerAddress($input: CustomerAddressInput!) {
   createCustomerAddress(input: $input) {
     city
     company
@@ -12492,54 +11320,44 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CustomerAddressInput}
+                  
{"input": CustomerAddressInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "createCustomerAddress": {
-      "city": "abc123",
+      "city": "xyz789",
       "company": "abc123",
       "country_code": "AF",
       "country_id": "abc123",
       "custom_attributes": [CustomerAddressAttribute],
       "custom_attributesV2": [AttributeValueInterface],
       "customer_id": 987,
-      "default_billing": true,
+      "default_billing": false,
       "default_shipping": false,
       "extension_attributes": [CustomerAddressAttribute],
-      "fax": "abc123",
-      "firstname": "abc123",
+      "fax": "xyz789",
+      "firstname": "xyz789",
       "id": 123,
-      "lastname": "abc123",
+      "lastname": "xyz789",
       "middlename": "xyz789",
-      "postcode": "xyz789",
-      "prefix": "xyz789",
+      "postcode": "abc123",
+      "prefix": "abc123",
       "region": CustomerAddressRegion,
-      "region_id": 987,
-      "street": ["abc123"],
-      "suffix": "abc123",
+      "region_id": 123,
+      "street": ["xyz789"],
+      "suffix": "xyz789",
       "telephone": "abc123",
       "vat_id": "xyz789"
     }
   }
 }
 

-                    
-
back to top @@ -12591,9 +11409,7 @@
Arguments

Example

Query
- - - 
mutation createCustomerV2($input: CustomerCreateInput!) {
+                  
mutation createCustomerV2($input: CustomerCreateInput!) {
   createCustomerV2(input: $input) {
     customer {
       ...CustomerFragment
@@ -12601,26 +11417,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CustomerCreateInput}
+                  
{"input": CustomerCreateInput}
 

-                    
-
Response
- - - 
{"data": {"createCustomerV2": {"customer": Customer}}}
+                  
{"data": {"createCustomerV2": {"customer": Customer}}}
 

-                    
-
back to top @@ -12679,32 +11485,20 @@
Arguments

Example

Query
- - - 
mutation createEmptyCart($input: createEmptyCartInput) {
+                  
mutation createEmptyCart($input: createEmptyCartInput) {
   createEmptyCart(input: $input)
 }
 

-                    
-
Variables
- - - 
{"input": createEmptyCartInput}
+                  
{"input": createEmptyCartInput}
 

-                    
-
Response
- - - 
{"data": {"createEmptyCart": "xyz789"}}
+                  
{"data": {"createEmptyCart": "xyz789"}}
 

-                    
-
back to top @@ -12756,9 +11550,7 @@
Arguments

Example

Query
- - - 
mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) {
+                  
mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) {
   createGiftRegistry(giftRegistry: $giftRegistry) {
     gift_registry {
       ...GiftRegistryFragment
@@ -12766,30 +11558,20 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"giftRegistry": CreateGiftRegistryInput}
+                  
{"giftRegistry": CreateGiftRegistryInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "createGiftRegistry": {"gift_registry": GiftRegistry}
   }
 }
 

-                    
-
back to top @@ -12842,9 +11624,7 @@
Arguments

Example

Query
- - - 
mutation createGuestCart($input: CreateGuestCartInput) {
+                  
mutation createGuestCart($input: CreateGuestCartInput) {
   createGuestCart(input: $input) {
     cart {
       ...CartFragment
@@ -12852,26 +11632,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CreateGuestCartInput}
+                  
{"input": CreateGuestCartInput}
 

-                    
-
Response
- - - 
{"data": {"createGuestCart": {"cart": Cart}}}
+                  
{"data": {"createGuestCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -12923,9 +11693,7 @@
Arguments

Example

Query
- - - 
mutation createPayflowProToken($input: PayflowProTokenInput!) {
+                  
mutation createPayflowProToken($input: PayflowProTokenInput!) {
   createPayflowProToken(input: $input) {
     response_message
     result
@@ -12935,36 +11703,26 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": PayflowProTokenInput}
+                  
{"input": PayflowProTokenInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "createPayflowProToken": {
       "response_message": "xyz789",
-      "result": 123,
+      "result": 987,
       "result_code": 123,
-      "secure_token": "abc123",
-      "secure_token_id": "xyz789"
+      "secure_token": "xyz789",
+      "secure_token_id": "abc123"
     }
   }
 }
 

-                    
-
back to top @@ -13016,9 +11774,7 @@
Arguments

Example

Query
- - - 
mutation createPaymentOrder($input: CreatePaymentOrderInput!) {
+                  
mutation createPaymentOrder($input: CreatePaymentOrderInput!) {
   createPaymentOrder(input: $input) {
     amount
     currency_code
@@ -13028,36 +11784,26 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CreatePaymentOrderInput}
+                  
{"input": CreatePaymentOrderInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "createPaymentOrder": {
-      "amount": 123.45,
-      "currency_code": "abc123",
+      "amount": 987.65,
+      "currency_code": "xyz789",
       "id": "abc123",
-      "mp_order_id": "xyz789",
+      "mp_order_id": "abc123",
       "status": "xyz789"
     }
   }
 }
 

-                    
-
back to top @@ -13109,9 +11855,7 @@
Arguments

Example

Query
- - - 
mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) {
+                  
mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) {
   createPaypalExpressToken(input: $input) {
     paypal_urls {
       ...PaypalExpressUrlListFragment
@@ -13120,23 +11864,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": PaypalExpressTokenInput}
+                  
{"input": PaypalExpressTokenInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "createPaypalExpressToken": {
       "paypal_urls": PaypalExpressUrlList,
@@ -13145,8 +11881,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -13198,9 +11932,7 @@
Arguments

Example

Query
- - - 
mutation createProductReview($input: CreateProductReviewInput!) {
+                  
mutation createProductReview($input: CreateProductReviewInput!) {
   createProductReview(input: $input) {
     review {
       ...ProductReviewFragment
@@ -13208,30 +11940,20 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CreateProductReviewInput}
+                  
{"input": CreateProductReviewInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "createProductReview": {"review": ProductReview}
   }
 }
 

-                    
-
back to top @@ -13284,9 +12006,7 @@
Arguments

Example

Query
- - - 
mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput!) {
+                  
mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput!) {
   createPurchaseOrderApprovalRule(input: $input) {
     applies_to_roles {
       ...CompanyRoleFragment
@@ -13307,32 +12027,24 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": PurchaseOrderApprovalRuleInput}
+                  
{"input": PurchaseOrderApprovalRuleInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "createPurchaseOrderApprovalRule": {
       "applies_to_roles": [CompanyRole],
       "approver_roles": [CompanyRole],
       "condition": PurchaseOrderApprovalRuleConditionInterface,
       "created_at": "xyz789",
-      "created_by": "abc123",
-      "description": "abc123",
-      "name": "abc123",
+      "created_by": "xyz789",
+      "description": "xyz789",
+      "name": "xyz789",
       "status": "ENABLED",
       "uid": "4",
       "updated_at": "xyz789"
@@ -13340,8 +12052,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -13394,9 +12104,7 @@
Arguments

Example

Query
- - - 
mutation createRequisitionList($input: CreateRequisitionListInput) {
+                  
mutation createRequisitionList($input: CreateRequisitionListInput) {
   createRequisitionList(input: $input) {
     requisition_list {
       ...RequisitionListFragment
@@ -13404,23 +12112,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CreateRequisitionListInput}
+                  
{"input": CreateRequisitionListInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "createRequisitionList": {
       "requisition_list": RequisitionList
@@ -13428,8 +12128,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -13481,9 +12179,7 @@
Arguments

Example

Query
- - - 
mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) {
+                  
mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) {
   createVaultCardPaymentToken(input: $input) {
     payment_source {
       ...PaymentSourceOutputFragment
@@ -13492,33 +12188,23 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CreateVaultCardPaymentTokenInput}
+                  
{"input": CreateVaultCardPaymentTokenInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "createVaultCardPaymentToken": {
       "payment_source": PaymentSourceOutput,
-      "vault_token_id": "abc123"
+      "vault_token_id": "xyz789"
     }
   }
 }
 

-                    
-
back to top @@ -13570,40 +12256,28 @@
Arguments

Example

Query
- - - 
mutation createVaultCardSetupToken($input: CreateVaultCardSetupTokenInput!) {
+                  
mutation createVaultCardSetupToken($input: CreateVaultCardSetupTokenInput!) {
   createVaultCardSetupToken(input: $input) {
     setup_token
   }
 }
 

-                    
-
Variables
- - - 
{"input": CreateVaultCardSetupTokenInput}
+                  
{"input": CreateVaultCardSetupTokenInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "createVaultCardSetupToken": {
-      "setup_token": "xyz789"
+      "setup_token": "abc123"
     }
   }
 }
 

-                    
-
back to top @@ -13655,9 +12329,7 @@
Arguments

Example

Query
- - - 
mutation createWishlist($input: CreateWishlistInput!) {
+                  
mutation createWishlist($input: CreateWishlistInput!) {
   createWishlist(input: $input) {
     wishlist {
       ...WishlistFragment
@@ -13665,26 +12337,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CreateWishlistInput}
+                  
{"input": CreateWishlistInput}
 

-                    
-
Response
- - - 
{"data": {"createWishlist": {"wishlist": Wishlist}}}
+                  
{"data": {"createWishlist": {"wishlist": Wishlist}}}
 

-                    
-
back to top @@ -13737,34 +12399,22 @@
Arguments

Example

Query
- - - 
mutation deleteCompanyRole($id: ID!) {
+                  
mutation deleteCompanyRole($id: ID!) {
   deleteCompanyRole(id: $id) {
     success
   }
 }
 

-                    
-
Variables
- - - 
{"id": 4}
+                  
{"id": "4"}
 

-                    
-
Response
- - - 
{"data": {"deleteCompanyRole": {"success": false}}}
+                  
{"data": {"deleteCompanyRole": {"success": true}}}
 

-                    
-
back to top @@ -13817,34 +12467,22 @@
Arguments

Example

Query
- - - 
mutation deleteCompanyTeam($id: ID!) {
+                  
mutation deleteCompanyTeam($id: ID!) {
   deleteCompanyTeam(id: $id) {
     success
   }
 }
 

-                    
-
Variables
- - - 
{"id": "4"}
+                  
{"id": "4"}
 

-                    
-
Response
- - - 
{"data": {"deleteCompanyTeam": {"success": false}}}
+                  
{"data": {"deleteCompanyTeam": {"success": true}}}
 

-                    
-
back to top @@ -13904,34 +12542,22 @@
Arguments

Example

Query
- - - 
mutation deleteCompanyUser($id: ID!) {
+                  
mutation deleteCompanyUser($id: ID!) {
   deleteCompanyUser(id: $id) {
     success
   }
 }
 

-                    
-
Variables
- - - 
{"id": 4}
+                  
{"id": "4"}
 

-                    
-
Response
- - - 
{"data": {"deleteCompanyUser": {"success": false}}}
+                  
{"data": {"deleteCompanyUser": {"success": false}}}
 

-                    
-
back to top @@ -13984,34 +12610,22 @@
Arguments

Example

Query
- - - 
mutation deleteCompanyUserV2($id: ID!) {
+                  
mutation deleteCompanyUserV2($id: ID!) {
   deleteCompanyUserV2(id: $id) {
     success
   }
 }
 

-                    
-
Variables
- - - 
{"id": "4"}
+                  
{"id": 4}
 

-                    
-
Response
- - - 
{"data": {"deleteCompanyUserV2": {"success": true}}}
+                  
{"data": {"deleteCompanyUserV2": {"success": true}}}
 

-                    
-
back to top @@ -14063,34 +12677,22 @@
Arguments

Example

Query
- - - 
mutation deleteCompareList($uid: ID!) {
+                  
mutation deleteCompareList($uid: ID!) {
   deleteCompareList(uid: $uid) {
     result
   }
 }
 

-                    
-
Variables
- - - 
{"uid": "4"}
+                  
{"uid": 4}
 

-                    
-
Response
- - - 
{"data": {"deleteCompareList": {"result": false}}}
+                  
{"data": {"deleteCompareList": {"result": false}}}
 

-                    
-
back to top @@ -14123,23 +12725,15 @@
Response

Example

Query
- - - 
mutation deleteCustomer {
+                  
mutation deleteCustomer {
   deleteCustomer
 }
 

-                    
-
Response
- - - 
{"data": {"deleteCustomer": false}}
+                  
{"data": {"deleteCustomer": true}}
 

-                    
-
back to top @@ -14191,32 +12785,20 @@
Arguments

Example

Query
- - - 
mutation deleteCustomerAddress($id: Int!) {
+                  
mutation deleteCustomerAddress($id: Int!) {
   deleteCustomerAddress(id: $id)
 }
 

-                    
-
Variables
- - - 
{"id": 987}
+                  
{"id": 123}
 

-                    
-
Response
- - - 
{"data": {"deleteCustomerAddress": true}}
+                  
{"data": {"deleteCustomerAddress": false}}
 

-                    
-
back to top @@ -14268,32 +12850,20 @@
Arguments

Example

Query
- - - 
mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInput!) {
+                  
mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInput!) {
   deleteNegotiableQuoteTemplate(input: $input)
 }
 

-                    
-
Variables
- - - 
{"input": DeleteNegotiableQuoteTemplateInput}
+                  
{"input": DeleteNegotiableQuoteTemplateInput}
 

-                    
-
Response
- - - 
{"data": {"deleteNegotiableQuoteTemplate": false}}
+                  
{"data": {"deleteNegotiableQuoteTemplate": true}}
 

-                    
-
back to top @@ -14345,9 +12915,7 @@
Arguments

Example

Query
- - - 
mutation deleteNegotiableQuotes($input: DeleteNegotiableQuotesInput!) {
+                  
mutation deleteNegotiableQuotes($input: DeleteNegotiableQuotesInput!) {
   deleteNegotiableQuotes(input: $input) {
     negotiable_quotes {
       ...NegotiableQuotesOutputFragment
@@ -14364,23 +12932,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": DeleteNegotiableQuotesInput}
+                  
{"input": DeleteNegotiableQuotesInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "deleteNegotiableQuotes": {
       "negotiable_quotes": NegotiableQuotesOutput,
@@ -14392,8 +12952,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -14445,9 +13003,7 @@
Arguments

Example

Query
- - - 
mutation deletePaymentToken($public_hash: String!) {
+                  
mutation deletePaymentToken($public_hash: String!) {
   deletePaymentToken(public_hash: $public_hash) {
     customerPaymentTokens {
       ...CustomerPaymentTokensFragment
@@ -14456,23 +13012,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"public_hash": "abc123"}
+                  
{"public_hash": "abc123"}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "deletePaymentToken": {
       "customerPaymentTokens": CustomerPaymentTokens,
@@ -14481,8 +13029,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -14535,9 +13081,7 @@
Arguments

Example

Query
- - - 
mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRuleInput!) {
+                  
mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRuleInput!) {
   deletePurchaseOrderApprovalRule(input: $input) {
     errors {
       ...DeletePurchaseOrderApprovalRuleErrorFragment
@@ -14545,23 +13089,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": DeletePurchaseOrderApprovalRuleInput}
+                  
{"input": DeletePurchaseOrderApprovalRuleInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "deletePurchaseOrderApprovalRule": {
       "errors": [DeletePurchaseOrderApprovalRuleError]
@@ -14569,8 +13105,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -14622,9 +13156,7 @@
Arguments

Example

Query
- - - 
mutation deleteRequisitionList($requisitionListUid: ID!) {
+                  
mutation deleteRequisitionList($requisitionListUid: ID!) {
   deleteRequisitionList(requisitionListUid: $requisitionListUid) {
     requisition_lists {
       ...RequisitionListsFragment
@@ -14633,23 +13165,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"requisitionListUid": 4}
+                  
{"requisitionListUid": 4}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "deleteRequisitionList": {
       "requisition_lists": RequisitionLists,
@@ -14658,8 +13182,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -14717,9 +13239,7 @@
Arguments

Example

Query
- - - 
mutation deleteRequisitionListItems(
+                  
mutation deleteRequisitionListItems(
   $requisitionListUid: ID!,
   $requisitionListItemUids: [ID!]!
 ) {
@@ -14733,23 +13253,18 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"requisitionListUid": 4, "requisitionListItemUids": [4]}
+                  
{
+  "requisitionListUid": 4,
+  "requisitionListItemUids": ["4"]
+}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "deleteRequisitionListItems": {
       "requisition_list": RequisitionList
@@ -14757,8 +13272,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -14810,9 +13323,7 @@
Arguments

Example

Query
- - - 
mutation deleteWishlist($wishlistId: ID!) {
+                  
mutation deleteWishlist($wishlistId: ID!) {
   deleteWishlist(wishlistId: $wishlistId) {
     status
     wishlists {
@@ -14821,33 +13332,23 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"wishlistId": 4}
+                  
{"wishlistId": 4}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "deleteWishlist": {
-      "status": false,
+      "status": true,
       "wishlists": [Wishlist]
     }
   }
 }
 

-                    
-
back to top @@ -14899,9 +13400,7 @@
Arguments

Example

Query
- - - 
mutation duplicateNegotiableQuote($input: DuplicateNegotiableQuoteInput!) {
+                  
mutation duplicateNegotiableQuote($input: DuplicateNegotiableQuoteInput!) {
   duplicateNegotiableQuote(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -14909,30 +13408,20 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": DuplicateNegotiableQuoteInput}
+                  
{"input": DuplicateNegotiableQuoteInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "duplicateNegotiableQuote": {"quote": NegotiableQuote}
   }
 }
 

-                    
-
back to top @@ -14984,9 +13473,7 @@
Arguments

Example

Query
- - - 
mutation estimateShippingMethods($input: EstimateTotalsInput!) {
+                  
mutation estimateShippingMethods($input: EstimateTotalsInput!) {
   estimateShippingMethods(input: $input) {
     amount {
       ...MoneyFragment
@@ -15009,23 +13496,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": EstimateTotalsInput}
+                  
{"input": EstimateTotalsInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "estimateShippingMethods": [
       {
@@ -15033,10 +13512,10 @@ 
Response

         "available": false,
         "base_amount": Money,
         "carrier_code": "xyz789",
-        "carrier_title": "xyz789",
+        "carrier_title": "abc123",
         "error_message": "xyz789",
-        "method_code": "xyz789",
-        "method_title": "abc123",
+        "method_code": "abc123",
+        "method_title": "xyz789",
         "price_excl_tax": Money,
         "price_incl_tax": Money
       }
@@ -15044,8 +13523,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -15097,9 +13574,7 @@
Arguments

Example

Query
- - - 
mutation estimateTotals($input: EstimateTotalsInput!) {
+                  
mutation estimateTotals($input: EstimateTotalsInput!) {
   estimateTotals(input: $input) {
     cart {
       ...CartFragment
@@ -15107,26 +13582,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": EstimateTotalsInput}
+                  
{"input": EstimateTotalsInput}
 

-                    
-
Response
- - - 
{"data": {"estimateTotals": {"cart": Cart}}}
+                  
{"data": {"estimateTotals": {"cart": Cart}}}
 

-                    
-
back to top @@ -15184,9 +13649,7 @@
Arguments

Example

Query
- - - 
mutation generateCustomerToken(
+                  
mutation generateCustomerToken(
   $email: String!,
   $password: String!
 ) {
@@ -15198,26 +13661,18 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
-  "email": "abc123",
-  "password": "xyz789"
+                  
{
+  "email": "xyz789",
+  "password": "abc123"
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "generateCustomerToken": {
       "token": "abc123"
@@ -15225,8 +13680,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -15278,40 +13731,28 @@
Arguments

Example

Query
- - - 
mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput!) {
+                  
mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput!) {
   generateCustomerTokenAsAdmin(input: $input) {
     customer_token
   }
 }
 

-                    
-
Variables
- - - 
{"input": GenerateCustomerTokenAsAdminInput}
+                  
{"input": GenerateCustomerTokenAsAdminInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "generateCustomerTokenAsAdmin": {
-      "customer_token": "abc123"
+      "customer_token": "xyz789"
     }
   }
 }
 

-                    
-
back to top @@ -15363,34 +13804,22 @@
Arguments

Example

Query
- - - 
mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFromTemplateInput!) {
+                  
mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFromTemplateInput!) {
   generateNegotiableQuoteFromTemplate(input: $input) {
     negotiable_quote_uid
   }
 }
 

-                    
-
Variables
- - - 
{"input": GenerateNegotiableQuoteFromTemplateInput}
+                  
{"input": GenerateNegotiableQuoteFromTemplateInput}
 

-                    
-
Response
- - - 
{"data": {"generateNegotiableQuoteFromTemplate": {"negotiable_quote_uid": 4}}}
+                  
{"data": {"generateNegotiableQuoteFromTemplate": {"negotiable_quote_uid": 4}}}
 

-                    
-
back to top @@ -15442,9 +13871,7 @@
Arguments

Example

Query
- - - 
mutation handlePayflowProResponse($input: PayflowProResponseInput!) {
+                  
mutation handlePayflowProResponse($input: PayflowProResponseInput!) {
   handlePayflowProResponse(input: $input) {
     cart {
       ...CartFragment
@@ -15452,26 +13879,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": PayflowProResponseInput}
+                  
{"input": PayflowProResponseInput}
 

-                    
-
Response
- - - 
{"data": {"handlePayflowProResponse": {"cart": Cart}}}
+                  
{"data": {"handlePayflowProResponse": {"cart": Cart}}}
 

-                    
-
back to top @@ -15529,9 +13946,7 @@
Arguments

Example

Query
- - - 
mutation mergeCarts(
+                  
mutation mergeCarts(
   $source_cart_id: String!,
   $destination_cart_id: String
 ) {
@@ -15596,26 +14011,18 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
-  "source_cart_id": "xyz789",
-  "destination_cart_id": "xyz789"
+                  
{
+  "source_cart_id": "abc123",
+  "destination_cart_id": "abc123"
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "mergeCarts": {
       "applied_coupon": AppliedCoupon,
@@ -15632,22 +14039,20 @@ 
Response

       "gift_message": GiftMessage,
       "gift_receipt_included": false,
       "gift_wrapping": GiftWrapping,
-      "id": 4,
-      "is_virtual": true,
+      "id": "4",
+      "is_virtual": false,
       "items": [CartItemInterface],
       "itemsV2": CartItems,
       "prices": CartPrices,
-      "printed_card_included": true,
+      "printed_card_included": false,
       "rules": [CartRule],
       "selected_payment_method": SelectedPaymentMethod,
       "shipping_addresses": [ShippingCartAddress],
-      "total_quantity": 987.65
+      "total_quantity": 123.45
     }
   }
 }
 

-                    
-
back to top @@ -15705,9 +14110,7 @@
Arguments

Example

Query
- - - 
mutation moveCartItemsToGiftRegistry(
+                  
mutation moveCartItemsToGiftRegistry(
   $cartUid: ID!,
   $giftRegistryUid: ID!
 ) {
@@ -15725,34 +14128,24 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"cartUid": 4, "giftRegistryUid": 4}
+                  
{"cartUid": "4", "giftRegistryUid": 4}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "moveCartItemsToGiftRegistry": {
       "gift_registry": GiftRegistry,
-      "status": false,
+      "status": true,
       "user_errors": [GiftRegistryItemsUserError]
     }
   }
 }
 

-                    
-
back to top @@ -15816,9 +14209,7 @@
Arguments

Example

Query
- - - 
mutation moveItemsBetweenRequisitionLists(
+                  
mutation moveItemsBetweenRequisitionLists(
   $sourceRequisitionListUid: ID!,
   $destinationRequisitionListUid: ID,
   $requisitionListItem: MoveItemsBetweenRequisitionListsInput
@@ -15837,27 +14228,19 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
+                  
{
   "sourceRequisitionListUid": 4,
-  "destinationRequisitionListUid": 4,
+  "destinationRequisitionListUid": "4",
   "requisitionListItem": MoveItemsBetweenRequisitionListsInput
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "moveItemsBetweenRequisitionLists": {
       "destination_requisition_list": RequisitionList,
@@ -15866,8 +14249,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -15919,9 +14300,7 @@
Arguments

Example

Query
- - - 
mutation moveLineItemToRequisitionList($input: MoveLineItemToRequisitionListInput!) {
+                  
mutation moveLineItemToRequisitionList($input: MoveLineItemToRequisitionListInput!) {
   moveLineItemToRequisitionList(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -15929,23 +14308,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": MoveLineItemToRequisitionListInput}
+                  
{"input": MoveLineItemToRequisitionListInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "moveLineItemToRequisitionList": {
       "quote": NegotiableQuote
@@ -15953,8 +14324,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -16018,9 +14387,7 @@
Arguments

Example

Query
- - - 
mutation moveProductsBetweenWishlists(
+                  
mutation moveProductsBetweenWishlists(
   $sourceWishlistUid: ID!,
   $destinationWishlistUid: ID!,
   $wishlistItems: [WishlistItemMoveInput!]!
@@ -16042,27 +14409,19 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
-  "sourceWishlistUid": "4",
+                  
{
+  "sourceWishlistUid": 4,
   "destinationWishlistUid": "4",
   "wishlistItems": [WishlistItemMoveInput]
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "moveProductsBetweenWishlists": {
       "destination_wishlist": Wishlist,
@@ -16072,8 +14431,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -16125,9 +14482,7 @@
Arguments

Example

Query
- - - 
mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) {
+                  
mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) {
   openNegotiableQuoteTemplate(input: $input) {
     buyer {
       ...NegotiableQuoteUserFragment
@@ -16165,33 +14520,25 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": OpenNegotiableQuoteTemplateInput}
+                  
{"input": OpenNegotiableQuoteTemplateInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "openNegotiableQuoteTemplate": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
-      "expiration_date": "xyz789",
+      "expiration_date": "abc123",
       "history": [NegotiableQuoteHistoryEntry],
       "is_min_max_qty_used": true,
-      "is_virtual": false,
+      "is_virtual": true,
       "items": [CartItemInterface],
-      "max_order_commitment": 987,
+      "max_order_commitment": 123,
       "min_order_commitment": 987,
       "name": "xyz789",
       "notifications": [QuoteTemplateNotificationMessage],
@@ -16209,8 +14556,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -16262,9 +14607,7 @@
Arguments

Example

Query
- - - 
mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) {
+                  
mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) {
   placeNegotiableQuoteOrder(input: $input) {
     order {
       ...OrderFragment
@@ -16272,26 +14615,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": PlaceNegotiableQuoteOrderInput}
+                  
{"input": PlaceNegotiableQuoteOrderInput}
 

-                    
-
Response
- - - 
{"data": {"placeNegotiableQuoteOrder": {"order": Order}}}
+                  
{"data": {"placeNegotiableQuoteOrder": {"order": Order}}}
 

-                    
-
back to top @@ -16343,9 +14676,7 @@
Arguments

Example

Query
- - - 
mutation placeOrder($input: PlaceOrderInput) {
+                  
mutation placeOrder($input: PlaceOrderInput) {
   placeOrder(input: $input) {
     errors {
       ...PlaceOrderErrorFragment
@@ -16359,23 +14690,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": PlaceOrderInput}
+                  
{"input": PlaceOrderInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "placeOrder": {
       "errors": [PlaceOrderError],
@@ -16385,8 +14708,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -16439,9 +14760,7 @@
Arguments

Example

Query
- - - 
mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) {
+                  
mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) {
   placeOrderForPurchaseOrder(input: $input) {
     order {
       ...CustomerOrderFragment
@@ -16449,30 +14768,20 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": PlaceOrderForPurchaseOrderInput}
+                  
{"input": PlaceOrderForPurchaseOrderInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "placeOrderForPurchaseOrder": {"order": CustomerOrder}
   }
 }
 

-                    
-
back to top @@ -16525,9 +14834,7 @@
Arguments

Example

Query
- - - 
mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) {
+                  
mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) {
   placePurchaseOrder(input: $input) {
     purchase_order {
       ...PurchaseOrderFragment
@@ -16535,23 +14842,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": PlacePurchaseOrderInput}
+                  
{"input": PlacePurchaseOrderInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "placePurchaseOrder": {
       "purchase_order": PurchaseOrder
@@ -16559,8 +14858,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -16612,9 +14909,7 @@
Arguments

Example

Query
- - - 
mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) {
+                  
mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) {
   redeemGiftCardBalanceAsStoreCredit(input: $input) {
     balance {
       ...MoneyFragment
@@ -16624,34 +14919,24 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": GiftCardAccountInput}
+                  
{"input": GiftCardAccountInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "redeemGiftCardBalanceAsStoreCredit": {
       "balance": Money,
       "code": "xyz789",
-      "expiration_date": "xyz789"
+      "expiration_date": "abc123"
     }
   }
 }
 

-                    
-
back to top @@ -16704,9 +14989,7 @@
Arguments

Example

Query
- - - 
mutation rejectPurchaseOrders($input: PurchaseOrdersActionInput!) {
+                  
mutation rejectPurchaseOrders($input: PurchaseOrdersActionInput!) {
   rejectPurchaseOrders(input: $input) {
     errors {
       ...PurchaseOrderActionErrorFragment
@@ -16717,23 +15000,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": PurchaseOrdersActionInput}
+                  
{"input": PurchaseOrdersActionInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "rejectPurchaseOrders": {
       "errors": [PurchaseOrderActionError],
@@ -16742,8 +15017,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -16795,9 +15068,7 @@
Arguments

Example

Query
- - - 
mutation removeCouponFromCart($input: RemoveCouponFromCartInput) {
+                  
mutation removeCouponFromCart($input: RemoveCouponFromCartInput) {
   removeCouponFromCart(input: $input) {
     cart {
       ...CartFragment
@@ -16805,26 +15076,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": RemoveCouponFromCartInput}
+                  
{"input": RemoveCouponFromCartInput}
 

-                    
-
Response
- - - 
{"data": {"removeCouponFromCart": {"cart": Cart}}}
+                  
{"data": {"removeCouponFromCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -16876,9 +15137,7 @@
Arguments

Example

Query
- - - 
mutation removeCouponsFromCart($input: RemoveCouponsFromCartInput) {
+                  
mutation removeCouponsFromCart($input: RemoveCouponsFromCartInput) {
   removeCouponsFromCart(input: $input) {
     cart {
       ...CartFragment
@@ -16886,26 +15145,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": RemoveCouponsFromCartInput}
+                  
{"input": RemoveCouponsFromCartInput}
 

-                    
-
Response
- - - 
{"data": {"removeCouponsFromCart": {"cart": Cart}}}
+                  
{"data": {"removeCouponsFromCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -16957,9 +15206,7 @@
Arguments

Example

Query
- - - 
mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) {
+                  
mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) {
   removeGiftCardFromCart(input: $input) {
     cart {
       ...CartFragment
@@ -16967,26 +15214,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": RemoveGiftCardFromCartInput}
+                  
{"input": RemoveGiftCardFromCartInput}
 

-                    
-
Response
- - - 
{"data": {"removeGiftCardFromCart": {"cart": Cart}}}
+                  
{"data": {"removeGiftCardFromCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -17038,34 +15275,22 @@
Arguments

Example

Query
- - - 
mutation removeGiftRegistry($giftRegistryUid: ID!) {
+                  
mutation removeGiftRegistry($giftRegistryUid: ID!) {
   removeGiftRegistry(giftRegistryUid: $giftRegistryUid) {
     success
   }
 }
 

-                    
-
Variables
- - - 
{"giftRegistryUid": "4"}
+                  
{"giftRegistryUid": 4}
 

-                    
-
Response
- - - 
{"data": {"removeGiftRegistry": {"success": true}}}
+                  
{"data": {"removeGiftRegistry": {"success": true}}}
 

-                    
-
back to top @@ -17123,9 +15348,7 @@
Arguments

Example

Query
- - - 
mutation removeGiftRegistryItems(
+                  
mutation removeGiftRegistryItems(
   $giftRegistryUid: ID!,
   $itemsUid: [ID!]!
 ) {
@@ -17139,23 +15362,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"giftRegistryUid": 4, "itemsUid": [4]}
+                  
{"giftRegistryUid": 4, "itemsUid": ["4"]}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "removeGiftRegistryItems": {
       "gift_registry": GiftRegistry
@@ -17163,8 +15378,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -17222,9 +15435,7 @@
Arguments

Example

Query
- - - 
mutation removeGiftRegistryRegistrants(
+                  
mutation removeGiftRegistryRegistrants(
   $giftRegistryUid: ID!,
   $registrantsUid: [ID!]!
 ) {
@@ -17238,26 +15449,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
-  "giftRegistryUid": "4",
-  "registrantsUid": ["4"]
-}
+                  
{"giftRegistryUid": 4, "registrantsUid": [4]}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "removeGiftRegistryRegistrants": {
       "gift_registry": GiftRegistry
@@ -17265,8 +15465,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -17318,9 +15516,7 @@
Arguments

Example

Query
- - - 
mutation removeItemFromCart($input: RemoveItemFromCartInput) {
+                  
mutation removeItemFromCart($input: RemoveItemFromCartInput) {
   removeItemFromCart(input: $input) {
     cart {
       ...CartFragment
@@ -17328,26 +15524,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": RemoveItemFromCartInput}
+                  
{"input": RemoveItemFromCartInput}
 

-                    
-
Response
- - - 
{"data": {"removeItemFromCart": {"cart": Cart}}}
+                  
{"data": {"removeItemFromCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -17399,9 +15585,7 @@
Arguments

Example

Query
- - - 
mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) {
+                  
mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) {
   removeNegotiableQuoteItems(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -17409,23 +15593,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": RemoveNegotiableQuoteItemsInput}
+                  
{"input": RemoveNegotiableQuoteItemsInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "removeNegotiableQuoteItems": {
       "quote": NegotiableQuote
@@ -17433,8 +15609,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -17486,9 +15660,7 @@
Arguments

Example

Query
- - - 
mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplateItemsInput!) {
+                  
mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplateItemsInput!) {
   removeNegotiableQuoteTemplateItems(input: $input) {
     buyer {
       ...NegotiableQuoteUserFragment
@@ -17526,35 +15698,27 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": RemoveNegotiableQuoteTemplateItemsInput}
+                  
{"input": RemoveNegotiableQuoteTemplateItemsInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "removeNegotiableQuoteTemplateItems": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
-      "expiration_date": "xyz789",
+      "expiration_date": "abc123",
       "history": [NegotiableQuoteHistoryEntry],
-      "is_min_max_qty_used": true,
-      "is_virtual": false,
+      "is_min_max_qty_used": false,
+      "is_virtual": true,
       "items": [CartItemInterface],
-      "max_order_commitment": 123,
-      "min_order_commitment": 123,
-      "name": "xyz789",
+      "max_order_commitment": 987,
+      "min_order_commitment": 987,
+      "name": "abc123",
       "notifications": [QuoteTemplateNotificationMessage],
       "prices": CartPrices,
       "reference_document_links": [
@@ -17563,15 +15727,13 @@ 
Response

       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
-      "status": "abc123",
-      "template_id": "4",
+      "status": "xyz789",
+      "template_id": 4,
       "total_quantity": 987.65
     }
   }
 }
 

-                    
-
back to top @@ -17623,9 +15785,7 @@
Arguments

Example

Query
- - - 
mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInput) {
+                  
mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInput) {
   removeProductsFromCompareList(input: $input) {
     attributes {
       ...ComparableAttributeFragment
@@ -17638,23 +15798,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": RemoveProductsFromCompareListInput}
+                  
{"input": RemoveProductsFromCompareListInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "removeProductsFromCompareList": {
       "attributes": [ComparableAttribute],
@@ -17665,8 +15817,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -17724,9 +15874,7 @@
Arguments

Example

Query
- - - 
mutation removeProductsFromWishlist(
+                  
mutation removeProductsFromWishlist(
   $wishlistId: ID!,
   $wishlistItemsIds: [ID!]!
 ) {
@@ -17743,23 +15891,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"wishlistId": 4, "wishlistItemsIds": ["4"]}
+                  
{"wishlistId": 4, "wishlistItemsIds": ["4"]}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "removeProductsFromWishlist": {
       "user_errors": [WishListUserInputError],
@@ -17768,8 +15908,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -17821,9 +15959,7 @@
Arguments

Example

Query
- - - 
mutation removeReturnTracking($input: RemoveReturnTrackingInput!) {
+                  
mutation removeReturnTracking($input: RemoveReturnTrackingInput!) {
   removeReturnTracking(input: $input) {
     return {
       ...ReturnFragment
@@ -17831,26 +15967,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": RemoveReturnTrackingInput}
+                  
{"input": RemoveReturnTrackingInput}
 

-                    
-
Response
- - - 
{"data": {"removeReturnTracking": {"return": Return}}}
+                  
{"data": {"removeReturnTracking": {"return": Return}}}
 

-                    
-
back to top @@ -17903,9 +16029,7 @@
Arguments

Example

Query
- - - 
mutation removeRewardPointsFromCart($cartId: ID!) {
+                  
mutation removeRewardPointsFromCart($cartId: ID!) {
   removeRewardPointsFromCart(cartId: $cartId) {
     cart {
       ...CartFragment
@@ -17913,26 +16037,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"cartId": "4"}
+                  
{"cartId": "4"}
 

-                    
-
Response
- - - 
{"data": {"removeRewardPointsFromCart": {"cart": Cart}}}
+                  
{"data": {"removeRewardPointsFromCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -17984,9 +16098,7 @@
Arguments

Example

Query
- - - 
mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) {
+                  
mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) {
   removeStoreCreditFromCart(input: $input) {
     cart {
       ...CartFragment
@@ -17994,26 +16106,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": RemoveStoreCreditFromCartInput}
+                  
{"input": RemoveStoreCreditFromCartInput}
 

-                    
-
Response
- - - 
{"data": {"removeStoreCreditFromCart": {"cart": Cart}}}
+                  
{"data": {"removeStoreCreditFromCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -18065,9 +16167,7 @@
Arguments

Example

Query
- - - 
mutation renameNegotiableQuote($input: RenameNegotiableQuoteInput!) {
+                  
mutation renameNegotiableQuote($input: RenameNegotiableQuoteInput!) {
   renameNegotiableQuote(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -18075,30 +16175,20 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": RenameNegotiableQuoteInput}
+                  
{"input": RenameNegotiableQuoteInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "renameNegotiableQuote": {"quote": NegotiableQuote}
   }
 }
 

-                    
-
back to top @@ -18151,9 +16241,7 @@
Arguments

Example

Query
- - - 
mutation reorderItems($orderNumber: String!) {
+                  
mutation reorderItems($orderNumber: String!) {
   reorderItems(orderNumber: $orderNumber) {
     cart {
       ...CartFragment
@@ -18164,23 +16252,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"orderNumber": "abc123"}
+                  
{"orderNumber": "xyz789"}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "reorderItems": {
       "cart": Cart,
@@ -18189,8 +16269,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -18243,9 +16321,7 @@
Arguments

Example

Query
- - - 
mutation requestGuestOrderCancel($input: GuestOrderCancelInput!) {
+                  
mutation requestGuestOrderCancel($input: GuestOrderCancelInput!) {
   requestGuestOrderCancel(input: $input) {
     error
     errorV2 {
@@ -18257,34 +16333,24 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": GuestOrderCancelInput}
+                  
{"input": GuestOrderCancelInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "requestGuestOrderCancel": {
-      "error": "abc123",
+      "error": "xyz789",
       "errorV2": CancelOrderError,
       "order": CustomerOrder
     }
   }
 }
 

-                    
-
back to top @@ -18328,9 +16394,7 @@
Arguments

Example

Query
- - - 
mutation requestGuestReturn($input: RequestGuestReturnInput!) {
+                  
mutation requestGuestReturn($input: RequestGuestReturnInput!) {
   requestGuestReturn(input: $input) {
     return {
       ...ReturnFragment
@@ -18341,23 +16405,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": RequestGuestReturnInput}
+                  
{"input": RequestGuestReturnInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "requestGuestReturn": {
       "return": Return,
@@ -18366,8 +16422,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -18419,9 +16473,7 @@
Arguments

Example

Query
- - - 
mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) {
+                  
mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) {
   requestNegotiableQuote(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -18429,30 +16481,20 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": RequestNegotiableQuoteInput}
+                  
{"input": RequestNegotiableQuoteInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "requestNegotiableQuote": {"quote": NegotiableQuote}
   }
 }
 

-                    
-
back to top @@ -18504,9 +16546,7 @@
Arguments

Example

Query
- - - 
mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteTemplateInput!) {
+                  
mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteTemplateInput!) {
   requestNegotiableQuoteTemplateFromQuote(input: $input) {
     buyer {
       ...NegotiableQuoteUserFragment
@@ -18544,33 +16584,25 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": RequestNegotiableQuoteTemplateInput}
+                  
{"input": RequestNegotiableQuoteTemplateInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "requestNegotiableQuoteTemplateFromQuote": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
-      "expiration_date": "xyz789",
+      "expiration_date": "abc123",
       "history": [NegotiableQuoteHistoryEntry],
       "is_min_max_qty_used": false,
-      "is_virtual": false,
+      "is_virtual": true,
       "items": [CartItemInterface],
-      "max_order_commitment": 123,
+      "max_order_commitment": 987,
       "min_order_commitment": 987,
       "name": "xyz789",
       "notifications": [QuoteTemplateNotificationMessage],
@@ -18581,15 +16613,13 @@ 
Response

       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
-      "status": "abc123",
+      "status": "xyz789",
       "template_id": 4,
       "total_quantity": 123.45
     }
   }
 }
 

-                    
-
back to top @@ -18641,32 +16671,20 @@
Arguments

Example

Query
- - - 
mutation requestPasswordResetEmail($email: String!) {
+                  
mutation requestPasswordResetEmail($email: String!) {
   requestPasswordResetEmail(email: $email)
 }
 

-                    
-
Variables
- - - 
{"email": "abc123"}
+                  
{"email": "xyz789"}
 

-                    
-
Response
- - - 
{"data": {"requestPasswordResetEmail": false}}
+                  
{"data": {"requestPasswordResetEmail": false}}
 

-                    
-
back to top @@ -18718,9 +16736,7 @@
Arguments

Example

Query
- - - 
mutation requestReturn($input: RequestReturnInput!) {
+                  
mutation requestReturn($input: RequestReturnInput!) {
   requestReturn(input: $input) {
     return {
       ...ReturnFragment
@@ -18731,23 +16747,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": RequestReturnInput}
+                  
{"input": RequestReturnInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "requestReturn": {
       "return": Return,
@@ -18756,8 +16764,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -18809,32 +16815,20 @@
Arguments

Example

Query
- - - 
mutation resendConfirmationEmail($email: String!) {
+                  
mutation resendConfirmationEmail($email: String!) {
   resendConfirmationEmail(email: $email)
 }
 

-                    
-
Variables
- - - 
{"email": "xyz789"}
+                  
{"email": "xyz789"}
 

-                    
-
Response
- - - 
{"data": {"resendConfirmationEmail": true}}
+                  
{"data": {"resendConfirmationEmail": true}}
 

-                    
-
back to top @@ -18898,9 +16892,7 @@
Arguments

Example

Query
- - - 
mutation resetPassword(
+                  
mutation resetPassword(
   $email: String!,
   $resetPasswordToken: String!,
   $newPassword: String!
@@ -18912,30 +16904,20 @@ 
Query

   )
 }
 

-                    
-
Variables
- - - 
{
-  "email": "xyz789",
-  "resetPasswordToken": "abc123",
+                  
{
+  "email": "abc123",
+  "resetPasswordToken": "xyz789",
   "newPassword": "xyz789"
 }
 

-                    
-
Response
- - - 
{"data": {"resetPassword": false}}
+                  
{"data": {"resetPassword": false}}
 

-                    
-
back to top @@ -18968,25 +16950,17 @@
Response

Example

Query
- - - 
mutation revokeCustomerToken {
+                  
mutation revokeCustomerToken {
   revokeCustomerToken {
     result
   }
 }
 

-                    
-
Response
- - - 
{"data": {"revokeCustomerToken": {"result": true}}}
+                  
{"data": {"revokeCustomerToken": {"result": true}}}
 

-                    
-
back to top @@ -19038,9 +17012,7 @@
Arguments

Example

Query
- - - 
mutation sendEmailToFriend($input: SendEmailToFriendInput) {
+                  
mutation sendEmailToFriend($input: SendEmailToFriendInput) {
   sendEmailToFriend(input: $input) {
     recipients {
       ...SendEmailToFriendRecipientFragment
@@ -19051,23 +17023,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": SendEmailToFriendInput}
+                  
{"input": SendEmailToFriendInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "sendEmailToFriend": {
       "recipients": [SendEmailToFriendRecipient],
@@ -19076,8 +17040,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -19129,9 +17091,7 @@
Arguments

Example

Query
- - - 
mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput!) {
+                  
mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput!) {
   sendNegotiableQuoteForReview(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -19139,23 +17099,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": SendNegotiableQuoteForReviewInput}
+                  
{"input": SendNegotiableQuoteForReviewInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "sendNegotiableQuoteForReview": {
       "quote": NegotiableQuote
@@ -19163,8 +17115,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -19216,9 +17166,7 @@
Arguments

Example

Query
- - - 
mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) {
+                  
mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) {
   setBillingAddressOnCart(input: $input) {
     cart {
       ...CartFragment
@@ -19226,26 +17174,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": SetBillingAddressOnCartInput}
+                  
{"input": SetBillingAddressOnCartInput}
 

-                    
-
Response
- - - 
{"data": {"setBillingAddressOnCart": {"cart": Cart}}}
+                  
{"data": {"setBillingAddressOnCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -19297,9 +17235,7 @@
Arguments

Example

Query
- - - 
mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) {
+                  
mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) {
   setGiftOptionsOnCart(input: $input) {
     cart {
       ...CartFragment
@@ -19307,26 +17243,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": SetGiftOptionsOnCartInput}
+                  
{"input": SetGiftOptionsOnCartInput}
 

-                    
-
Response
- - - 
{"data": {"setGiftOptionsOnCart": {"cart": Cart}}}
+                  
{"data": {"setGiftOptionsOnCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -19378,9 +17304,7 @@
Arguments

Example

Query
- - - 
mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) {
+                  
mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) {
   setGuestEmailOnCart(input: $input) {
     cart {
       ...CartFragment
@@ -19388,26 +17312,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": SetGuestEmailOnCartInput}
+                  
{"input": SetGuestEmailOnCartInput}
 

-                    
-
Response
- - - 
{"data": {"setGuestEmailOnCart": {"cart": Cart}}}
+                  
{"data": {"setGuestEmailOnCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -19459,9 +17373,7 @@
Arguments

Example

Query
- - - 
mutation setLineItemNote($input: LineItemNoteInput!) {
+                  
mutation setLineItemNote($input: LineItemNoteInput!) {
   setLineItemNote(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -19469,26 +17381,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": LineItemNoteInput}
+                  
{"input": LineItemNoteInput}
 

-                    
-
Response
- - - 
{"data": {"setLineItemNote": {"quote": NegotiableQuote}}}
+                  
{"data": {"setLineItemNote": {"quote": NegotiableQuote}}}
 

-                    
-
back to top @@ -19540,9 +17442,7 @@
Arguments

Example

Query
- - - 
mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddressInput!) {
+                  
mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddressInput!) {
   setNegotiableQuoteBillingAddress(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -19550,23 +17450,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": SetNegotiableQuoteBillingAddressInput}
+                  
{"input": SetNegotiableQuoteBillingAddressInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "setNegotiableQuoteBillingAddress": {
       "quote": NegotiableQuote
@@ -19574,8 +17466,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -19627,9 +17517,7 @@
Arguments

Example

Query
- - - 
mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethodInput!) {
+                  
mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethodInput!) {
   setNegotiableQuotePaymentMethod(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -19637,23 +17525,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": SetNegotiableQuotePaymentMethodInput}
+                  
{"input": SetNegotiableQuotePaymentMethodInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "setNegotiableQuotePaymentMethod": {
       "quote": NegotiableQuote
@@ -19661,8 +17541,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -19714,9 +17592,7 @@
Arguments

Example

Query
- - - 
mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAddressInput!) {
+                  
mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAddressInput!) {
   setNegotiableQuoteShippingAddress(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -19724,23 +17600,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": SetNegotiableQuoteShippingAddressInput}
+                  
{"input": SetNegotiableQuoteShippingAddressInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "setNegotiableQuoteShippingAddress": {
       "quote": NegotiableQuote
@@ -19748,8 +17616,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -19801,9 +17667,7 @@
Arguments

Example

Query
- - - 
mutation setNegotiableQuoteShippingMethods($input: SetNegotiableQuoteShippingMethodsInput!) {
+                  
mutation setNegotiableQuoteShippingMethods($input: SetNegotiableQuoteShippingMethodsInput!) {
   setNegotiableQuoteShippingMethods(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -19811,23 +17675,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": SetNegotiableQuoteShippingMethodsInput}
+                  
{"input": SetNegotiableQuoteShippingMethodsInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "setNegotiableQuoteShippingMethods": {
       "quote": NegotiableQuote
@@ -19835,8 +17691,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -19888,9 +17742,7 @@
Arguments

Example

Query
- - - 
mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTemplateShippingAddressInput!) {
+                  
mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTemplateShippingAddressInput!) {
   setNegotiableQuoteTemplateShippingAddress(input: $input) {
     buyer {
       ...NegotiableQuoteUserFragment
@@ -19928,35 +17780,27 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": SetNegotiableQuoteTemplateShippingAddressInput}
+                  
{"input": SetNegotiableQuoteTemplateShippingAddressInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "setNegotiableQuoteTemplateShippingAddress": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
       "expiration_date": "abc123",
       "history": [NegotiableQuoteHistoryEntry],
-      "is_min_max_qty_used": false,
-      "is_virtual": true,
+      "is_min_max_qty_used": true,
+      "is_virtual": false,
       "items": [CartItemInterface],
-      "max_order_commitment": 123,
-      "min_order_commitment": 987,
-      "name": "xyz789",
+      "max_order_commitment": 987,
+      "min_order_commitment": 123,
+      "name": "abc123",
       "notifications": [QuoteTemplateNotificationMessage],
       "prices": CartPrices,
       "reference_document_links": [
@@ -19965,15 +17809,13 @@ 
Response

       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
-      "status": "xyz789",
+      "status": "abc123",
       "template_id": "4",
       "total_quantity": 123.45
     }
   }
 }
 

-                    
-
back to top @@ -20033,9 +17875,7 @@
Arguments

Example

Query
- - - 
mutation setPaymentMethodAndPlaceOrder($input: SetPaymentMethodAndPlaceOrderInput) {
+                  
mutation setPaymentMethodAndPlaceOrder($input: SetPaymentMethodAndPlaceOrderInput) {
   setPaymentMethodAndPlaceOrder(input: $input) {
     errors {
       ...PlaceOrderErrorFragment
@@ -20049,23 +17889,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": SetPaymentMethodAndPlaceOrderInput}
+                  
{"input": SetPaymentMethodAndPlaceOrderInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "setPaymentMethodAndPlaceOrder": {
       "errors": [PlaceOrderError],
@@ -20075,8 +17907,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -20128,9 +17958,7 @@
Arguments

Example

Query
- - - 
mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) {
+                  
mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) {
   setPaymentMethodOnCart(input: $input) {
     cart {
       ...CartFragment
@@ -20138,26 +17966,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": SetPaymentMethodOnCartInput}
+                  
{"input": SetPaymentMethodOnCartInput}
 

-                    
-
Response
- - - 
{"data": {"setPaymentMethodOnCart": {"cart": Cart}}}
+                  
{"data": {"setPaymentMethodOnCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -20209,9 +18027,7 @@
Arguments

Example

Query
- - - 
mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) {
+                  
mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) {
   setQuoteTemplateLineItemNote(input: $input) {
     buyer {
       ...NegotiableQuoteUserFragment
@@ -20249,35 +18065,27 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": QuoteTemplateLineItemNoteInput}
+                  
{"input": QuoteTemplateLineItemNoteInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "setQuoteTemplateLineItemNote": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
-      "expiration_date": "abc123",
+      "expiration_date": "xyz789",
       "history": [NegotiableQuoteHistoryEntry],
-      "is_min_max_qty_used": false,
-      "is_virtual": false,
+      "is_min_max_qty_used": true,
+      "is_virtual": true,
       "items": [CartItemInterface],
-      "max_order_commitment": 123,
-      "min_order_commitment": 123,
-      "name": "abc123",
+      "max_order_commitment": 987,
+      "min_order_commitment": 987,
+      "name": "xyz789",
       "notifications": [QuoteTemplateNotificationMessage],
       "prices": CartPrices,
       "reference_document_links": [
@@ -20286,15 +18094,13 @@ 
Response

       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
-      "status": "xyz789",
-      "template_id": "4",
-      "total_quantity": 123.45
+      "status": "abc123",
+      "template_id": 4,
+      "total_quantity": 987.65
     }
   }
 }
 

-                    
-
back to top @@ -20346,9 +18152,7 @@
Arguments

Example

Query
- - - 
mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) {
+                  
mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) {
   setShippingAddressesOnCart(input: $input) {
     cart {
       ...CartFragment
@@ -20356,26 +18160,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": SetShippingAddressesOnCartInput}
+                  
{"input": SetShippingAddressesOnCartInput}
 

-                    
-
Response
- - - 
{"data": {"setShippingAddressesOnCart": {"cart": Cart}}}
+                  
{"data": {"setShippingAddressesOnCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -20427,9 +18221,7 @@
Arguments

Example

Query
- - - 
mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) {
+                  
mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) {
   setShippingMethodsOnCart(input: $input) {
     cart {
       ...CartFragment
@@ -20437,26 +18229,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": SetShippingMethodsOnCartInput}
+                  
{"input": SetShippingMethodsOnCartInput}
 

-                    
-
Response
- - - 
{"data": {"setShippingMethodsOnCart": {"cart": Cart}}}
+                  
{"data": {"setShippingMethodsOnCart": {"cart": Cart}}}
 

-                    
-
back to top @@ -20520,9 +18302,7 @@
Arguments

Example

Query
- - - 
mutation shareGiftRegistry(
+                  
mutation shareGiftRegistry(
   $giftRegistryUid: ID!,
   $sender: ShareGiftRegistrySenderInput!,
   $invitees: [ShareGiftRegistryInviteeInput!]!
@@ -20536,30 +18316,20 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
+                  
{
   "giftRegistryUid": "4",
   "sender": ShareGiftRegistrySenderInput,
   "invitees": [ShareGiftRegistryInviteeInput]
 }
 

-                    
-
Response
- - - 
{"data": {"shareGiftRegistry": {"is_shared": true}}}
+                  
{"data": {"shareGiftRegistry": {"is_shared": false}}}
 

-                    
-
back to top @@ -20611,9 +18381,7 @@
Arguments

Example

Query
- - - 
mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTemplateForReviewInput!) {
+                  
mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTemplateForReviewInput!) {
   submitNegotiableQuoteTemplateForReview(input: $input) {
     buyer {
       ...NegotiableQuoteUserFragment
@@ -20651,33 +18419,25 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": SubmitNegotiableQuoteTemplateForReviewInput}
+                  
{"input": SubmitNegotiableQuoteTemplateForReviewInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "submitNegotiableQuoteTemplateForReview": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
       "expiration_date": "abc123",
       "history": [NegotiableQuoteHistoryEntry],
-      "is_min_max_qty_used": true,
+      "is_min_max_qty_used": false,
       "is_virtual": true,
       "items": [CartItemInterface],
-      "max_order_commitment": 123,
+      "max_order_commitment": 987,
       "min_order_commitment": 987,
       "name": "xyz789",
       "notifications": [QuoteTemplateNotificationMessage],
@@ -20688,15 +18448,13 @@ 
Response

       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
-      "status": "abc123",
-      "template_id": 4,
+      "status": "xyz789",
+      "template_id": "4",
       "total_quantity": 987.65
     }
   }
 }
 

-                    
-
back to top @@ -20748,34 +18506,22 @@
Arguments

Example

Query
- - - 
mutation subscribeEmailToNewsletter($email: String!) {
+                  
mutation subscribeEmailToNewsletter($email: String!) {
   subscribeEmailToNewsletter(email: $email) {
     status
   }
 }
 

-                    
-
Variables
- - - 
{"email": "xyz789"}
+                  
{"email": "xyz789"}
 

-                    
-
Response
- - - 
{"data": {"subscribeEmailToNewsletter": {"status": "NOT_ACTIVE"}}}
+                  
{"data": {"subscribeEmailToNewsletter": {"status": "NOT_ACTIVE"}}}
 

-                    
-
back to top @@ -20827,32 +18573,20 @@
Arguments

Example

Query
- - - 
mutation syncPaymentOrder($input: SyncPaymentOrderInput) {
+                  
mutation syncPaymentOrder($input: SyncPaymentOrderInput) {
   syncPaymentOrder(input: $input)
 }
 

-                    
-
Variables
- - - 
{"input": SyncPaymentOrderInput}
+                  
{"input": SyncPaymentOrderInput}
 

-                    
-
Response
- - - 
{"data": {"syncPaymentOrder": false}}
+                  
{"data": {"syncPaymentOrder": false}}
 

-                    
-
back to top @@ -20904,32 +18638,20 @@
Arguments

Example

Query
- - - 
mutation trackViewedProduct($sku: String!) {
+                  
mutation trackViewedProduct($sku: String!) {
   trackViewedProduct(sku: $sku)
 }
 

-                    
-
Variables
- - - 
{"sku": "xyz789"}
+                  
{"sku": "xyz789"}
 

-                    
-
Response
- - - 
{"data": {"trackViewedProduct": true}}
+                  
{"data": {"trackViewedProduct": true}}
 

-                    
-
back to top @@ -20981,9 +18703,7 @@
Arguments

Example

Query
- - - 
mutation updateCartItems($input: UpdateCartItemsInput) {
+                  
mutation updateCartItems($input: UpdateCartItemsInput) {
   updateCartItems(input: $input) {
     cart {
       ...CartFragment
@@ -20994,23 +18714,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": UpdateCartItemsInput}
+                  
{"input": UpdateCartItemsInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "updateCartItems": {
       "cart": Cart,
@@ -21019,8 +18731,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -21073,9 +18783,7 @@
Arguments

Example

Query
- - - 
mutation updateCompany($input: CompanyUpdateInput!) {
+                  
mutation updateCompany($input: CompanyUpdateInput!) {
   updateCompany(input: $input) {
     company {
       ...CompanyFragment
@@ -21083,26 +18791,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CompanyUpdateInput}
+                  
{"input": CompanyUpdateInput}
 

-                    
-
Response
- - - 
{"data": {"updateCompany": {"company": Company}}}
+                  
{"data": {"updateCompany": {"company": Company}}}
 

-                    
-
back to top @@ -21155,9 +18853,7 @@
Arguments

Example

Query
- - - 
mutation updateCompanyRole($input: CompanyRoleUpdateInput!) {
+                  
mutation updateCompanyRole($input: CompanyRoleUpdateInput!) {
   updateCompanyRole(input: $input) {
     role {
       ...CompanyRoleFragment
@@ -21165,26 +18861,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CompanyRoleUpdateInput}
+                  
{"input": CompanyRoleUpdateInput}
 

-                    
-
Response
- - - 
{"data": {"updateCompanyRole": {"role": CompanyRole}}}
+                  
{"data": {"updateCompanyRole": {"role": CompanyRole}}}
 

-                    
-
back to top @@ -21237,9 +18923,7 @@
Arguments

Example

Query
- - - 
mutation updateCompanyStructure($input: CompanyStructureUpdateInput!) {
+                  
mutation updateCompanyStructure($input: CompanyStructureUpdateInput!) {
   updateCompanyStructure(input: $input) {
     company {
       ...CompanyFragment
@@ -21247,26 +18931,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CompanyStructureUpdateInput}
+                  
{"input": CompanyStructureUpdateInput}
 

-                    
-
Response
- - - 
{"data": {"updateCompanyStructure": {"company": Company}}}
+                  
{"data": {"updateCompanyStructure": {"company": Company}}}
 

-                    
-
back to top @@ -21319,9 +18993,7 @@
Arguments

Example

Query
- - - 
mutation updateCompanyTeam($input: CompanyTeamUpdateInput!) {
+                  
mutation updateCompanyTeam($input: CompanyTeamUpdateInput!) {
   updateCompanyTeam(input: $input) {
     team {
       ...CompanyTeamFragment
@@ -21329,26 +19001,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CompanyTeamUpdateInput}
+                  
{"input": CompanyTeamUpdateInput}
 

-                    
-
Response
- - - 
{"data": {"updateCompanyTeam": {"team": CompanyTeam}}}
+                  
{"data": {"updateCompanyTeam": {"team": CompanyTeam}}}
 

-                    
-
back to top @@ -21401,9 +19063,7 @@
Arguments

Example

Query
- - - 
mutation updateCompanyUser($input: CompanyUserUpdateInput!) {
+                  
mutation updateCompanyUser($input: CompanyUserUpdateInput!) {
   updateCompanyUser(input: $input) {
     user {
       ...CustomerFragment
@@ -21411,26 +19071,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CompanyUserUpdateInput}
+                  
{"input": CompanyUserUpdateInput}
 

-                    
-
Response
- - - 
{"data": {"updateCompanyUser": {"user": Customer}}}
+                  
{"data": {"updateCompanyUser": {"user": Customer}}}
 

-                    
-
back to top @@ -21481,9 +19131,7 @@
Arguments

Example

Query
- - - 
mutation updateCustomer($input: CustomerInput!) {
+                  
mutation updateCustomer($input: CustomerInput!) {
   updateCustomer(input: $input) {
     customer {
       ...CustomerFragment
@@ -21491,26 +19139,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CustomerInput}
+                  
{"input": CustomerInput}
 

-                    
-
Response
- - - 
{"data": {"updateCustomer": {"customer": Customer}}}
+                  
{"data": {"updateCustomer": {"customer": Customer}}}
 

-                    
-
back to top @@ -21568,9 +19206,7 @@
Arguments

Example

Query
- - - 
mutation updateCustomerAddress(
+                  
mutation updateCustomerAddress(
   $id: Int!,
   $input: CustomerAddressInput
 ) {
@@ -21612,45 +19248,37 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"id": 123, "input": CustomerAddressInput}
+                  
{"id": 987, "input": CustomerAddressInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "updateCustomerAddress": {
-      "city": "abc123",
+      "city": "xyz789",
       "company": "abc123",
       "country_code": "AF",
       "country_id": "xyz789",
       "custom_attributes": [CustomerAddressAttribute],
       "custom_attributesV2": [AttributeValueInterface],
       "customer_id": 123,
-      "default_billing": false,
+      "default_billing": true,
       "default_shipping": true,
       "extension_attributes": [CustomerAddressAttribute],
-      "fax": "abc123",
+      "fax": "xyz789",
       "firstname": "xyz789",
-      "id": 123,
-      "lastname": "xyz789",
-      "middlename": "abc123",
+      "id": 987,
+      "lastname": "abc123",
+      "middlename": "xyz789",
       "postcode": "xyz789",
-      "prefix": "xyz789",
+      "prefix": "abc123",
       "region": CustomerAddressRegion,
-      "region_id": 987,
-      "street": ["abc123"],
+      "region_id": 123,
+      "street": ["xyz789"],
       "suffix": "xyz789",
       "telephone": "abc123",
       "vat_id": "xyz789"
@@ -21658,8 +19286,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -21717,9 +19343,7 @@
Arguments

Example

Query
- - - 
mutation updateCustomerEmail(
+                  
mutation updateCustomerEmail(
   $email: String!,
   $password: String!
 ) {
@@ -21733,29 +19357,19 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
-  "email": "abc123",
-  "password": "xyz789"
+                  
{
+  "email": "xyz789",
+  "password": "abc123"
 }
 

-                    
-
Response
- - - 
{"data": {"updateCustomerEmail": {"customer": Customer}}}
+                  
{"data": {"updateCustomerEmail": {"customer": Customer}}}
 

-                    
-
back to top @@ -21807,9 +19421,7 @@
Arguments

Example

Query
- - - 
mutation updateCustomerV2($input: CustomerUpdateInput!) {
+                  
mutation updateCustomerV2($input: CustomerUpdateInput!) {
   updateCustomerV2(input: $input) {
     customer {
       ...CustomerFragment
@@ -21817,26 +19429,16 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": CustomerUpdateInput}
+                  
{"input": CustomerUpdateInput}
 

-                    
-
Response
- - - 
{"data": {"updateCustomerV2": {"customer": Customer}}}
+                  
{"data": {"updateCustomerV2": {"customer": Customer}}}
 

-                    
-
back to top @@ -21894,9 +19496,7 @@
Arguments

Example

Query
- - - 
mutation updateGiftRegistry(
+                  
mutation updateGiftRegistry(
   $giftRegistryUid: ID!,
   $giftRegistry: UpdateGiftRegistryInput!
 ) {
@@ -21910,33 +19510,23 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
-  "giftRegistryUid": 4,
+                  
{
+  "giftRegistryUid": "4",
   "giftRegistry": UpdateGiftRegistryInput
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "updateGiftRegistry": {"gift_registry": GiftRegistry}
   }
 }
 

-                    
-
back to top @@ -21994,9 +19584,7 @@
Arguments

Example

Query
- - - 
mutation updateGiftRegistryItems(
+                  
mutation updateGiftRegistryItems(
   $giftRegistryUid: ID!,
   $items: [UpdateGiftRegistryItemInput!]!
 ) {
@@ -22010,26 +19598,18 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
-  "giftRegistryUid": "4",
+                  
{
+  "giftRegistryUid": 4,
   "items": [UpdateGiftRegistryItemInput]
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "updateGiftRegistryItems": {
       "gift_registry": GiftRegistry
@@ -22037,8 +19617,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -22096,9 +19674,7 @@
Arguments

Example

Query
- - - 
mutation updateGiftRegistryRegistrants(
+                  
mutation updateGiftRegistryRegistrants(
   $giftRegistryUid: ID!,
   $registrants: [UpdateGiftRegistryRegistrantInput!]!
 ) {
@@ -22112,26 +19688,18 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
-  "giftRegistryUid": 4,
+                  
{
+  "giftRegistryUid": "4",
   "registrants": [UpdateGiftRegistryRegistrantInput]
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "updateGiftRegistryRegistrants": {
       "gift_registry": GiftRegistry
@@ -22139,8 +19707,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -22192,9 +19758,7 @@
Arguments

Example

Query
- - - 
mutation updateNegotiableQuoteQuantities($input: UpdateNegotiableQuoteQuantitiesInput!) {
+                  
mutation updateNegotiableQuoteQuantities($input: UpdateNegotiableQuoteQuantitiesInput!) {
   updateNegotiableQuoteQuantities(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -22202,23 +19766,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": UpdateNegotiableQuoteQuantitiesInput}
+                  
{"input": UpdateNegotiableQuoteQuantitiesInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "updateNegotiableQuoteQuantities": {
       "quote": NegotiableQuote
@@ -22226,8 +19782,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -22279,9 +19833,7 @@
Arguments

Example

Query
- - - 
mutation updateNegotiableQuoteTemplateQuantities($input: UpdateNegotiableQuoteTemplateQuantitiesInput!) {
+                  
mutation updateNegotiableQuoteTemplateQuantities($input: UpdateNegotiableQuoteTemplateQuantitiesInput!) {
   updateNegotiableQuoteTemplateQuantities(input: $input) {
     quote_template {
       ...NegotiableQuoteTemplateFragment
@@ -22289,23 +19841,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": UpdateNegotiableQuoteTemplateQuantitiesInput}
+                  
{"input": UpdateNegotiableQuoteTemplateQuantitiesInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "updateNegotiableQuoteTemplateQuantities": {
       "quote_template": NegotiableQuoteTemplate
@@ -22313,8 +19857,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -22372,9 +19914,7 @@
Arguments

Example

Query
- - - 
mutation updateProductsInWishlist(
+                  
mutation updateProductsInWishlist(
   $wishlistId: ID!,
   $wishlistItems: [WishlistItemUpdateInput!]!
 ) {
@@ -22391,26 +19931,18 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
+                  
{
   "wishlistId": "4",
   "wishlistItems": [WishlistItemUpdateInput]
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "updateProductsInWishlist": {
       "user_errors": [WishListUserInputError],
@@ -22419,8 +19951,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -22473,9 +20003,7 @@
Arguments

Example

Query
- - - 
mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRuleInput!) {
+                  
mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRuleInput!) {
   updatePurchaseOrderApprovalRule(input: $input) {
     applies_to_roles {
       ...CompanyRoleFragment
@@ -22496,32 +20024,24 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": UpdatePurchaseOrderApprovalRuleInput}
+                  
{"input": UpdatePurchaseOrderApprovalRuleInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "updatePurchaseOrderApprovalRule": {
       "applies_to_roles": [CompanyRole],
       "approver_roles": [CompanyRole],
       "condition": PurchaseOrderApprovalRuleConditionInterface,
-      "created_at": "xyz789",
+      "created_at": "abc123",
       "created_by": "xyz789",
-      "description": "xyz789",
-      "name": "xyz789",
+      "description": "abc123",
+      "name": "abc123",
       "status": "ENABLED",
       "uid": "4",
       "updated_at": "xyz789"
@@ -22529,8 +20049,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -22589,9 +20107,7 @@
Arguments

Example

Query
- - - 
mutation updateRequisitionList(
+                  
mutation updateRequisitionList(
   $requisitionListUid: ID!,
   $input: UpdateRequisitionListInput
 ) {
@@ -22605,26 +20121,18 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
-  "requisitionListUid": 4,
+                  
{
+  "requisitionListUid": "4",
   "input": UpdateRequisitionListInput
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "updateRequisitionList": {
       "requisition_list": RequisitionList
@@ -22632,8 +20140,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -22691,9 +20197,7 @@
Arguments

Example

Query
- - - 
mutation updateRequisitionListItems(
+                  
mutation updateRequisitionListItems(
   $requisitionListUid: ID!,
   $requisitionListItems: [UpdateRequisitionListItemsInput!]!
 ) {
@@ -22707,28 +20211,20 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
-  "requisitionListUid": "4",
+                  
{
+  "requisitionListUid": 4,
   "requisitionListItems": [
     UpdateRequisitionListItemsInput
   ]
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "updateRequisitionListItems": {
       "requisition_list": RequisitionList
@@ -22736,8 +20232,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -22801,9 +20295,7 @@
Arguments

Example

Query
- - - 
mutation updateWishlist(
+                  
mutation updateWishlist(
   $wishlistId: ID!,
   $name: String,
   $visibility: WishlistVisibilityEnum
@@ -22819,27 +20311,19 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{
+                  
{
   "wishlistId": "4",
-  "name": "abc123",
+  "name": "xyz789",
   "visibility": "PUBLIC"
 }
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "updateWishlist": {
       "name": "xyz789",
@@ -22849,8 +20333,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -22903,9 +20385,7 @@
Arguments

Example

Query
- - - 
mutation validatePurchaseOrders($input: ValidatePurchaseOrdersInput!) {
+                  
mutation validatePurchaseOrders($input: ValidatePurchaseOrdersInput!) {
   validatePurchaseOrders(input: $input) {
     errors {
       ...ValidatePurchaseOrderErrorFragment
@@ -22916,23 +20396,15 @@ 
Query

   }
 }
 

-                    
-
Variables
- - - 
{"input": ValidatePurchaseOrdersInput}
+                  
{"input": ValidatePurchaseOrdersInput}
 

-                    
-
Response
- - - 
{
+                  
{
   "data": {
     "validatePurchaseOrders": {
       "errors": [ValidatePurchaseOrderError],
@@ -22941,8 +20413,6 @@ 
Response

   }
 }
 

-                    
-
back to top @@ -22980,12 +20450,8 @@
Fields
Example
- - - 
{"template_id": "4"}
+                  
{"template_id": "4"}
 

-                    
-
back to top @@ -23031,15 +20497,11 @@
Fields
Example
- - - 
{
-  "cart_id": "abc123",
+                  
{
+  "cart_id": "xyz789",
   "cart_items": [BundleProductCartItemInput]
 }
 

-                    
-
back to top @@ -23078,12 +20540,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -23129,15 +20587,11 @@
Fields
Example
- - - 
{
+                  
{
   "cart_id": "abc123",
   "cart_items": [ConfigurableProductCartItemInput]
 }
 

-                    
-
back to top @@ -23176,12 +20630,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -23223,15 +20673,11 @@
Fields
Example
- - - 
{
-  "cart_id": "abc123",
+                  
{
+  "cart_id": "xyz789",
   "cart_items": [DownloadableProductCartItemInput]
 }
 

-                    
-
back to top @@ -23270,12 +20716,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -23333,9 +20775,7 @@
Fields
Example
- - - 
{
+                  
{
   "dynamic_attributes": [
     GiftRegistryDynamicAttributeInput
   ],
@@ -23344,8 +20784,6 @@ 
Example

   "lastname": "xyz789"
 }
 

-                    
-
back to top @@ -23384,12 +20822,8 @@
Fields
Example
- - - 
{"gift_registry": GiftRegistry}
+                  
{"gift_registry": GiftRegistry}
 

-                    
-
back to top @@ -23433,15 +20867,11 @@
Fields
Example
- - - 
{
+                  
{
   "cart": Cart,
   "user_errors": [Error]
 }
 

-                    
-
back to top @@ -23487,15 +20917,8 @@
Fields
Example
- - - 
{
-  "products": ["4"],
-  "uid": "4"
-}
+                  
{"products": [4], "uid": "4"}
 

-                    
-
back to top @@ -23534,12 +20957,8 @@
Fields
Example
- - - 
{"requisition_list": RequisitionList}
+                  
{"requisition_list": RequisitionList}
 

-                    
-
back to top @@ -23583,15 +21002,11 @@
Fields
Example
- - - 
{
+                  
{
   "user_errors": [WishListUserInputError],
   "wishlist": Wishlist
 }
 

-                    
-
back to top @@ -23637,15 +21052,11 @@
Fields
Example
- - - 
{
-  "comment": "xyz789",
+                  
{
+  "comment": "abc123",
   "purchase_order_uid": "4"
 }
 

-                    
-
back to top @@ -23684,12 +21095,8 @@
Fields
Example
- - - 
{"comment": PurchaseOrderComment}
+                  
{"comment": PurchaseOrderComment}
 

-                    
-
back to top @@ -23741,16 +21148,12 @@
Fields
Example
- - - 
{
+                  
{
   "cart_id": "abc123",
-  "purchase_order_uid": "4",
+  "purchase_order_uid": 4,
   "replace_existing_cart_items": false
 }
 

-                    
-
back to top @@ -23794,15 +21197,11 @@
Fields
Example
- - - 
{
-  "message": "xyz789",
+                  
{
+  "message": "abc123",
   "type": "OUT_OF_STOCK"
 }
 

-                    
-
back to top @@ -23860,12 +21259,8 @@
Values
Example
- - - 
"OUT_OF_STOCK"
+                  
"OUT_OF_STOCK"
 

-                    
-
back to top @@ -23914,9 +21309,7 @@
Fields
Example
- - - 
{
+                  
{
   "add_requisition_list_items_to_cart_user_errors": [
     AddRequisitionListItemToCartUserError
   ],
@@ -23924,8 +21317,6 @@ 
Example

   "status": true
 }
 

-                    
-
back to top @@ -23971,12 +21362,11 @@
Fields
Example
- - - 
{"comment_text": "abc123", "return_uid": 4}
+                  
{
+  "comment_text": "abc123",
+  "return_uid": "4"
+}
 

-                    
-
back to top @@ -24015,12 +21405,8 @@
Fields
Example
- - - 
{"return": Return}
+                  
{"return": Return}
 

-                    
-
back to top @@ -24072,16 +21458,12 @@
Fields
Example
- - - 
{
-  "carrier_uid": 4,
-  "return_uid": 4,
-  "tracking_number": "abc123"
+                  
{
+  "carrier_uid": "4",
+  "return_uid": "4",
+  "tracking_number": "xyz789"
 }
 

-                    
-
back to top @@ -24125,15 +21507,11 @@
Fields
Example
- - - 
{
+                  
{
   "return": Return,
   "return_shipping_tracking": ReturnShippingTracking
 }
 

-                    
-
back to top @@ -24179,15 +21557,11 @@
Fields
Example
- - - 
{
+                  
{
   "cart_id": "abc123",
   "cart_items": [SimpleProductCartItemInput]
 }
 

-                    
-
back to top @@ -24226,12 +21600,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -24277,15 +21647,11 @@
Fields
Example
- - - 
{
+                  
{
   "cart_id": "xyz789",
   "cart_items": [VirtualProductCartItemInput]
 }
 

-                    
-
back to top @@ -24324,12 +21690,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -24378,9 +21740,7 @@
Fields
Example
- - - 
{
+                  
{
   "add_wishlist_items_to_cart_user_errors": [
     WishlistCartUserInputError
   ],
@@ -24388,8 +21748,6 @@ 
Example

   "wishlist": Wishlist
 }
 

-                    
-
back to top @@ -24448,18 +21806,14 @@
Fields
Example
- - - 
{
+                  
{
   "attribute_code": "xyz789",
   "count": 123,
-  "label": "abc123",
+  "label": "xyz789",
   "options": [AggregationOption],
-  "position": 987
+  "position": 123
 }
 

-                    
-
back to top @@ -24508,16 +21862,12 @@
Fields
Example
- - - 
{
-  "count": 123,
+                  
{
+  "count": 987,
   "label": "abc123",
   "value": "abc123"
 }
 

-                    
-
back to top @@ -24583,16 +21933,12 @@
Possible Types
Example
- - - 
{
+                  
{
   "count": 987,
-  "label": "abc123",
-  "value": "xyz789"
+  "label": "xyz789",
+  "value": "abc123"
 }
 

-                    
-
back to top @@ -24632,12 +21978,8 @@
Fields
Example
- - - 
{"includeDirectChildrenOnly": false}
+                  
{"includeDirectChildrenOnly": false}
 

-                    
-
back to top @@ -24677,12 +22019,8 @@
Fields
Example
- - - 
{"category": AggregationsCategoryFilterInput}
+                  
{"category": AggregationsCategoryFilterInput}
 

-                    
-
back to top @@ -24752,21 +22090,17 @@
Fields
Example
- - - 
{
+                  
{
   "button_styles": ButtonStyles,
   "code": "abc123",
   "is_visible": true,
   "payment_intent": "abc123",
-  "payment_source": "abc123",
+  "payment_source": "xyz789",
   "sdk_params": [SDKParams],
   "sort_order": "abc123",
   "title": "abc123"
 }
 

-                    
-
back to top @@ -24818,16 +22152,12 @@
Fields
Example
- - - 
{
+                  
{
   "payment_source": "xyz789",
   "payments_order_id": "abc123",
-  "paypal_order_id": "xyz789"
+  "paypal_order_id": "abc123"
 }
 

-                    
-
back to top @@ -24866,12 +22196,8 @@
Fields
Example
- - - 
{"code": "abc123"}
+                  
{"code": "xyz789"}
 

-                    
-
back to top @@ -24925,17 +22251,13 @@
Fields
Example
- - - 
{
+                  
{
   "applied_balance": Money,
-  "code": "abc123",
+  "code": "xyz789",
   "current_balance": Money,
   "expiration_date": "xyz789"
 }
 

-                    
-
back to top @@ -24984,16 +22306,12 @@
Fields
Example
- - - 
{
+                  
{
   "applied_balance": Money,
   "current_balance": Money,
-  "enabled": true
+  "enabled": false
 }
 

-                    
-
back to top @@ -25039,15 +22357,11 @@
Fields
Example
- - - 
{
+                  
{
   "cart_id": "xyz789",
   "coupon_code": "xyz789"
 }
 

-                    
-
back to top @@ -25086,12 +22400,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -25137,12 +22447,8 @@
Values
Example
- - - 
"APPEND"
+                  
"APPEND"
 

-                    
-
back to top @@ -25196,16 +22502,12 @@
Fields
Example
- - - 
{
+                  
{
   "cart_id": "xyz789",
-  "coupon_codes": ["abc123"],
+  "coupon_codes": ["xyz789"],
   "type": "APPEND"
 }
 

-                    
-
back to top @@ -25251,15 +22553,11 @@
Fields
Example
- - - 
{
+                  
{
   "cart_id": "xyz789",
-  "gift_card_code": "xyz789"
+  "gift_card_code": "abc123"
 }
 

-                    
-
back to top @@ -25298,12 +22596,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -25347,15 +22641,11 @@
Fields
Example
- - - 
{
+                  
{
   "applied_balance": Money,
-  "code": "xyz789"
+  "code": "abc123"
 }
 

-                    
-
back to top @@ -25394,12 +22684,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -25439,12 +22725,8 @@
Fields
Example
- - - 
{"cart_id": "abc123"}
+                  
{"cart_id": "abc123"}
 

-                    
-
back to top @@ -25483,12 +22765,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -25534,12 +22812,8 @@
Fields
Example
- - - 
{"radius": 123, "search_term": "abc123"}
+                  
{"radius": 987, "search_term": "xyz789"}
 

-                    
-
back to top @@ -25583,12 +22857,8 @@
Fields
Example
- - - 
{"compare_list": CompareList, "result": true}
+                  
{"compare_list": CompareList, "result": false}
 

-                    
-
back to top @@ -25652,19 +22922,15 @@
Fields
Example
- - - 
{
+                  
{
   "attribute_code": "xyz789",
   "attribute_options": [AttributeOption],
   "attribute_type": "abc123",
-  "entity_type": "abc123",
+  "entity_type": "xyz789",
   "input_type": "abc123",
   "storefront_properties": StorefrontProperties
 }
 

-                    
-
back to top @@ -25733,12 +22999,8 @@
Values
Example
- - - 
"CATALOG_PRODUCT"
+                  
"CATALOG_PRODUCT"
 

-                    
-
back to top @@ -25844,25 +23106,21 @@
Fields
Example
- - - 
{
-  "is_comparable": true,
-  "is_filterable": false,
-  "is_filterable_in_search": true,
-  "is_html_allowed_on_front": true,
+                  
{
+  "is_comparable": false,
+  "is_filterable": true,
+  "is_filterable_in_search": false,
+  "is_html_allowed_on_front": false,
   "is_searchable": true,
-  "is_used_for_customer_segment": true,
-  "is_used_for_price_rules": false,
+  "is_used_for_customer_segment": false,
+  "is_used_for_price_rules": true,
   "is_used_for_promo_rules": true,
-  "is_visible_in_advanced_search": true,
+  "is_visible_in_advanced_search": false,
   "is_visible_on_front": true,
-  "is_wysiwyg_enabled": false,
-  "used_in_product_listing": false
+  "is_wysiwyg_enabled": true,
+  "used_in_product_listing": true
 }
 

-                    
-
back to top @@ -26008,12 +23266,8 @@
Values
Example
- - - 
"BOOLEAN"
+                  
"BOOLEAN"
 

-                    
-
back to top @@ -26059,15 +23313,11 @@
Fields
Example
- - - 
{
+                  
{
   "attribute_code": "xyz789",
-  "entity_type": "abc123"
+  "entity_type": "xyz789"
 }
 

-                    
-
back to top @@ -26107,12 +23357,8 @@
Fields
Example
- - - 
{"value": "xyz789"}
+                  
{"value": "xyz789"}
 

-                    
-
back to top @@ -26191,22 +23437,18 @@
Fields
Example
- - - 
{
+                  
{
   "code": 4,
   "default_value": "xyz789",
   "entity_type": "CATALOG_PRODUCT",
-  "frontend_class": "xyz789",
+  "frontend_class": "abc123",
   "frontend_input": "BOOLEAN",
   "is_required": false,
-  "is_unique": true,
+  "is_unique": false,
   "label": "xyz789",
   "options": [CustomAttributeOptionInterface]
 }
 

-                    
-
back to top @@ -26250,15 +23492,11 @@
Fields
Example
- - - 
{
-  "message": "abc123",
+                  
{
+  "message": "xyz789",
   "type": "ENTITY_NOT_FOUND"
 }
 

-                    
-
back to top @@ -26316,12 +23554,8 @@
Values
Example
- - - 
"ENTITY_NOT_FOUND"
+                  
"ENTITY_NOT_FOUND"
 

-                    
-
back to top @@ -26365,15 +23599,11 @@
Fields
Example
- - - 
{
-  "label": "xyz789",
+                  
{
+  "label": "abc123",
   "value": "xyz789"
 }
 

-                    
-
back to top @@ -26422,16 +23652,12 @@
Fields
Example
- - - 
{
-  "is_default": false,
+                  
{
+  "is_default": true,
   "label": "abc123",
-  "value": "xyz789"
+  "value": "abc123"
 }
 

-                    
-
back to top @@ -26471,15 +23697,11 @@
Fields
Example
- - - 
{
-  "label": "abc123",
+                  
{
+  "label": "xyz789",
   "value": "abc123"
 }
 

-                    
-
back to top @@ -26536,15 +23758,11 @@
Possible Types
Example
- - - 
{
+                  
{
   "label": "xyz789",
   "value": "abc123"
 }
 

-                    
-
back to top @@ -26585,15 +23803,11 @@
Fields
Example
- - - 
{
-  "code": 4,
+                  
{
+  "code": "4",
   "selected_options": [AttributeSelectedOptionInterface]
 }
 

-                    
-
back to top @@ -26633,15 +23847,8 @@
Fields
Example
- - - 
{
-  "code": "4",
-  "value": "abc123"
-}
+                  
{"code": 4, "value": "abc123"}
 

-                    
-
back to top @@ -26693,16 +23900,12 @@
Fields
Example
- - - 
{
-  "attribute_code": "xyz789",
+                  
{
+  "attribute_code": "abc123",
   "selected_options": [AttributeInputSelectedOption],
   "value": "abc123"
 }
 

-                    
-
back to top @@ -26759,12 +23962,8 @@
Possible Types
Example
- - - 
{"code": "4"}
+                  
{"code": 4}
 

-                    
-
back to top @@ -26808,15 +24007,11 @@
Fields
Example
- - - 
{
+                  
{
   "errors": [AttributeMetadataError],
   "items": [CustomAttributeMetadataInterface]
 }
 

-                    
-
back to top @@ -26860,15 +24055,11 @@
Fields
Example
- - - 
{
+                  
{
   "errors": [AttributeMetadataError],
   "items": [CustomAttributeMetadataInterface]
 }
 

-                    
-
back to top @@ -26912,12 +24103,8 @@
Fields
Example
- - - 
{"code": "AFN", "symbol": "xyz789"}
+                  
{"code": "AFN", "symbol": "xyz789"}
 

-                    
-
back to top @@ -26966,16 +24153,12 @@
Fields
Example
- - - 
{
-  "code": "abc123",
+                  
{
+  "code": "xyz789",
   "is_deferred": true,
   "title": "abc123"
 }
 

-                    
-
back to top @@ -27061,23 +24244,19 @@
Fields
Example
- - - 
{
+                  
{
   "amount": Money,
   "available": false,
   "base_amount": Money,
-  "carrier_code": "abc123",
+  "carrier_code": "xyz789",
   "carrier_title": "abc123",
   "error_message": "xyz789",
-  "method_code": "abc123",
+  "method_code": "xyz789",
   "method_title": "xyz789",
   "price_excl_tax": Money,
   "price_incl_tax": Money
 }
 

-                    
-
back to top @@ -27128,12 +24307,8 @@
Values
Example
- - - 
"SUCCESS"
+                  
"SUCCESS"
 

-                    
-
back to top @@ -27191,17 +24366,13 @@
Fields
Example
- - - 
{
+                  
{
   "address": CartAddressInput,
-  "customer_address_id": 987,
+  "customer_address_id": 123,
   "same_as_shipping": true,
-  "use_for_shipping": false
+  "use_for_shipping": true
 }
 

-                    
-
back to top @@ -27271,19 +24442,15 @@
Fields
Example
- - - 
{
-  "address_line_1": "abc123",
-  "address_line_2": "abc123",
-  "city": "xyz789",
+                  
{
+  "address_line_1": "xyz789",
+  "address_line_2": "xyz789",
+  "city": "abc123",
   "country_code": "xyz789",
-  "postal_code": "abc123",
+  "postal_code": "xyz789",
   "region": "xyz789"
 }
 

-                    
-
back to top @@ -27409,31 +24576,27 @@
Fields
Example
- - - 
{
-  "city": "abc123",
+                  
{
+  "city": "xyz789",
   "company": "xyz789",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
   "customer_notes": "abc123",
-  "fax": "xyz789",
+  "fax": "abc123",
   "firstname": "xyz789",
-  "id": 987,
+  "id": 123,
   "lastname": "abc123",
   "middlename": "abc123",
-  "postcode": "abc123",
-  "prefix": "xyz789",
+  "postcode": "xyz789",
+  "prefix": "abc123",
   "region": CartAddressRegion,
   "street": ["xyz789"],
-  "suffix": "xyz789",
-  "telephone": "xyz789",
+  "suffix": "abc123",
+  "telephone": "abc123",
   "uid": "xyz789",
-  "vat_id": "abc123"
+  "vat_id": "xyz789"
 }
 

-                    
-
back to top @@ -27454,12 +24617,8 @@
Description
Example
- - - 
true
+                  
true
 

-                    
-
back to top @@ -27503,15 +24662,11 @@
Fields
Example
- - - 
{
+                  
{
   "device_data": "xyz789",
   "public_hash": "abc123"
 }
 

-                    
-
back to top @@ -27559,16 +24714,12 @@
Fields
Example
- - - 
{
+                  
{
   "device_data": "xyz789",
   "is_active_payment_token_enabler": true,
   "payment_method_nonce": "abc123"
 }
 

-                    
-
back to top @@ -27612,15 +24763,11 @@
Fields
Example
- - - 
{
-  "device_data": "xyz789",
+                  
{
+  "device_data": "abc123",
   "public_hash": "xyz789"
 }
 

-                    
-
back to top @@ -27685,19 +24832,15 @@
Fields
Example
- - - 
{
+                  
{
   "category_id": 987,
-  "category_level": 987,
-  "category_name": "abc123",
-  "category_uid": "4",
-  "category_url_key": "xyz789",
+  "category_level": 123,
+  "category_name": "xyz789",
+  "category_uid": 4,
+  "category_url_key": "abc123",
   "category_url_path": "abc123"
 }
 

-                    
-
back to top @@ -27823,9 +24966,7 @@
Fields
Example
- - - 
{
+                  
{
   "available_gift_wrapping": [GiftWrapping],
   "bundle_options": [SelectedBundleOption],
   "customizable_options": [SelectedCustomizableOption],
@@ -27834,7 +24975,7 @@ 
Example

   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
   "id": "xyz789",
-  "is_available": false,
+  "is_available": true,
   "max_qty": 987.65,
   "min_qty": 987.65,
   "not_available_message": "xyz789",
@@ -27846,8 +24987,6 @@ 
Example

   "uid": 4
 }
 

-                    
-
back to top @@ -27921,21 +25060,17 @@
Fields
Example
- - - 
{
+                  
{
   "bundle_options": [ItemSelectedBundleOption],
   "discounts": [Discount],
   "id": 4,
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_refunded": 987.65
+  "product_sku": "xyz789",
+  "quantity_refunded": 123.45
 }
 

-                    
-
back to top @@ -28009,21 +25144,17 @@
Fields
Example
- - - 
{
+                  
{
   "bundle_options": [ItemSelectedBundleOption],
   "discounts": [Discount],
   "id": "4",
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "abc123",
+  "product_sku": "xyz789",
   "quantity_invoiced": 987.65
 }
 

-                    
-
back to top @@ -28103,22 +25234,18 @@
Fields
Example
- - - 
{
+                  
{
   "option_id": 987,
   "options": [BundleItemOption],
   "position": 123,
   "price_range": PriceRange,
   "required": false,
-  "sku": "xyz789",
+  "sku": "abc123",
   "title": "abc123",
   "type": "abc123",
   "uid": 4
 }
 

-                    
-
back to top @@ -28209,24 +25336,20 @@
Fields
Example
- - - 
{
-  "can_change_quantity": true,
+                  
{
+  "can_change_quantity": false,
   "id": 123,
-  "is_default": false,
-  "label": "xyz789",
-  "position": 987,
+  "is_default": true,
+  "label": "abc123",
+  "position": 123,
   "price": 123.45,
   "price_type": "FIXED",
   "product": ProductInterface,
-  "qty": 987.65,
-  "quantity": 987.65,
-  "uid": 4
+  "qty": 123.45,
+  "quantity": 123.45,
+  "uid": "4"
 }
 

-                    
-
back to top @@ -28278,16 +25401,12 @@
Fields
Example
- - - 
{
-  "id": 987,
+                  
{
+  "id": 123,
   "quantity": 987.65,
-  "value": ["abc123"]
+  "value": ["xyz789"]
 }
 

-                    
-
back to top @@ -28441,37 +25560,33 @@
Fields
Example
- - - 
{
+                  
{
   "bundle_options": [ItemSelectedBundleOption],
   "discounts": [Discount],
-  "eligible_for_return": false,
+  "eligible_for_return": true,
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
   "id": "4",
-  "parent_sku": "abc123",
+  "parent_sku": "xyz789",
   "prices": OrderItemPrices,
   "product": ProductInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "abc123",
-  "product_type": "abc123",
-  "product_url_key": "abc123",
+  "product_type": "xyz789",
+  "product_url_key": "xyz789",
   "quantity_canceled": 987.65,
   "quantity_invoiced": 123.45,
   "quantity_ordered": 123.45,
   "quantity_refunded": 987.65,
-  "quantity_return_requested": 987.65,
-  "quantity_returned": 987.65,
+  "quantity_return_requested": 123.45,
+  "quantity_returned": 123.45,
   "quantity_shipped": 123.45,
   "selected_options": [OrderItemOption],
-  "status": "abc123"
+  "status": "xyz789"
 }
 

-                    
-
back to top @@ -29055,9 +26170,7 @@
currentPage
Example
- - - 
{
+                  
{
   "activity": "abc123",
   "attribute_set_id": 123,
   "canonical_url": "xyz789",
@@ -29066,37 +26179,37 @@ 
Example

   "climate": "abc123",
   "collar": "abc123",
   "color": 987,
-  "country_of_manufacture": "abc123",
+  "country_of_manufacture": "xyz789",
   "created_at": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "dynamic_price": true,
+  "dynamic_price": false,
   "dynamic_sku": true,
-  "dynamic_weight": true,
+  "dynamic_weight": false,
   "eco_collection": 987,
   "erin_recommends": 123,
-  "features_bags": "xyz789",
+  "features_bags": "abc123",
   "format": 123,
-  "gender": "xyz789",
-  "gift_message_available": true,
-  "gift_wrapping_available": false,
+  "gender": "abc123",
+  "gift_message_available": false,
+  "gift_wrapping_available": true,
   "gift_wrapping_price": Money,
-  "id": 987,
+  "id": 123,
   "image": ProductImage,
-  "is_returnable": "abc123",
+  "is_returnable": "xyz789",
   "items": [BundleItem],
   "manufacturer": 123,
-  "material": "xyz789",
+  "material": "abc123",
   "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "xyz789",
-  "meta_keyword": "xyz789",
-  "meta_title": "abc123",
+  "meta_description": "abc123",
+  "meta_keyword": "abc123",
+  "meta_title": "xyz789",
   "min_sale_qty": 123.45,
   "name": "xyz789",
-  "new": 123,
+  "new": 987,
   "new_from_date": "abc123",
   "new_to_date": "xyz789",
   "only_x_left_in_stock": 987.65,
@@ -29110,50 +26223,48 @@ 
Example

   "price_tiers": [TierPrice],
   "price_view": "PRICE_RANGE",
   "product_links": [ProductLinksInterface],
-  "purpose": 123,
-  "quantity": 987.65,
-  "rating_summary": 123.45,
+  "purpose": 987,
+  "quantity": 123.45,
+  "rating_summary": 987.65,
   "redirect_code": 123,
   "related_products": [ProductInterface],
-  "relative_url": "xyz789",
-  "review_count": 123,
+  "relative_url": "abc123",
+  "review_count": 987,
   "reviews": ProductReviews,
   "rules": [CatalogRule],
   "sale": 987,
   "ship_bundle_items": "TOGETHER",
   "short_description": ComplexTextValue,
-  "size": 123,
-  "sku": "abc123",
-  "sleeve": "abc123",
+  "size": 987,
+  "sku": "xyz789",
+  "sleeve": "xyz789",
   "small_image": ProductImage,
-  "special_from_date": "abc123",
-  "special_price": 123.45,
-  "special_to_date": "abc123",
+  "special_from_date": "xyz789",
+  "special_price": 987.65,
+  "special_to_date": "xyz789",
   "staged": false,
   "stock_status": "IN_STOCK",
-  "strap_bags": "abc123",
-  "style_bags": "xyz789",
+  "strap_bags": "xyz789",
+  "style_bags": "abc123",
   "style_bottom": "xyz789",
   "style_general": "xyz789",
-  "swatch_image": "xyz789",
+  "swatch_image": "abc123",
   "thumbnail": ProductImage,
-  "tier_price": 987.65,
+  "tier_price": 123.45,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
-  "type_id": "abc123",
-  "uid": 4,
+  "type_id": "xyz789",
+  "uid": "4",
   "updated_at": "abc123",
   "upsell_products": [ProductInterface],
-  "url_key": "xyz789",
-  "url_path": "abc123",
+  "url_key": "abc123",
+  "url_path": "xyz789",
   "url_rewrites": [UrlRewrite],
   "url_suffix": "xyz789",
   "websites": [Website],
   "weight": 987.65
 }
 

-                    
-
back to top @@ -29205,16 +26316,12 @@
Fields
Example
- - - 
{
+                  
{
   "bundle_options": [BundleOptionInput],
   "customizable_options": [CustomizableOptionInput],
   "data": CartItemInput
 }
 

-                    
-
back to top @@ -29273,18 +26380,14 @@
Fields
Example
- - - 
{
+                  
{
   "bundle_options": [SelectedBundleOption],
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 987.65,
-  "uid": "4"
+  "quantity": 123.45,
+  "uid": 4
 }
 

-                    
-
back to top @@ -29353,20 +26456,16 @@
Fields
Example
- - - 
{
+                  
{
   "bundle_options": [ItemSelectedBundleOption],
   "id": "4",
   "order_item": OrderItemInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "xyz789",
   "quantity_shipped": 987.65
 }
 

-                    
-
back to top @@ -29435,9 +26534,7 @@
Fields
Example
- - - 
{
+                  
{
   "added_at": "abc123",
   "bundle_options": [SelectedBundleOption],
   "customizable_options": [SelectedCustomizableOption],
@@ -29447,8 +26544,6 @@ 
Example

   "quantity": 123.45
 }
 

-                    
-
back to top @@ -29513,20 +26608,16 @@
Fields
Example
- - - 
{
+                  
{
   "color": "xyz789",
   "height": 987,
   "label": "abc123",
-  "layout": "xyz789",
+  "layout": "abc123",
   "shape": "xyz789",
   "tagline": true,
-  "use_default_height": false
+  "use_default_height": true
 }
 

-                    
-
back to top @@ -29572,15 +26663,11 @@
Fields
Example
- - - 
{
+                  
{
   "cancellation_comment": "abc123",
   "template_id": "4"
 }
 

-                    
-
back to top @@ -29620,15 +26707,11 @@
Fields
Example
- - - 
{
+                  
{
   "code": "ORDER_CANCELLATION_DISABLED",
   "message": "xyz789"
 }
 

-                    
-
back to top @@ -29700,12 +26783,8 @@
Values
Example
- - - 
"ORDER_CANCELLATION_DISABLED"
+                  
"ORDER_CANCELLATION_DISABLED"
 

-                    
-
back to top @@ -29751,15 +26830,11 @@
Fields
Example
- - - 
{
+                  
{
   "order_id": "4",
-  "reason": "xyz789"
+  "reason": "abc123"
 }
 

-                    
-
back to top @@ -29809,16 +26884,12 @@
Fields
Example
- - - 
{
-  "error": "xyz789",
+                  
{
+  "error": "abc123",
   "errorV2": CancelOrderError,
   "order": CustomerOrder
 }
 

-                    
-
back to top @@ -29854,12 +26925,8 @@
Fields
Example
- - - 
{"description": "xyz789"}
+                  
{"description": "abc123"}
 

-                    
-
back to top @@ -29914,18 +26981,14 @@
Fields
Example
- - - 
{
+                  
{
   "bin_details": CardBin,
   "card_expiry_month": "abc123",
-  "card_expiry_year": "xyz789",
+  "card_expiry_year": "abc123",
   "last_digits": "xyz789",
   "name": "xyz789"
 }
 

-                    
-
back to top @@ -29960,12 +27023,8 @@
Fields
Example
- - - 
{"bin": "abc123"}
+                  
{"bin": "abc123"}
 

-                    
-
back to top @@ -30011,15 +27070,11 @@
Fields
Example
- - - 
{
+                  
{
   "billing_address": BillingAddressPaymentSourceInput,
   "name": "abc123"
 }
 

-                    
-
back to top @@ -30068,16 +27123,12 @@
Fields
Example
- - - 
{
-  "brand": "abc123",
-  "expiry": "abc123",
+                  
{
+  "brand": "xyz789",
+  "expiry": "xyz789",
   "last_digits": "xyz789"
 }
 

-                    
-
back to top @@ -30246,9 +27297,7 @@
sort
Example
- - - 
{
+                  
{
   "applied_coupon": AppliedCoupon,
   "applied_coupons": [AppliedCoupon],
   "applied_gift_cards": [AppliedGiftCard],
@@ -30259,10 +27308,10 @@ 
Example

   "billing_address": BillingCartAddress,
   "email": "xyz789",
   "gift_message": GiftMessage,
-  "gift_receipt_included": true,
+  "gift_receipt_included": false,
   "gift_wrapping": GiftWrapping,
-  "id": 4,
-  "is_virtual": true,
+  "id": "4",
+  "is_virtual": false,
   "items": [CartItemInterface],
   "itemsV2": CartItems,
   "prices": CartPrices,
@@ -30270,11 +27319,9 @@ 
Example

   "rules": [CartRule],
   "selected_payment_method": SelectedPaymentMethod,
   "shipping_addresses": [ShippingCartAddress],
-  "total_quantity": 123.45
+  "total_quantity": 987.65
 }
 

-                    
-
back to top @@ -30318,15 +27365,11 @@
Fields
Example
- - - 
{
-  "code": "abc123",
+                  
{
+  "code": "xyz789",
   "label": "abc123"
 }
 

-                    
-
back to top @@ -30462,30 +27505,26 @@
Fields
Example
- - - 
{
-  "city": "xyz789",
-  "company": "abc123",
+                  
{
+  "city": "abc123",
+  "company": "xyz789",
   "country_code": "xyz789",
   "custom_attributes": [AttributeValueInput],
-  "fax": "abc123",
+  "fax": "xyz789",
   "firstname": "xyz789",
   "lastname": "abc123",
-  "middlename": "abc123",
-  "postcode": "abc123",
+  "middlename": "xyz789",
+  "postcode": "xyz789",
   "prefix": "xyz789",
   "region": "xyz789",
   "region_id": 123,
-  "save_in_address_book": false,
+  "save_in_address_book": true,
   "street": ["abc123"],
   "suffix": "abc123",
   "telephone": "xyz789",
   "vat_id": "xyz789"
 }
 

-                    
-
back to top @@ -30622,30 +27661,26 @@
Possible Types
Example
- - - 
{
+                  
{
   "city": "abc123",
-  "company": "xyz789",
+  "company": "abc123",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
-  "fax": "abc123",
+  "fax": "xyz789",
   "firstname": "xyz789",
-  "id": 123,
-  "lastname": "xyz789",
-  "middlename": "xyz789",
+  "id": 987,
+  "lastname": "abc123",
+  "middlename": "abc123",
   "postcode": "xyz789",
   "prefix": "abc123",
   "region": CartAddressRegion,
-  "street": ["xyz789"],
+  "street": ["abc123"],
   "suffix": "abc123",
-  "telephone": "xyz789",
-  "uid": "abc123",
-  "vat_id": "xyz789"
+  "telephone": "abc123",
+  "uid": "xyz789",
+  "vat_id": "abc123"
 }
 

-                    
-
back to top @@ -30694,16 +27729,12 @@
Fields
Example
- - - 
{
-  "code": "abc123",
+                  
{
+  "code": "xyz789",
   "label": "xyz789",
-  "region_id": 987
+  "region_id": 123
 }
 

-                    
-
back to top @@ -30747,15 +27778,11 @@
Fields
Example
- - - 
{
+                  
{
   "amount": Money,
   "label": ["xyz789"]
 }
 

-                    
-
back to top @@ -30799,12 +27826,8 @@
Values
Example
- - - 
"ITEM"
+                  
"ITEM"
 

-                    
-
back to top @@ -30844,12 +27867,8 @@
Fields
Example
- - - 
{"code": "UNDEFINED", "message": "xyz789"}
+                  
{"code": "UNDEFINED", "message": "xyz789"}
 

-                    
-
back to top @@ -30900,12 +27919,8 @@
Values
Example
- - - 
"UNDEFINED"
+                  
"UNDEFINED"
 

-                    
-
back to top @@ -30969,18 +27984,14 @@
Fields
Example
- - - 
{
+                  
{
   "entered_options": [EnteredOptionInput],
   "parent_sku": "abc123",
   "quantity": 123.45,
-  "selected_options": ["4"],
-  "sku": "xyz789"
+  "selected_options": [4],
+  "sku": "abc123"
 }
 

-                    
-
back to top @@ -31123,26 +28134,22 @@
Possible Types
Example
- - - 
{
+                  
{
   "discount": [Discount],
   "errors": [CartItemError],
   "id": "abc123",
-  "is_available": false,
+  "is_available": true,
   "max_qty": 123.45,
-  "min_qty": 987.65,
+  "min_qty": 123.45,
   "not_available_message": "xyz789",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "uid": 4
 }
 

-                    
-
back to top @@ -31231,9 +28238,7 @@
Fields
Example
- - - 
{
+                  
{
   "catalog_discount": ProductDiscount,
   "discounts": [Discount],
   "fixed_product_taxes": [FixedProductTax],
@@ -31247,8 +28252,6 @@ 
Example

   "total_item_discount": Money
 }
 

-                    
-
back to top @@ -31296,12 +28299,8 @@
Fields
Example
- - - 
{"cart_item_id": 123, "quantity": 123.45}
+                  
{"cart_item_id": 123, "quantity": 123.45}
 

-                    
-
back to top @@ -31350,16 +28349,12 @@
Fields
Example
- - - 
{
+                  
{
   "type": "FIXED",
-  "units": "xyz789",
+  "units": "abc123",
   "value": 123.45
 }
 

-                    
-
back to top @@ -31429,19 +28424,15 @@
Fields
Example
- - - 
{
-  "cart_item_id": 987,
-  "cart_item_uid": 4,
+                  
{
+  "cart_item_id": 123,
+  "cart_item_uid": "4",
   "customizable_options": [CustomizableOptionInput],
   "gift_message": GiftMessageInput,
   "gift_wrapping_id": "4",
-  "quantity": 987.65
+  "quantity": 123.45
 }
 

-                    
-
back to top @@ -31486,16 +28477,12 @@
Fields
Example
- - - 
{
+                  
{
   "items": [CartItemInterface],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 

-                    
-
back to top @@ -31576,9 +28563,7 @@
Fields
Example
- - - 
{
+                  
{
   "applied_taxes": [CartTaxItem],
   "discount": CartDiscount,
   "discounts": [Discount],
@@ -31590,8 +28575,6 @@ 
Example

   "subtotal_with_discount_excluding_tax": Money
 }
 

-                    
-
back to top @@ -31626,12 +28609,8 @@
Fields
Example
- - - 
{"name": "abc123"}
+                  
{"name": "abc123"}
 

-                    
-
back to top @@ -31675,15 +28654,11 @@
Fields
Example
- - - 
{
+                  
{
   "amount": Money,
   "label": "abc123"
 }
 

-                    
-
back to top @@ -31723,15 +28698,11 @@
Fields
Example
- - - 
{
+                  
{
   "code": "PRODUCT_NOT_FOUND",
   "message": "abc123"
 }
 

-                    
-
back to top @@ -31817,12 +28788,8 @@
Values
Example
- - - 
"PRODUCT_NOT_FOUND"
+                  
"PRODUCT_NOT_FOUND"
 

-                    
-
back to top @@ -31901,12 +28868,8 @@
Values
Example
- - - 
"SIMPLE"
+                  
"SIMPLE"
 

-                    
-
back to top @@ -32060,37 +29023,33 @@
Fields
Example
- - - 
{
+                  
{
   "apply_to": ["SIMPLE"],
-  "code": "4",
-  "default_value": "abc123",
+  "code": 4,
+  "default_value": "xyz789",
   "entity_type": "CATALOG_PRODUCT",
   "frontend_class": "abc123",
   "frontend_input": "BOOLEAN",
   "is_comparable": false,
   "is_filterable": false,
-  "is_filterable_in_search": true,
-  "is_html_allowed_on_front": false,
-  "is_required": true,
+  "is_filterable_in_search": false,
+  "is_html_allowed_on_front": true,
+  "is_required": false,
   "is_searchable": false,
-  "is_unique": true,
+  "is_unique": false,
   "is_used_for_price_rules": true,
   "is_used_for_promo_rules": true,
   "is_visible_in_advanced_search": false,
   "is_visible_on_front": false,
-  "is_wysiwyg_enabled": true,
-  "label": "abc123",
+  "is_wysiwyg_enabled": false,
+  "label": "xyz789",
   "options": [CustomAttributeOptionInterface],
   "swatch_input_type": "BOOLEAN",
-  "update_product_preview_image": true,
+  "update_product_preview_image": false,
   "use_product_image_for_swatch": false,
-  "used_in_product_listing": true
+  "used_in_product_listing": false
 }
 

-                    
-
back to top @@ -32125,12 +29084,8 @@
Fields
Example
- - - 
{"name": "abc123"}
+                  
{"name": "xyz789"}
 

-                    
-
back to top @@ -32206,9 +29161,7 @@
Fields
Example
- - - 
{
+                  
{
   "category_uid": FilterEqualTypeInput,
   "ids": FilterEqualTypeInput,
   "name": FilterMatchTypeInput,
@@ -32218,8 +29171,6 @@ 
Example

   "url_path": FilterEqualTypeInput
 }
 

-                    
-
back to top @@ -32475,27 +29426,25 @@
Possible Types
Example
- - - 
{
+                  
{
   "automatic_sorting": "abc123",
   "available_sort_by": ["abc123"],
   "breadcrumbs": [Breadcrumb],
-  "canonical_url": "abc123",
-  "children_count": "xyz789",
+  "canonical_url": "xyz789",
+  "children_count": "abc123",
   "cms_block": CmsBlock,
-  "created_at": "xyz789",
-  "custom_layout_update_file": "xyz789",
-  "default_sort_by": "xyz789",
+  "created_at": "abc123",
+  "custom_layout_update_file": "abc123",
+  "default_sort_by": "abc123",
   "description": "xyz789",
-  "display_mode": "xyz789",
+  "display_mode": "abc123",
   "filter_price_range": 987.65,
-  "id": 123,
+  "id": 987,
   "image": "abc123",
   "include_in_menu": 987,
   "is_anchor": 123,
-  "landing_page": 987,
-  "level": 123,
+  "landing_page": 123,
+  "level": 987,
   "meta_description": "xyz789",
   "meta_keywords": "abc123",
   "meta_title": "abc123",
@@ -32503,18 +29452,16 @@ 
Example

   "path": "abc123",
   "path_in_store": "xyz789",
   "position": 987,
-  "product_count": 123,
+  "product_count": 987,
   "products": CategoryProducts,
   "staged": false,
   "uid": "4",
   "updated_at": "abc123",
   "url_key": "abc123",
   "url_path": "xyz789",
-  "url_suffix": "abc123"
+  "url_suffix": "xyz789"
 }
 

-                    
-
back to top @@ -32563,16 +29510,12 @@
Fields
Example
- - - 
{
+                  
{
   "items": [ProductInterface],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
 

-                    
-
back to top @@ -32621,16 +29564,12 @@
Fields
Example
- - - 
{
+                  
{
   "items": [CategoryTree],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
 

-                    
-
back to top @@ -32889,50 +29828,46 @@
sort
Example
- - - 
{
-  "automatic_sorting": "xyz789",
-  "available_sort_by": ["xyz789"],
+                  
{
+  "automatic_sorting": "abc123",
+  "available_sort_by": ["abc123"],
   "breadcrumbs": [Breadcrumb],
-  "canonical_url": "abc123",
+  "canonical_url": "xyz789",
   "children": [CategoryTree],
-  "children_count": "xyz789",
+  "children_count": "abc123",
   "cms_block": CmsBlock,
   "created_at": "abc123",
-  "custom_layout_update_file": "xyz789",
-  "default_sort_by": "abc123",
-  "description": "xyz789",
-  "display_mode": "abc123",
-  "filter_price_range": 987.65,
+  "custom_layout_update_file": "abc123",
+  "default_sort_by": "xyz789",
+  "description": "abc123",
+  "display_mode": "xyz789",
+  "filter_price_range": 123.45,
   "id": 123,
-  "image": "xyz789",
-  "include_in_menu": 123,
+  "image": "abc123",
+  "include_in_menu": 987,
   "is_anchor": 123,
   "landing_page": 123,
-  "level": 123,
+  "level": 987,
   "meta_description": "xyz789",
   "meta_keywords": "xyz789",
   "meta_title": "xyz789",
-  "name": "abc123",
+  "name": "xyz789",
   "path": "abc123",
   "path_in_store": "abc123",
-  "position": 123,
-  "product_count": 987,
+  "position": 987,
+  "product_count": 123,
   "products": CategoryProducts,
   "redirect_code": 123,
-  "relative_url": "abc123",
+  "relative_url": "xyz789",
   "staged": true,
   "type": "CMS_PAGE",
   "uid": 4,
   "updated_at": "abc123",
-  "url_key": "xyz789",
+  "url_key": "abc123",
   "url_path": "abc123",
   "url_suffix": "abc123"
 }
 

-                    
-
back to top @@ -33001,20 +29936,16 @@
Fields
Example
- - - 
{
-  "agreement_id": 123,
+                  
{
+  "agreement_id": 987,
   "checkbox_text": "abc123",
-  "content": "abc123",
-  "content_height": "xyz789",
-  "is_html": true,
+  "content": "xyz789",
+  "content_height": "abc123",
+  "is_html": false,
   "mode": "AUTO",
   "name": "xyz789"
 }
 

-                    
-
back to top @@ -33060,12 +29991,8 @@
Values
Example
- - - 
"AUTO"
+                  
"AUTO"
 

-                    
-
back to top @@ -33114,16 +30041,12 @@
Fields
Example
- - - 
{
+                  
{
   "code": "REORDER_NOT_AVAILABLE",
-  "message": "xyz789",
-  "path": ["abc123"]
+  "message": "abc123",
+  "path": ["xyz789"]
 }
 

-                    
-
back to top @@ -33188,12 +30111,8 @@
Values
Example
- - - 
"REORDER_NOT_AVAILABLE"
+                  
"REORDER_NOT_AVAILABLE"
 

-                    
-
back to top @@ -33237,12 +30156,8 @@
Fields
Example
- - - 
{"message": "abc123", "type": "NOT_FOUND"}
+                  
{"message": "abc123", "type": "NOT_FOUND"}
 

-                    
-
back to top @@ -33300,12 +30215,8 @@
Values
Example
- - - 
"NOT_FOUND"
+                  
"NOT_FOUND"
 

-                    
-
back to top @@ -33345,12 +30256,8 @@
Fields
Example
- - - 
{"uid": 4}
+                  
{"uid": 4}
 

-                    
-
back to top @@ -33394,15 +30301,11 @@
Fields
Example
- - - 
{
+                  
{
   "cart": Cart,
   "errors": [ClearCartError]
 }
 

-                    
-
back to top @@ -33446,12 +30349,8 @@
Fields
Example
- - - 
{"cart": Cart, "status": false}
+                  
{"cart": Cart, "status": false}
 

-                    
-
back to top @@ -33495,12 +30394,8 @@
Types
Example
- - - 
NegotiableQuoteInvalidStateError
+                  
NegotiableQuoteInvalidStateError
 

-                    
-
back to top @@ -33544,15 +30439,11 @@
Fields
Example
- - - 
{
+                  
{
   "errors": [NegotiableQuoteInvalidStateError],
   "quote_uid": "4"
 }
 

-                    
-
back to top @@ -33591,12 +30482,8 @@
Types
Example
- - - 
NegotiableQuoteUidOperationSuccess
+                  
NegotiableQuoteUidOperationSuccess
 

-                    
-
back to top @@ -33636,12 +30523,8 @@
Fields
Example
- - - 
{"quote_uids": ["4"]}
+                  
{"quote_uids": [4]}
 

-                    
-
back to top @@ -33725,9 +30608,7 @@
sort
Example
- - - 
{
+                  
{
   "closed_quotes": [NegotiableQuote],
   "negotiable_quotes": NegotiableQuotesOutput,
   "operation_results": [
@@ -33736,8 +30617,6 @@ 
Example

   "result_status": "SUCCESS"
 }
 

-                    
-
back to top @@ -33786,16 +30665,12 @@
Fields
Example
- - - 
{
-  "content": "abc123",
-  "identifier": "xyz789",
-  "title": "abc123"
+                  
{
+  "content": "xyz789",
+  "identifier": "abc123",
+  "title": "xyz789"
 }
 

-                    
-
back to top @@ -33834,12 +30709,8 @@
Fields
Example
- - - 
{"items": [CmsBlock]}
+                  
{"items": [CmsBlock]}
 

-                    
-
back to top @@ -33933,25 +30804,21 @@
Fields
Example
- - - 
{
-  "content": "abc123",
+                  
{
+  "content": "xyz789",
   "content_heading": "abc123",
   "identifier": "abc123",
   "meta_description": "xyz789",
-  "meta_keywords": "xyz789",
-  "meta_title": "xyz789",
+  "meta_keywords": "abc123",
+  "meta_title": "abc123",
   "page_layout": "abc123",
   "redirect_code": 987,
   "relative_url": "xyz789",
-  "title": "xyz789",
+  "title": "abc123",
   "type": "CMS_PAGE",
-  "url_key": "abc123"
+  "url_key": "xyz789"
 }
 

-                    
-
back to top @@ -33986,12 +30853,8 @@
Fields
Example
- - - 
{"value": "xyz789"}
+                  
{"value": "xyz789"}
 

-                    
-
back to top @@ -34031,12 +30894,8 @@
Values
Example
- - - 
"NAME"
+                  
"NAME"
 

-                    
-
back to top @@ -34082,12 +30941,8 @@
Fields
Example
- - - 
{"field": "NAME", "order": "ASC"}
+                  
{"field": "NAME", "order": "ASC"}
 

-                    
-
back to top @@ -34338,20 +31193,18 @@
currentPage
Example
- - - 
{
+                  
{
   "acl_resources": [CompanyAclResource],
   "company_admin": Customer,
   "credit": CompanyCredit,
   "credit_history": CompanyCreditHistory,
   "email": "xyz789",
-  "id": "4",
+  "id": 4,
   "legal_address": CompanyLegalAddress,
-  "legal_name": "abc123",
-  "name": "abc123",
+  "legal_name": "xyz789",
+  "name": "xyz789",
   "payment_methods": ["xyz789"],
-  "reseller_id": "xyz789",
+  "reseller_id": "abc123",
   "role": CompanyRole,
   "roles": CompanyRoles,
   "sales_representative": CompanySalesRepresentative,
@@ -34362,8 +31215,6 @@ 
Example

   "vat_tax_id": "xyz789"
 }
 

-                    
-
back to top @@ -34417,17 +31268,13 @@
Fields
Example
- - - 
{
+                  
{
   "children": [CompanyAclResource],
   "id": "4",
   "sort_order": 123,
-  "text": "xyz789"
+  "text": "abc123"
 }
 

-                    
-
back to top @@ -34503,20 +31350,16 @@
Fields
Example
- - - 
{
+                  
{
   "custom_attributes": [AttributeValueInput],
   "email": "xyz789",
   "firstname": "abc123",
-  "gender": 123,
+  "gender": 987,
   "job_title": "xyz789",
   "lastname": "abc123",
-  "telephone": "abc123"
+  "telephone": "xyz789"
 }
 

-                    
-
back to top @@ -34565,16 +31408,12 @@
Fields
Example
- - - 
{
+                  
{
   "id": "4",
-  "legal_name": "xyz789",
-  "name": "abc123"
+  "legal_name": "abc123",
+  "name": "xyz789"
 }
 

-                    
-
back to top @@ -34650,20 +31489,16 @@
Fields
Example
- - - 
{
+                  
{
   "company_admin": CompanyAdminInput,
   "company_email": "abc123",
   "company_name": "xyz789",
   "legal_address": CompanyLegalAddressCreateInput,
-  "legal_name": "xyz789",
+  "legal_name": "abc123",
   "reseller_id": "abc123",
-  "vat_tax_id": "abc123"
+  "vat_tax_id": "xyz789"
 }
 

-                    
-
back to top @@ -34712,16 +31547,12 @@
Fields
Example
- - - 
{
+                  
{
   "available_credit": Money,
   "credit_limit": Money,
   "outstanding_balance": Money
 }
 

-                    
-
back to top @@ -34770,16 +31601,12 @@
Fields
Example
- - - 
{
+                  
{
   "items": [CompanyCreditOperation],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
 

-                    
-
back to top @@ -34831,16 +31658,12 @@
Fields
Example
- - - 
{
+                  
{
   "custom_reference_number": "abc123",
   "operation_type": "ALLOCATION",
-  "updated_by": "abc123"
+  "updated_by": "xyz789"
 }
 

-                    
-
back to top @@ -34904,19 +31727,15 @@
Fields
Example
- - - 
{
+                  
{
   "amount": Money,
   "balance": CompanyCredit,
   "custom_reference_number": "abc123",
-  "date": "xyz789",
+  "date": "abc123",
   "type": "ALLOCATION",
   "updated_by": CompanyCreditOperationUser
 }
 

-                    
-
back to top @@ -34988,12 +31807,8 @@
Values
Example
- - - 
"ALLOCATION"
+                  
"ALLOCATION"
 

-                    
-
back to top @@ -35037,12 +31852,8 @@
Fields
Example
- - - 
{"name": "xyz789", "type": "CUSTOMER"}
+                  
{"name": "abc123", "type": "CUSTOMER"}
 

-                    
-
back to top @@ -35086,12 +31897,8 @@
Values
Example
- - - 
"CUSTOMER"
+                  
"CUSTOMER"
 

-                    
-
back to top @@ -35143,16 +31950,12 @@
Fields
Example
- - - 
{
+                  
{
   "code": "abc123",
   "role_id": 4,
   "user": CompanyInvitationUserInput
 }
 

-                    
-
back to top @@ -35191,12 +31994,8 @@
Fields
Example
- - - 
{"success": true}
+                  
{"success": true}
 

-                    
-
back to top @@ -35260,18 +32059,14 @@
Fields
Example
- - - 
{
-  "company_id": 4,
+                  
{
+  "company_id": "4",
   "customer_id": 4,
-  "job_title": "abc123",
+  "job_title": "xyz789",
   "status": "ACTIVE",
-  "telephone": "xyz789"
+  "telephone": "abc123"
 }
 

-                    
-
back to top @@ -35335,9 +32130,7 @@
Fields
Example
- - - 
{
+                  
{
   "city": "xyz789",
   "country_code": "AF",
   "postcode": "xyz789",
@@ -35346,8 +32139,6 @@ 
Example

   "telephone": "xyz789"
 }
 

-                    
-
back to top @@ -35417,19 +32208,15 @@
Fields
Example
- - - 
{
-  "city": "abc123",
+                  
{
+  "city": "xyz789",
   "country_id": "AF",
   "postcode": "xyz789",
   "region": CustomerAddressRegionInput,
-  "street": ["abc123"],
+  "street": ["xyz789"],
   "telephone": "abc123"
 }
 

-                    
-
back to top @@ -35499,19 +32286,15 @@
Fields
Example
- - - 
{
+                  
{
   "city": "xyz789",
   "country_id": "AF",
   "postcode": "xyz789",
   "region": CustomerAddressRegionInput,
-  "street": ["abc123"],
+  "street": ["xyz789"],
   "telephone": "abc123"
 }
 

-                    
-
back to top @@ -35565,17 +32348,13 @@
Fields
Example
- - - 
{
+                  
{
   "id": "4",
   "name": "abc123",
   "permissions": [CompanyAclResource],
-  "users_count": 123
+  "users_count": 987
 }
 

-                    
-
back to top @@ -35621,15 +32400,11 @@
Fields
Example
- - - 
{
-  "name": "abc123",
+                  
{
+  "name": "xyz789",
   "permissions": ["abc123"]
 }
 

-                    
-
back to top @@ -35681,16 +32456,12 @@
Fields
Example
- - - 
{
-  "id": 4,
+                  
{
+  "id": "4",
   "name": "abc123",
   "permissions": ["abc123"]
 }
 

-                    
-
back to top @@ -35739,16 +32510,12 @@
Fields
Example
- - - 
{
+                  
{
   "items": [CompanyRole],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 

-                    
-
back to top @@ -35797,16 +32564,12 @@
Fields
Example
- - - 
{
-  "email": "abc123",
+                  
{
+  "email": "xyz789",
   "firstname": "abc123",
   "lastname": "xyz789"
 }
 

-                    
-
back to top @@ -35845,12 +32608,8 @@
Fields
Example
- - - 
{"items": [CompanyStructureItem]}
+                  
{"items": [CompanyStructureItem]}
 

-                    
-
back to top @@ -35889,12 +32648,8 @@
Types
Example
- - - 
CompanyTeam
+                  
CompanyTeam
 

-                    
-
back to top @@ -35943,16 +32698,8 @@
Fields
Example
- - - 
{
-  "entity": CompanyTeam,
-  "id": 4,
-  "parent_id": "4"
-}
+                  
{"entity": CompanyTeam, "id": 4, "parent_id": 4}
 

-                    
-
back to top @@ -35998,12 +32745,8 @@
Fields
Example
- - - 
{"parent_tree_id": "4", "tree_id": 4}
+                  
{"parent_tree_id": 4, "tree_id": "4"}
 

-                    
-
back to top @@ -36057,17 +32800,13 @@
Fields
Example
- - - 
{
-  "description": "abc123",
+                  
{
+  "description": "xyz789",
   "id": "4",
-  "name": "xyz789",
-  "structure_id": 4
+  "name": "abc123",
+  "structure_id": "4"
 }
 

-                    
-
back to top @@ -36119,16 +32858,12 @@
Fields
Example
- - - 
{
-  "description": "abc123",
+                  
{
+  "description": "xyz789",
   "name": "abc123",
-  "target_id": "4"
+  "target_id": 4
 }
 

-                    
-
back to top @@ -36180,16 +32915,12 @@
Fields
Example
- - - 
{
-  "description": "abc123",
+                  
{
+  "description": "xyz789",
   "id": "4",
-  "name": "abc123"
+  "name": "xyz789"
 }
 

-                    
-
back to top @@ -36259,19 +32990,15 @@
Fields
Example
- - - 
{
+                  
{
   "company_email": "abc123",
-  "company_name": "abc123",
+  "company_name": "xyz789",
   "legal_address": CompanyLegalAddressUpdateInput,
-  "legal_name": "abc123",
+  "legal_name": "xyz789",
   "reseller_id": "abc123",
-  "vat_tax_id": "xyz789"
+  "vat_tax_id": "abc123"
 }
 

-                    
-
back to top @@ -36353,21 +33080,17 @@
Fields
Example
- - - 
{
+                  
{
   "email": "xyz789",
   "firstname": "abc123",
   "job_title": "xyz789",
-  "lastname": "xyz789",
-  "role_id": "4",
+  "lastname": "abc123",
+  "role_id": 4,
   "status": "ACTIVE",
-  "target_id": "4",
+  "target_id": 4,
   "telephone": "xyz789"
 }
 

-                    
-
back to top @@ -36413,12 +33136,8 @@
Values
Example
- - - 
"ACTIVE"
+                  
"ACTIVE"
 

-                    
-
back to top @@ -36500,21 +33219,17 @@
Fields
Example
- - - 
{
+                  
{
   "email": "xyz789",
-  "firstname": "abc123",
+  "firstname": "xyz789",
   "id": "4",
   "job_title": "abc123",
   "lastname": "xyz789",
-  "role_id": "4",
+  "role_id": 4,
   "status": "ACTIVE",
   "telephone": "xyz789"
 }
 

-                    
-
back to top @@ -36563,16 +33278,12 @@
Fields
Example
- - - 
{
+                  
{
   "items": [Customer],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 

-                    
-
back to top @@ -36612,12 +33323,8 @@
Fields
Example
- - - 
{"status": "ACTIVE"}
+                  
{"status": "ACTIVE"}
 

-                    
-
back to top @@ -36661,15 +33368,11 @@
Fields
Example
- - - 
{
+                  
{
   "code": "abc123",
   "label": "abc123"
 }
 

-                    
-
back to top @@ -36718,16 +33421,12 @@
Fields
Example
- - - 
{
+                  
{
   "attributes": [ProductAttribute],
   "product": ProductInterface,
   "uid": 4
 }
 

-                    
-
back to top @@ -36781,17 +33480,13 @@
Fields
Example
- - - 
{
+                  
{
   "attributes": [ComparableAttribute],
   "item_count": 123,
   "items": [ComparableItem],
-  "uid": 4
+  "uid": "4"
 }
 

-                    
-
back to top @@ -36826,12 +33521,8 @@
Fields
Example
- - - 
{"html": "xyz789"}
+                  
{"html": "xyz789"}
 

-                    
-
back to top @@ -36885,17 +33576,13 @@
Fields
Example
- - - 
{
+                  
{
   "code": "abc123",
   "label": "xyz789",
-  "uid": 4,
+  "uid": "4",
   "value_index": 987
 }
 

-                    
-
back to top @@ -37026,9 +33713,7 @@
Fields
Example
- - - 
{
+                  
{
   "available_gift_wrapping": [GiftWrapping],
   "configurable_options": [SelectedConfigurableOption],
   "configured_variant": ProductInterface,
@@ -37037,21 +33722,19 @@ 
Example

   "errors": [CartItemError],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": "xyz789",
+  "id": "abc123",
   "is_available": false,
   "max_qty": 987.65,
-  "min_qty": 987.65,
-  "not_available_message": "abc123",
+  "min_qty": 123.45,
+  "not_available_message": "xyz789",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "uid": 4
 }
 

-                    
-
back to top @@ -37095,15 +33778,11 @@
Fields
Example
- - - 
{
+                  
{
   "attribute_code": "abc123",
-  "option_value_uids": [4]
+  "option_value_uids": ["4"]
 }
 

-                    
-
back to top @@ -37248,9 +33927,7 @@
Fields
Example
- - - 
{
+                  
{
   "discounts": [Discount],
   "eligible_for_return": false,
   "entered_options": [OrderItemOption],
@@ -37262,22 +33939,20 @@ 
Example

   "product": ProductInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "xyz789",
-  "product_type": "xyz789",
+  "product_sku": "abc123",
+  "product_type": "abc123",
   "product_url_key": "abc123",
   "quantity_canceled": 987.65,
-  "quantity_invoiced": 987.65,
+  "quantity_invoiced": 123.45,
   "quantity_ordered": 123.45,
-  "quantity_refunded": 987.65,
-  "quantity_return_requested": 987.65,
+  "quantity_refunded": 123.45,
+  "quantity_return_requested": 123.45,
   "quantity_returned": 987.65,
-  "quantity_shipped": 123.45,
+  "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
-  "status": "abc123"
+  "status": "xyz789"
 }
 

-                    
-
back to top @@ -37854,80 +34529,78 @@
currentPage
Example
- - - 
{
-  "activity": "abc123",
-  "attribute_set_id": 987,
+                  
{
+  "activity": "xyz789",
+  "attribute_set_id": 123,
   "canonical_url": "abc123",
   "categories": [CategoryInterface],
   "category_gear": "xyz789",
-  "climate": "abc123",
-  "collar": "xyz789",
-  "color": 987,
+  "climate": "xyz789",
+  "collar": "abc123",
+  "color": 123,
   "configurable_options": [ConfigurableProductOptions],
   "configurable_product_options_selection": ConfigurableProductOptionsSelection,
-  "country_of_manufacture": "abc123",
+  "country_of_manufacture": "xyz789",
   "created_at": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "eco_collection": 987,
-  "erin_recommends": 123,
-  "features_bags": "abc123",
-  "format": 123,
+  "eco_collection": 123,
+  "erin_recommends": 987,
+  "features_bags": "xyz789",
+  "format": 987,
   "gender": "abc123",
-  "gift_message_available": true,
-  "gift_wrapping_available": false,
+  "gift_message_available": false,
+  "gift_wrapping_available": true,
   "gift_wrapping_price": Money,
   "id": 987,
   "image": ProductImage,
   "is_returnable": "xyz789",
   "manufacturer": 987,
   "material": "abc123",
-  "max_sale_qty": 123.45,
+  "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "abc123",
+  "meta_description": "xyz789",
   "meta_keyword": "abc123",
-  "meta_title": "abc123",
-  "min_sale_qty": 123.45,
+  "meta_title": "xyz789",
+  "min_sale_qty": 987.65,
   "name": "abc123",
   "new": 123,
   "new_from_date": "abc123",
   "new_to_date": "xyz789",
   "only_x_left_in_stock": 123.45,
   "options": [CustomizableOptionInterface],
-  "options_container": "xyz789",
+  "options_container": "abc123",
   "pattern": "abc123",
-  "performance_fabric": 123,
+  "performance_fabric": 987,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "purpose": 987,
+  "purpose": 123,
   "quantity": 123.45,
-  "rating_summary": 987.65,
-  "redirect_code": 123,
+  "rating_summary": 123.45,
+  "redirect_code": 987,
   "related_products": [ProductInterface],
   "relative_url": "xyz789",
-  "review_count": 987,
+  "review_count": 123,
   "reviews": ProductReviews,
   "rules": [CatalogRule],
-  "sale": 987,
+  "sale": 123,
   "short_description": ComplexTextValue,
-  "size": 987,
+  "size": 123,
   "sku": "xyz789",
   "sleeve": "abc123",
   "small_image": ProductImage,
   "special_from_date": "xyz789",
-  "special_price": 987.65,
-  "special_to_date": "abc123",
+  "special_price": 123.45,
+  "special_to_date": "xyz789",
   "staged": true,
   "stock_status": "IN_STOCK",
-  "strap_bags": "abc123",
+  "strap_bags": "xyz789",
   "style_bags": "abc123",
-  "style_bottom": "abc123",
+  "style_bottom": "xyz789",
   "style_general": "abc123",
   "swatch_image": "xyz789",
   "thumbnail": ProductImage,
@@ -37935,20 +34608,18 @@ 
Example

   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
   "type_id": "abc123",
-  "uid": "4",
+  "uid": 4,
   "updated_at": "xyz789",
   "upsell_products": [ProductInterface],
-  "url_key": "xyz789",
-  "url_path": "abc123",
+  "url_key": "abc123",
+  "url_path": "xyz789",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "abc123",
+  "url_suffix": "xyz789",
   "variants": [ConfigurableVariant],
   "websites": [Website],
   "weight": 123.45
 }
 

-                    
-
back to top @@ -38003,17 +34674,13 @@
Fields
Example
- - - 
{
+                  
{
   "customizable_options": [CustomizableOptionInput],
   "data": CartItemInput,
-  "parent_sku": "abc123",
-  "variant_sku": "xyz789"
+  "parent_sku": "xyz789",
+  "variant_sku": "abc123"
 }
 

-                    
-
back to top @@ -38067,17 +34734,13 @@
Fields
Example
- - - 
{
-  "attribute_code": "abc123",
+                  
{
+  "attribute_code": "xyz789",
   "label": "xyz789",
-  "uid": 4,
+  "uid": "4",
   "values": [ConfigurableProductOptionValue]
 }
 

-                    
-
back to top @@ -38136,18 +34799,14 @@
Fields
Example
- - - 
{
-  "is_available": true,
-  "is_use_default": true,
-  "label": "xyz789",
+                  
{
+  "is_available": false,
+  "is_use_default": false,
+  "label": "abc123",
   "swatch": SwatchDataInterface,
   "uid": 4
 }
 

-                    
-
back to top @@ -38240,24 +34899,20 @@
Fields
Example
- - - 
{
-  "attribute_code": "abc123",
-  "attribute_id": "xyz789",
-  "attribute_id_v2": 123,
-  "attribute_uid": 4,
-  "id": 123,
+                  
{
+  "attribute_code": "xyz789",
+  "attribute_id": "abc123",
+  "attribute_id_v2": 987,
+  "attribute_uid": "4",
+  "id": 987,
   "label": "xyz789",
-  "position": 123,
-  "product_id": 987,
+  "position": 987,
+  "product_id": 123,
   "uid": 4,
-  "use_default": false,
+  "use_default": true,
   "values": [ConfigurableProductOptionsValues]
 }
 

-                    
-
back to top @@ -38311,9 +34966,7 @@
Fields
Example
- - - 
{
+                  
{
   "configurable_options": [ConfigurableProductOption],
   "media_gallery": [MediaGalleryInterface],
   "options_available_for_selection": [
@@ -38322,8 +34975,6 @@ 
Example

   "variant": SimpleProduct
 }
 

-                    
-
back to top @@ -38393,20 +35044,16 @@
Fields
Example
- - - 
{
-  "default_label": "xyz789",
-  "label": "xyz789",
+                  
{
+  "default_label": "abc123",
+  "label": "abc123",
   "store_label": "xyz789",
   "swatch_data": SwatchDataInterface,
   "uid": "4",
-  "use_default_value": false,
+  "use_default_value": true,
   "value_index": 987
 }
 

-                    
-
back to top @@ -38465,18 +35112,14 @@
Fields
Example
- - - 
{
+                  
{
   "configurable_options": [SelectedConfigurableOption],
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 123.45,
-  "uid": 4
+  "quantity": 987.65,
+  "uid": "4"
 }
 

-                    
-
back to top @@ -38520,15 +35163,11 @@
Fields
Example
- - - 
{
+                  
{
   "attributes": [ConfigurableAttributeOption],
   "product": SimpleProduct
 }
 

-                    
-
back to top @@ -38608,22 +35247,18 @@
Fields
Example
- - - 
{
-  "added_at": "abc123",
-  "child_sku": "xyz789",
+                  
{
+  "added_at": "xyz789",
+  "child_sku": "abc123",
   "configurable_options": [SelectedConfigurableOption],
   "configured_variant": ProductInterface,
   "customizable_options": [SelectedCustomizableOption],
-  "description": "xyz789",
-  "id": 4,
+  "description": "abc123",
+  "id": "4",
   "product": ProductInterface,
   "quantity": 123.45
 }
 

-                    
-
back to top @@ -38665,15 +35300,11 @@
Fields
Example
- - - 
{
-  "confirmation_key": "xyz789",
-  "order_id": "4"
+                  
{
+  "confirmation_key": "abc123",
+  "order_id": 4
 }
 

-                    
-
back to top @@ -38719,15 +35350,11 @@
Fields
Example
- - - 
{
-  "confirmation_key": "abc123",
+                  
{
+  "confirmation_key": "xyz789",
   "email": "abc123"
 }
 

-                    
-
back to top @@ -38769,15 +35396,11 @@
Fields
Example
- - - 
{
+                  
{
   "confirmation_key": "xyz789",
   "order_id": "4"
 }
 

-                    
-
back to top @@ -38823,12 +35446,8 @@
Values
Example
- - - 
"ACCOUNT_CONFIRMED"
+                  
"ACCOUNT_CONFIRMED"
 

-                    
-
back to top @@ -38882,17 +35501,13 @@
Fields
Example
- - - 
{
+                  
{
   "comment": "xyz789",
   "email": "xyz789",
-  "name": "xyz789",
+  "name": "abc123",
   "telephone": "xyz789"
 }
 

-                    
-
back to top @@ -38931,12 +35546,8 @@
Fields
Example
- - - 
{"status": true}
+                  
{"status": true}
 

-                    
-
back to top @@ -38976,12 +35587,8 @@
Fields
Example
- - - 
{"requisitionListItemUids": [4]}
+                  
{"requisitionListItemUids": ["4"]}
 

-                    
-
back to top @@ -39020,12 +35627,8 @@
Fields
Example
- - - 
{"requisition_list": RequisitionList}
+                  
{"requisition_list": RequisitionList}
 

-                    
-
back to top @@ -39074,16 +35677,12 @@
Fields
Example
- - - 
{
+                  
{
   "destination_wishlist": Wishlist,
   "source_wishlist": Wishlist,
   "user_errors": [WishListUserInputError]
 }
 

-                    
-
back to top @@ -39143,19 +35742,15 @@
Fields
Example
- - - 
{
+                  
{
   "available_regions": [Region],
   "full_name_english": "abc123",
-  "full_name_locale": "xyz789",
+  "full_name_locale": "abc123",
   "id": "xyz789",
-  "three_letter_abbreviation": "abc123",
+  "three_letter_abbreviation": "xyz789",
   "two_letter_abbreviation": "xyz789"
 }
 

-                    
-
back to top @@ -40659,12 +37254,8 @@
Values
Example
- - - 
"AF"
+                  
"AF"
 

-                    
-
back to top @@ -40703,12 +37294,8 @@
Fields
Example
- - - 
{"company": Company}
+                  
{"company": Company}
 

-                    
-
back to top @@ -40747,12 +37334,8 @@
Fields
Example
- - - 
{"role": CompanyRole}
+                  
{"role": CompanyRole}
 

-                    
-
back to top @@ -40791,12 +37374,8 @@
Fields
Example
- - - 
{"team": CompanyTeam}
+                  
{"team": CompanyTeam}
 

-                    
-
back to top @@ -40835,12 +37414,8 @@
Fields
Example
- - - 
{"user": Customer}
+                  
{"user": Customer}
 

-                    
-
back to top @@ -40880,12 +37455,8 @@
Fields
Example
- - - 
{"products": ["4"]}
+                  
{"products": ["4"]}
 

-                    
-
back to top @@ -40967,23 +37538,19 @@
Fields
Example
- - - 
{
+                  
{
   "dynamic_attributes": [
     GiftRegistryDynamicAttributeInput
   ],
   "event_name": "xyz789",
   "gift_registry_type_uid": "4",
-  "message": "xyz789",
+  "message": "abc123",
   "privacy_settings": "PRIVATE",
   "registrants": [AddGiftRegistryRegistrantInput],
   "shipping_address": GiftRegistryShippingAddressInput,
   "status": "ACTIVE"
 }
 

-                    
-
back to top @@ -41022,12 +37589,8 @@
Fields
Example
- - - 
{"gift_registry": GiftRegistry}
+                  
{"gift_registry": GiftRegistry}
 

-                    
-
back to top @@ -41063,12 +37626,8 @@
Fields
Example
- - - 
{"cart_uid": "4"}
+                  
{"cart_uid": "4"}
 

-                    
-
back to top @@ -41103,12 +37662,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -41167,18 +37722,14 @@
Fields
Example
- - - 
{
+                  
{
   "response_message": "xyz789",
-  "result": 123,
+  "result": 987,
   "result_code": 123,
-  "secure_token": "abc123",
+  "secure_token": "xyz789",
   "secure_token_id": "abc123"
 }
 

-                    
-
back to top @@ -41242,18 +37793,14 @@
Fields
Example
- - - 
{
-  "cartId": "xyz789",
+                  
{
+  "cartId": "abc123",
   "location": "PRODUCT_DETAIL",
   "methodCode": "abc123",
-  "paymentSource": "xyz789",
-  "vaultIntent": false
+  "paymentSource": "abc123",
+  "vaultIntent": true
 }
 

-                    
-
back to top @@ -41312,18 +37859,14 @@
Fields
Example
- - - 
{
+                  
{
   "amount": 123.45,
   "currency_code": "abc123",
-  "id": "abc123",
-  "mp_order_id": "xyz789",
+  "id": "xyz789",
+  "mp_order_id": "abc123",
   "status": "xyz789"
 }
 

-                    
-
back to top @@ -41387,18 +37930,14 @@
Fields
Example
- - - 
{
+                  
{
   "nickname": "abc123",
   "ratings": [ProductReviewRatingInput],
   "sku": "xyz789",
-  "summary": "abc123",
+  "summary": "xyz789",
   "text": "xyz789"
 }
 

-                    
-
back to top @@ -41437,12 +37976,8 @@
Fields
Example
- - - 
{"review": ProductReview}
+                  
{"review": ProductReview}
 

-                    
-
back to top @@ -41488,12 +38023,8 @@
Fields
Example
- - - 
{"currency": "AFN", "value": 123.45}
+                  
{"currency": "AFN", "value": 987.65}
 

-                    
-
back to top @@ -41551,17 +38082,13 @@
Fields
Example
- - - 
{
+                  
{
   "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput,
   "attribute": "GRAND_TOTAL",
   "operator": "MORE_THAN",
-  "quantity": 123
+  "quantity": 987
 }
 

-                    
-
back to top @@ -41607,15 +38134,11 @@
Fields
Example
- - - 
{
+                  
{
   "description": "xyz789",
   "name": "abc123"
 }
 

-                    
-
back to top @@ -41654,12 +38177,8 @@
Fields
Example
- - - 
{"requisition_list": RequisitionList}
+                  
{"requisition_list": RequisitionList}
 

-                    
-
back to top @@ -41705,15 +38224,11 @@
Fields
Example
- - - 
{
-  "card_description": "xyz789",
+                  
{
+  "card_description": "abc123",
   "setup_token_id": "abc123"
 }
 

-                    
-
back to top @@ -41757,15 +38272,11 @@
Fields
Example
- - - 
{
+                  
{
   "payment_source": PaymentSourceOutput,
-  "vault_token_id": "abc123"
+  "vault_token_id": "xyz789"
 }
 

-                    
-
back to top @@ -41811,15 +38322,11 @@
Fields
Example
- - - 
{
+                  
{
   "setup_token": VaultSetupTokenInput,
   "three_ds_mode": "OFF"
 }
 

-                    
-
back to top @@ -41858,12 +38365,8 @@
Fields
Example
- - - 
{"setup_token": "abc123"}
+                  
{"setup_token": "abc123"}
 

-                    
-
back to top @@ -41909,12 +38412,8 @@
Fields
Example
- - - 
{"name": "abc123", "visibility": "PUBLIC"}
+                  
{"name": "abc123", "visibility": "PUBLIC"}
 

-                    
-
back to top @@ -41953,12 +38452,8 @@
Fields
Example
- - - 
{"wishlist": Wishlist}
+                  
{"wishlist": Wishlist}
 

-                    
-
back to top @@ -42016,17 +38511,13 @@
Fields
Example
- - - 
{
+                  
{
   "cc_exp_month": 123,
   "cc_exp_year": 123,
-  "cc_last_4": 123,
-  "cc_type": "abc123"
+  "cc_last_4": 987,
+  "cc_type": "xyz789"
 }
 

-                    
-
back to top @@ -42085,18 +38576,14 @@
Fields
Example
- - - 
{
+                  
{
   "comments": [SalesCommentItem],
-  "id": "4",
+  "id": 4,
   "items": [CreditMemoItemInterface],
-  "number": "xyz789",
+  "number": "abc123",
   "total": CreditMemoTotal
 }
 

-                    
-
back to top @@ -42161,9 +38648,7 @@
Fields
Example
- - - 
{
+                  
{
   "discounts": [Discount],
   "id": 4,
   "order_item": OrderItemInterface,
@@ -42173,8 +38658,6 @@ 
Example

   "quantity_refunded": 987.65
 }
 

-                    
-
back to top @@ -42275,9 +38758,7 @@
Possible Types
Example
- - - 
{
+                  
{
   "discounts": [Discount],
   "id": 4,
   "order_item": OrderItemInterface,
@@ -42287,8 +38768,6 @@ 
Example

   "quantity_refunded": 987.65
 }
 

-                    
-
back to top @@ -42367,9 +38846,7 @@
Fields
Example
- - - 
{
+                  
{
   "adjustment": Money,
   "base_grand_total": Money,
   "discounts": [Discount],
@@ -42381,8 +38858,6 @@ 
Example

   "total_tax": Money
 }
 

-                    
-
back to top @@ -42456,21 +38931,17 @@
Fields
Example
- - - 
{
+                  
{
   "available_currency_codes": ["abc123"],
   "base_currency_code": "abc123",
   "base_currency_symbol": "xyz789",
-  "default_display_currecy_code": "abc123",
+  "default_display_currecy_code": "xyz789",
   "default_display_currecy_symbol": "xyz789",
-  "default_display_currency_code": "abc123",
-  "default_display_currency_symbol": "xyz789",
+  "default_display_currency_code": "xyz789",
+  "default_display_currency_symbol": "abc123",
   "exchange_rates": [ExchangeRate]
 }
 

-                    
-
back to top @@ -43694,12 +40165,8 @@
Values
Example
- - - 
"AFN"
+                  
"AFN"
 

-                    
-
back to top @@ -43738,12 +40205,8 @@
Fields
Example
- - - 
{"items": [Attribute]}
+                  
{"items": [Attribute]}
 

-                    
-
back to top @@ -43854,11 +40317,9 @@
Possible Types
Example
- - - 
{
-  "code": 4,
-  "default_value": "abc123",
+                  
{
+  "code": "4",
+  "default_value": "xyz789",
   "entity_type": "CATALOG_PRODUCT",
   "frontend_class": "xyz789",
   "frontend_input": "BOOLEAN",
@@ -43868,8 +40329,6 @@ 
Example

   "options": [CustomAttributeOptionInterface]
 }
 

-                    
-
back to top @@ -43931,16 +40390,12 @@
Possible Types
Example
- - - 
{
+                  
{
   "is_default": false,
   "label": "xyz789",
   "value": "xyz789"
 }
 

-                    
-
back to top @@ -44488,33 +40943,31 @@
currentPage
Example
- - - 
{
+                  
{
   "addresses": [CustomerAddress],
   "addressesV2": CustomerAddresses,
   "allow_remote_shopping_assistance": false,
   "companies": UserCompaniesOutput,
   "compare_list": CompareList,
   "confirmation_status": "ACCOUNT_CONFIRMED",
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "custom_attributes": [AttributeValueInterface],
-  "date_of_birth": "abc123",
+  "date_of_birth": "xyz789",
   "default_billing": "xyz789",
   "default_shipping": "xyz789",
   "dob": "abc123",
-  "email": "xyz789",
-  "firstname": "xyz789",
-  "gender": 987,
+  "email": "abc123",
+  "firstname": "abc123",
+  "gender": 123,
   "gift_registries": [GiftRegistry],
   "gift_registry": GiftRegistry,
   "group": CustomerGroup,
-  "group_id": 123,
+  "group_id": 987,
   "id": 987,
   "is_subscribed": false,
-  "job_title": "abc123",
+  "job_title": "xyz789",
   "lastname": "abc123",
-  "middlename": "abc123",
+  "middlename": "xyz789",
   "orders": CustomerOrders,
   "prefix": "abc123",
   "purchase_order": PurchaseOrder,
@@ -44532,7 +40985,7 @@ 
Example

   "segments": [CustomerSegment],
   "status": "ACTIVE",
   "store_credit": CustomerStoreCredit,
-  "structure_id": 4,
+  "structure_id": "4",
   "suffix": "abc123",
   "taxvat": "xyz789",
   "team": CompanyTeam,
@@ -44542,8 +40995,6 @@ 
Example

   "wishlists": [Wishlist]
 }
 

-                    
-
back to top @@ -44709,36 +41160,32 @@
attributeCodes
Example
- - - 
{
+                  
{
   "city": "abc123",
   "company": "abc123",
   "country_code": "AF",
-  "country_id": "xyz789",
+  "country_id": "abc123",
   "custom_attributes": [CustomerAddressAttribute],
   "custom_attributesV2": [AttributeValueInterface],
-  "customer_id": 987,
-  "default_billing": true,
+  "customer_id": 123,
+  "default_billing": false,
   "default_shipping": true,
   "extension_attributes": [CustomerAddressAttribute],
   "fax": "xyz789",
   "firstname": "abc123",
   "id": 123,
   "lastname": "abc123",
-  "middlename": "xyz789",
-  "postcode": "xyz789",
+  "middlename": "abc123",
+  "postcode": "abc123",
   "prefix": "abc123",
   "region": CustomerAddressRegion,
   "region_id": 123,
-  "street": ["xyz789"],
+  "street": ["abc123"],
   "suffix": "abc123",
-  "telephone": "xyz789",
-  "vat_id": "xyz789"
+  "telephone": "abc123",
+  "vat_id": "abc123"
 }
 

-                    
-
back to top @@ -44782,15 +41229,11 @@
Fields
Example
- - - 
{
-  "attribute_code": "abc123",
+                  
{
+  "attribute_code": "xyz789",
   "value": "abc123"
 }
 

-                    
-
back to top @@ -44836,15 +41279,11 @@
Fields
Example
- - - 
{
+                  
{
   "attribute_code": "abc123",
-  "value": "xyz789"
+  "value": "abc123"
 }
 

-                    
-
back to top @@ -44994,32 +41433,28 @@
Fields
Example
- - - 
{
-  "city": "abc123",
+                  
{
+  "city": "xyz789",
   "company": "xyz789",
   "country_code": "AF",
   "country_id": "AF",
   "custom_attributes": [CustomerAddressAttributeInput],
   "custom_attributesV2": [AttributeValueInput],
-  "default_billing": true,
-  "default_shipping": true,
-  "fax": "abc123",
+  "default_billing": false,
+  "default_shipping": false,
+  "fax": "xyz789",
   "firstname": "xyz789",
-  "lastname": "xyz789",
+  "lastname": "abc123",
   "middlename": "xyz789",
-  "postcode": "abc123",
-  "prefix": "abc123",
+  "postcode": "xyz789",
+  "prefix": "xyz789",
   "region": CustomerAddressRegionInput,
-  "street": ["abc123"],
-  "suffix": "abc123",
+  "street": ["xyz789"],
+  "suffix": "xyz789",
   "telephone": "xyz789",
-  "vat_id": "xyz789"
+  "vat_id": "abc123"
 }
 

-                    
-
back to top @@ -45068,16 +41503,12 @@
Fields
Example
- - - 
{
+                  
{
   "region": "xyz789",
-  "region_code": "abc123",
-  "region_id": 987
+  "region_code": "xyz789",
+  "region_id": 123
 }
 

-                    
-
back to top @@ -45129,16 +41560,12 @@
Fields
Example
- - - 
{
-  "region": "xyz789",
-  "region_code": "abc123",
+                  
{
+  "region": "abc123",
+  "region_code": "xyz789",
   "region_id": 123
 }
 

-                    
-
back to top @@ -45183,16 +41610,12 @@
Fields
Example
- - - 
{
+                  
{
   "items": [CustomerAddress],
   "page_info": SearchResultPageInfo,
   "total_count": 123
 }
 

-                    
-
back to top @@ -45291,26 +41714,22 @@
Fields
Example
- - - 
{
-  "code": 4,
-  "default_value": "xyz789",
+                  
{
+  "code": "4",
+  "default_value": "abc123",
   "entity_type": "CATALOG_PRODUCT",
-  "frontend_class": "xyz789",
+  "frontend_class": "abc123",
   "frontend_input": "BOOLEAN",
   "input_filter": "NONE",
   "is_required": true,
-  "is_unique": false,
-  "label": "xyz789",
+  "is_unique": true,
+  "label": "abc123",
   "multiline_count": 987,
   "options": [CustomAttributeOptionInterface],
   "sort_order": 987,
   "validate_rules": [ValidationRule]
 }
 

-                    
-
back to top @@ -45429,27 +41848,23 @@
Fields
Example
- - - 
{
+                  
{
   "allow_remote_shopping_assistance": true,
   "custom_attributes": [AttributeValueInput],
   "date_of_birth": "abc123",
-  "dob": "abc123",
-  "email": "xyz789",
-  "firstname": "abc123",
+  "dob": "xyz789",
+  "email": "abc123",
+  "firstname": "xyz789",
   "gender": 987,
-  "is_subscribed": false,
+  "is_subscribed": true,
   "lastname": "abc123",
-  "middlename": "abc123",
-  "password": "xyz789",
-  "prefix": "abc123",
+  "middlename": "xyz789",
+  "password": "abc123",
+  "prefix": "xyz789",
   "suffix": "abc123",
-  "taxvat": "xyz789"
+  "taxvat": "abc123"
 }
 

-                    
-
back to top @@ -45508,18 +41923,14 @@
Fields
Example
- - - 
{
+                  
{
   "date": "xyz789",
-  "download_url": "xyz789",
+  "download_url": "abc123",
   "order_increment_id": "abc123",
   "remaining_downloads": "abc123",
-  "status": "abc123"
+  "status": "xyz789"
 }
 

-                    
-
back to top @@ -45558,12 +41969,8 @@
Fields
Example
- - - 
{"items": [CustomerDownloadableProduct]}
+                  
{"items": [CustomerDownloadableProduct]}
 

-                    
-
back to top @@ -45602,12 +42009,8 @@
Fields
Example
- - - 
{"name": "abc123"}
+                  
{"name": "abc123"}
 

-                    
-
back to top @@ -45714,25 +42117,21 @@
Fields
Example
- - - 
{
+                  
{
   "date_of_birth": "xyz789",
-  "dob": "xyz789",
+  "dob": "abc123",
   "email": "abc123",
-  "firstname": "xyz789",
+  "firstname": "abc123",
   "gender": 123,
   "is_subscribed": false,
   "lastname": "abc123",
-  "middlename": "abc123",
+  "middlename": "xyz789",
   "password": "abc123",
-  "prefix": "xyz789",
+  "prefix": "abc123",
   "suffix": "abc123",
-  "taxvat": "abc123"
+  "taxvat": "xyz789"
 }
 

-                    
-
back to top @@ -45960,30 +42359,28 @@
currentPage
Example
- - - 
{
+                  
{
   "applied_coupons": [AppliedCoupon],
   "applied_gift_cards": [ApplyGiftCardToOrder],
   "available_actions": ["REORDER"],
   "billing_address": OrderAddress,
-  "carrier": "xyz789",
+  "carrier": "abc123",
   "comments": [SalesCommentItem],
   "created_at": "abc123",
   "credit_memos": [CreditMemo],
   "customer_info": OrderCustomerInfo,
-  "email": "xyz789",
+  "email": "abc123",
   "gift_message": GiftMessage,
   "gift_receipt_included": false,
   "gift_wrapping": GiftWrapping,
-  "grand_total": 123.45,
-  "id": 4,
-  "increment_id": "abc123",
+  "grand_total": 987.65,
+  "id": "4",
+  "increment_id": "xyz789",
   "invoices": [Invoice],
   "is_virtual": false,
   "items": [OrderItemInterface],
   "items_eligible_for_return": [OrderItemInterface],
-  "number": "abc123",
+  "number": "xyz789",
   "order_date": "xyz789",
   "order_number": "abc123",
   "order_status_change_date": "xyz789",
@@ -45993,13 +42390,11 @@ 
Example

   "shipments": [OrderShipment],
   "shipping_address": OrderAddress,
   "shipping_method": "xyz789",
-  "status": "xyz789",
+  "status": "abc123",
   "token": "abc123",
   "total": OrderTotal
 }
 

-                    
-
back to top @@ -46045,12 +42440,8 @@
Fields
Example
- - - 
{"sort_direction": "ASC", "sort_field": "NUMBER"}
+                  
{"sort_direction": "ASC", "sort_field": "NUMBER"}
 

-                    
-
back to top @@ -46096,12 +42487,8 @@
Values
Example
- - - 
"NUMBER"
+                  
"NUMBER"
 

-                    
-
back to top @@ -46155,17 +42542,13 @@
Fields
Example
- - - 
{
-  "date_of_first_order": "abc123",
+                  
{
+  "date_of_first_order": "xyz789",
   "items": [CustomerOrder],
   "page_info": SearchResultPageInfo,
   "total_count": 987
 }
 

-                    
-
back to top @@ -46223,17 +42606,13 @@
Fields
Example
- - - 
{
+                  
{
   "grand_total": FilterRangeTypeInput,
   "number": FilterStringTypeInput,
   "order_date": FilterRangeTypeInput,
   "status": FilterEqualTypeInput
 }
 

-                    
-
back to top @@ -46272,12 +42651,8 @@
Fields
Example
- - - 
{"customer": Customer}
+                  
{"customer": Customer}
 

-                    
-
back to top @@ -46316,12 +42691,8 @@
Fields
Example
- - - 
{"items": [PaymentToken]}
+                  
{"items": [PaymentToken]}
 

-                    
-
back to top @@ -46370,16 +42741,12 @@
Fields
Example
- - - 
{
+                  
{
   "apply_to": "BOTH",
-  "description": "xyz789",
+  "description": "abc123",
   "name": "xyz789"
 }
 

-                    
-
back to top @@ -46431,12 +42798,8 @@
Values
Example
- - - 
"BOTH"
+                  
"BOTH"
 

-                    
-
back to top @@ -46504,16 +42867,12 @@
currentPage
Example
- - - 
{
+                  
{
   "balance_history": CustomerStoreCreditHistory,
   "current_balance": Money,
-  "enabled": true
+  "enabled": false
 }
 

-                    
-
back to top @@ -46562,16 +42921,12 @@
Fields
Example
- - - 
{
+                  
{
   "items": [CustomerStoreCreditHistoryItem],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 

-                    
-
back to top @@ -46625,17 +42980,13 @@
Fields
Example
- - - 
{
-  "action": "abc123",
+                  
{
+  "action": "xyz789",
   "actual_balance": Money,
   "balance_change": Money,
   "date_time_changed": "abc123"
 }
 

-                    
-
back to top @@ -46674,12 +43025,8 @@
Fields
Example
- - - 
{"token": "abc123"}
+                  
{"token": "abc123"}
 

-                    
-
back to top @@ -46786,25 +43133,21 @@
Fields
Example
- - - 
{
-  "allow_remote_shopping_assistance": false,
+                  
{
+  "allow_remote_shopping_assistance": true,
   "custom_attributes": [AttributeValueInput],
-  "date_of_birth": "abc123",
-  "dob": "abc123",
-  "firstname": "abc123",
+  "date_of_birth": "xyz789",
+  "dob": "xyz789",
+  "firstname": "xyz789",
   "gender": 123,
   "is_subscribed": true,
   "lastname": "xyz789",
-  "middlename": "xyz789",
-  "prefix": "abc123",
+  "middlename": "abc123",
+  "prefix": "xyz789",
   "suffix": "abc123",
-  "taxvat": "abc123"
+  "taxvat": "xyz789"
 }
 

-                    
-
back to top @@ -46874,20 +43217,16 @@
Fields
Example
- - - 
{
-  "option_id": 123,
-  "product_sku": "abc123",
+                  
{
+  "option_id": 987,
+  "product_sku": "xyz789",
   "required": false,
-  "sort_order": 123,
+  "sort_order": 987,
   "title": "xyz789",
-  "uid": 4,
+  "uid": "4",
   "value": CustomizableAreaValue
 }
 

-                    
-
back to top @@ -46946,18 +43285,14 @@
Fields
Example
- - - 
{
-  "max_characters": 987,
-  "price": 987.65,
+                  
{
+  "max_characters": 123,
+  "price": 123.45,
   "price_type": "FIXED",
   "sku": "abc123",
-  "uid": "4"
+  "uid": 4
 }
 

-                    
-
back to top @@ -47022,19 +43357,15 @@
Fields
Example
- - - 
{
-  "option_id": 987,
+                  
{
+  "option_id": 123,
   "required": true,
   "sort_order": 987,
-  "title": "xyz789",
+  "title": "abc123",
   "uid": "4",
   "value": [CustomizableCheckboxValue]
 }
 

-                    
-
back to top @@ -47103,20 +43434,16 @@
Fields
Example
- - - 
{
-  "option_type_id": 987,
-  "price": 987.65,
+                  
{
+  "option_type_id": 123,
+  "price": 123.45,
   "price_type": "FIXED",
   "sku": "xyz789",
-  "sort_order": 123,
+  "sort_order": 987,
   "title": "xyz789",
   "uid": 4
 }
 

-                    
-
back to top @@ -47186,20 +43513,16 @@
Fields
Example
- - - 
{
-  "option_id": 987,
+                  
{
+  "option_id": 123,
   "product_sku": "xyz789",
   "required": true,
   "sort_order": 123,
   "title": "abc123",
-  "uid": 4,
+  "uid": "4",
   "value": CustomizableDateValue
 }
 

-                    
-
back to top @@ -47254,12 +43577,8 @@
Values
Example
- - - 
"DATE"
+                  
"DATE"
 

-                    
-
back to top @@ -47318,18 +43637,14 @@
Fields
Example
- - - 
{
+                  
{
   "price": 987.65,
   "price_type": "FIXED",
   "sku": "abc123",
   "type": "DATE",
-  "uid": "4"
+  "uid": 4
 }
 

-                    
-
back to top @@ -47394,19 +43709,15 @@
Fields
Example
- - - 
{
+                  
{
   "option_id": 987,
-  "required": false,
-  "sort_order": 123,
+  "required": true,
+  "sort_order": 987,
   "title": "abc123",
   "uid": "4",
   "value": [CustomizableDropDownValue]
 }
 

-                    
-
back to top @@ -47475,20 +43786,16 @@
Fields
Example
- - - 
{
-  "option_type_id": 123,
+                  
{
+  "option_type_id": 987,
   "price": 987.65,
   "price_type": "FIXED",
   "sku": "xyz789",
   "sort_order": 987,
-  "title": "abc123",
+  "title": "xyz789",
   "uid": 4
 }
 

-                    
-
back to top @@ -47558,20 +43865,16 @@
Fields
Example
- - - 
{
-  "option_id": 987,
-  "product_sku": "abc123",
+                  
{
+  "option_id": 123,
+  "product_sku": "xyz789",
   "required": false,
-  "sort_order": 123,
-  "title": "abc123",
+  "sort_order": 987,
+  "title": "xyz789",
   "uid": 4,
   "value": CustomizableFieldValue
 }
 

-                    
-
back to top @@ -47630,18 +43933,14 @@
Fields
Example
- - - 
{
-  "max_characters": 123,
+                  
{
+  "max_characters": 987,
   "price": 123.45,
   "price_type": "FIXED",
-  "sku": "xyz789",
-  "uid": "4"
+  "sku": "abc123",
+  "uid": 4
 }
 

-                    
-
back to top @@ -47711,20 +44010,16 @@
Fields
Example
- - - 
{
-  "option_id": 987,
+                  
{
+  "option_id": 123,
   "product_sku": "xyz789",
-  "required": true,
+  "required": false,
   "sort_order": 987,
-  "title": "abc123",
+  "title": "xyz789",
   "uid": "4",
   "value": CustomizableFileValue
 }
 

-                    
-
back to top @@ -47793,10 +44088,8 @@
Fields
Example
- - - 
{
-  "file_extension": "xyz789",
+                  
{
+  "file_extension": "abc123",
   "image_size_x": 123,
   "image_size_y": 987,
   "price": 123.45,
@@ -47805,8 +44098,6 @@ 
Example

   "uid": "4"
 }
 

-                    
-
back to top @@ -47871,19 +44162,15 @@
Fields
Example
- - - 
{
-  "option_id": 123,
+                  
{
+  "option_id": 987,
   "required": false,
   "sort_order": 987,
   "title": "abc123",
-  "uid": "4",
+  "uid": 4,
   "value": [CustomizableMultipleValue]
 }
 

-                    
-
back to top @@ -47952,20 +44239,16 @@
Fields
Example
- - - 
{
+                  
{
   "option_type_id": 123,
-  "price": 123.45,
+  "price": 987.65,
   "price_type": "FIXED",
-  "sku": "xyz789",
-  "sort_order": 123,
-  "title": "abc123",
+  "sku": "abc123",
+  "sort_order": 987,
+  "title": "xyz789",
   "uid": 4
 }
 

-                    
-
back to top @@ -48017,16 +44300,12 @@
Fields
Example
- - - 
{
-  "id": 123,
-  "uid": "4",
-  "value_string": "xyz789"
+                  
{
+  "id": 987,
+  "uid": 4,
+  "value_string": "abc123"
 }
 

-                    
-
back to top @@ -48138,18 +44417,14 @@
Possible Types
Example
- - - 
{
+                  
{
   "option_id": 987,
   "required": true,
-  "sort_order": 987,
+  "sort_order": 123,
   "title": "abc123",
-  "uid": "4"
+  "uid": 4
 }
 

-                    
-
back to top @@ -48230,12 +44505,8 @@
Possible Types
Example
- - - 
{"options": [CustomizableOptionInterface]}
+                  
{"options": [CustomizableOptionInterface]}
 

-                    
-
back to top @@ -48300,19 +44571,15 @@
Fields
Example
- - - 
{
+                  
{
   "option_id": 123,
   "required": true,
-  "sort_order": 987,
-  "title": "abc123",
+  "sort_order": 123,
+  "title": "xyz789",
   "uid": 4,
   "value": [CustomizableRadioValue]
 }
 

-                    
-
back to top @@ -48381,20 +44648,16 @@
Fields
Example
- - - 
{
+                  
{
   "option_type_id": 123,
   "price": 123.45,
   "price_type": "FIXED",
   "sku": "abc123",
-  "sort_order": 987,
-  "title": "xyz789",
+  "sort_order": 123,
+  "title": "abc123",
   "uid": "4"
 }
 

-                    
-
back to top @@ -48433,12 +44696,8 @@
Fields
Example
- - - 
{"success": true}
+                  
{"success": false}
 

-                    
-
back to top @@ -48477,12 +44736,8 @@
Fields
Example
- - - 
{"success": false}
+                  
{"success": true}
 

-                    
-
back to top @@ -48521,12 +44776,8 @@
Fields
Example
- - - 
{"success": true}
+                  
{"success": true}
 

-                    
-
back to top @@ -48565,12 +44816,8 @@
Fields
Example
- - - 
{"result": false}
+                  
{"result": false}
 

-                    
-
back to top @@ -48614,12 +44861,8 @@
Types
Example
- - - 
NegotiableQuoteInvalidStateError
+                  
NegotiableQuoteInvalidStateError
 

-                    
-
back to top @@ -48664,15 +44907,11 @@
Fields
Example
- - - 
{
+                  
{
   "errors": [NegotiableQuoteInvalidStateError],
-  "quote_uid": 4
+  "quote_uid": "4"
 }
 

-                    
-
back to top @@ -48711,12 +44950,8 @@
Types
Example
- - - 
NegotiableQuoteUidOperationSuccess
+                  
NegotiableQuoteUidOperationSuccess
 

-                    
-
back to top @@ -48756,12 +44991,8 @@
Fields
Example
- - - 
{"template_id": "4"}
+                  
{"template_id": "4"}
 

-                    
-
back to top @@ -48797,12 +45028,8 @@
Fields
Example
- - - 
{"quote_uids": [4]}
+                  
{"quote_uids": [4]}
 

-                    
-
back to top @@ -48880,9 +45107,7 @@
sort
Example
- - - 
{
+                  
{
   "negotiable_quotes": NegotiableQuotesOutput,
   "operation_results": [
     NegotiableQuoteUidOperationSuccess
@@ -48890,8 +45115,6 @@ 
Example

   "result_status": "SUCCESS"
 }
 

-                    
-
back to top @@ -48935,15 +45158,11 @@
Fields
Example
- - - 
{
+                  
{
   "customerPaymentTokens": CustomerPaymentTokens,
-  "result": true
+  "result": false
 }
 

-                    
-
back to top @@ -48987,12 +45206,8 @@
Fields
Example
- - - 
{"message": "abc123", "type": "UNDEFINED"}
+                  
{"message": "xyz789", "type": "UNDEFINED"}
 

-                    
-
back to top @@ -49036,12 +45251,8 @@
Values
Example
- - - 
"UNDEFINED"
+                  
"UNDEFINED"
 

-                    
-
back to top @@ -49081,12 +45292,8 @@
Fields
Example
- - - 
{"approval_rule_uids": ["4"]}
+                  
{"approval_rule_uids": ["4"]}
 

-                    
-
back to top @@ -49125,12 +45332,8 @@
Fields
Example
- - - 
{"errors": [DeletePurchaseOrderApprovalRuleError]}
+                  
{"errors": [DeletePurchaseOrderApprovalRuleError]}
 

-                    
-
back to top @@ -49169,12 +45372,8 @@
Fields
Example
- - - 
{"requisition_list": RequisitionList}
+                  
{"requisition_list": RequisitionList}
 

-                    
-
back to top @@ -49218,12 +45417,8 @@
Fields
Example
- - - 
{"requisition_lists": RequisitionLists, "status": false}
+                  
{"requisition_lists": RequisitionLists, "status": true}
 

-                    
-
back to top @@ -49267,12 +45462,8 @@
Fields
Example
- - - 
{"status": false, "wishlists": [Wishlist]}
+                  
{"status": false, "wishlists": [Wishlist]}
 

-                    
-
back to top @@ -49341,20 +45532,16 @@
Fields
Example
- - - 
{
+                  
{
   "amount": Money,
   "applied_to": "ITEM",
   "coupon": AppliedCoupon,
-  "is_discounting_locked": false,
-  "label": "abc123",
-  "type": "abc123",
+  "is_discounting_locked": true,
+  "label": "xyz789",
+  "type": "xyz789",
   "value": 987.65
 }
 

-                    
-
back to top @@ -49470,9 +45657,7 @@
Fields
Example
- - - 
{
+                  
{
   "customizable_options": [SelectedCustomizableOption],
   "discount": [Discount],
   "errors": [CartItemError],
@@ -49480,19 +45665,17 @@ 
Example

   "is_available": false,
   "links": [DownloadableProductLinks],
   "max_qty": 987.65,
-  "min_qty": 123.45,
-  "not_available_message": "xyz789",
+  "min_qty": 987.65,
+  "not_available_message": "abc123",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 123.45,
+  "quantity": 987.65,
   "samples": [DownloadableProductSamples],
-  "uid": 4
+  "uid": "4"
 }
 

-                    
-
back to top @@ -49566,21 +45749,17 @@
Fields
Example
- - - 
{
+                  
{
   "discounts": [Discount],
   "downloadable_links": [DownloadableItemsLinks],
   "id": "4",
   "order_item": OrderItemInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "xyz789",
   "quantity_refunded": 123.45
 }
 

-                    
-
back to top @@ -49626,12 +45805,8 @@
Values
Example
- - - 
"FILE"
+                  
"FILE"
 

-                    
-
back to top @@ -49705,21 +45880,17 @@
Fields
Example
- - - 
{
+                  
{
   "discounts": [Discount],
   "downloadable_links": [DownloadableItemsLinks],
   "id": 4,
   "order_item": OrderItemInterface,
-  "product_name": "xyz789",
+  "product_name": "abc123",
   "product_sale_price": Money,
   "product_sku": "abc123",
-  "quantity_invoiced": 987.65
+  "quantity_invoiced": 123.45
 }
 

-                    
-
back to top @@ -49768,16 +45939,12 @@
Fields
Example
- - - 
{
+                  
{
   "sort_order": 987,
   "title": "abc123",
   "uid": "4"
 }
 

-                    
-
back to top @@ -49926,16 +46093,14 @@
Fields
Example
- - - 
{
+                  
{
   "discounts": [Discount],
   "downloadable_links": [DownloadableItemsLinks],
-  "eligible_for_return": true,
+  "eligible_for_return": false,
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": "4",
+  "id": 4,
   "prices": OrderItemPrices,
   "product": ProductInterface,
   "product_name": "xyz789",
@@ -49944,18 +46109,16 @@ 
Example

   "product_type": "abc123",
   "product_url_key": "abc123",
   "quantity_canceled": 123.45,
-  "quantity_invoiced": 123.45,
-  "quantity_ordered": 987.65,
-  "quantity_refunded": 123.45,
+  "quantity_invoiced": 987.65,
+  "quantity_ordered": 123.45,
+  "quantity_refunded": 987.65,
   "quantity_return_requested": 123.45,
-  "quantity_returned": 987.65,
+  "quantity_returned": 123.45,
   "quantity_shipped": 123.45,
   "selected_options": [OrderItemOption],
   "status": "xyz789"
 }
 

-                    
-
back to top @@ -50519,19 +46682,17 @@
currentPage
Example
- - - 
{
-  "activity": "xyz789",
-  "attribute_set_id": 123,
+                  
{
+  "activity": "abc123",
+  "attribute_set_id": 987,
   "canonical_url": "xyz789",
   "categories": [CategoryInterface],
-  "category_gear": "xyz789",
-  "climate": "xyz789",
+  "category_gear": "abc123",
+  "climate": "abc123",
   "collar": "xyz789",
-  "color": 987,
-  "country_of_manufacture": "abc123",
-  "created_at": "abc123",
+  "color": 123,
+  "country_of_manufacture": "xyz789",
+  "created_at": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
@@ -50542,44 +46703,44 @@ 
Example

     DownloadableProductSamples
   ],
   "eco_collection": 987,
-  "erin_recommends": 987,
-  "features_bags": "abc123",
+  "erin_recommends": 123,
+  "features_bags": "xyz789",
   "format": 123,
   "gender": "xyz789",
-  "gift_message_available": true,
+  "gift_message_available": false,
   "gift_wrapping_available": true,
   "gift_wrapping_price": Money,
-  "id": 987,
+  "id": 123,
   "image": ProductImage,
   "is_returnable": "abc123",
-  "links_purchased_separately": 987,
+  "links_purchased_separately": 123,
   "links_title": "abc123",
-  "manufacturer": 123,
+  "manufacturer": 987,
   "material": "xyz789",
   "max_sale_qty": 123.45,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "xyz789",
-  "meta_keyword": "abc123",
+  "meta_description": "abc123",
+  "meta_keyword": "xyz789",
   "meta_title": "abc123",
-  "min_sale_qty": 123.45,
-  "name": "xyz789",
+  "min_sale_qty": 987.65,
+  "name": "abc123",
   "new": 987,
-  "new_from_date": "xyz789",
+  "new_from_date": "abc123",
   "new_to_date": "xyz789",
-  "only_x_left_in_stock": 987.65,
+  "only_x_left_in_stock": 123.45,
   "options": [CustomizableOptionInterface],
-  "options_container": "abc123",
-  "pattern": "abc123",
-  "performance_fabric": 987,
+  "options_container": "xyz789",
+  "pattern": "xyz789",
+  "performance_fabric": 123,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
   "purpose": 987,
-  "quantity": 123.45,
-  "rating_summary": 123.45,
-  "redirect_code": 987,
+  "quantity": 987.65,
+  "rating_summary": 987.65,
+  "redirect_code": 123,
   "related_products": [ProductInterface],
   "relative_url": "abc123",
   "review_count": 123,
@@ -50588,19 +46749,19 @@ 
Example

   "sale": 123,
   "short_description": ComplexTextValue,
   "size": 123,
-  "sku": "xyz789",
-  "sleeve": "xyz789",
+  "sku": "abc123",
+  "sleeve": "abc123",
   "small_image": ProductImage,
   "special_from_date": "xyz789",
-  "special_price": 987.65,
-  "special_to_date": "abc123",
+  "special_price": 123.45,
+  "special_to_date": "xyz789",
   "staged": false,
   "stock_status": "IN_STOCK",
   "strap_bags": "abc123",
-  "style_bags": "abc123",
+  "style_bags": "xyz789",
   "style_bottom": "abc123",
   "style_general": "abc123",
-  "swatch_image": "abc123",
+  "swatch_image": "xyz789",
   "thumbnail": ProductImage,
   "tier_price": 123.45,
   "tier_prices": [ProductTierPrices],
@@ -50610,14 +46771,12 @@ 
Example

   "updated_at": "abc123",
   "upsell_products": [ProductInterface],
   "url_key": "abc123",
-  "url_path": "xyz789",
+  "url_path": "abc123",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "abc123",
+  "url_suffix": "xyz789",
   "websites": [Website]
 }
 

-                    
-
back to top @@ -50669,9 +46828,7 @@
Fields
Example
- - - 
{
+                  
{
   "customizable_options": [CustomizableOptionInput],
   "data": CartItemInput,
   "downloadable_product_links": [
@@ -50679,8 +46836,6 @@ 
Example

   ]
 }
 

-                    
-
back to top @@ -50781,24 +46936,20 @@
Fields
Example
- - - 
{
-  "id": 123,
-  "is_shareable": false,
+                  
{
+  "id": 987,
+  "is_shareable": true,
   "link_type": "FILE",
   "number_of_downloads": 123,
-  "price": 123.45,
+  "price": 987.65,
   "sample_file": "abc123",
   "sample_type": "FILE",
-  "sample_url": "xyz789",
+  "sample_url": "abc123",
   "sort_order": 987,
   "title": "xyz789",
-  "uid": "4"
+  "uid": 4
 }
 

-                    
-
back to top @@ -50838,12 +46989,8 @@
Fields
Example
- - - 
{"link_id": 987}
+                  
{"link_id": 987}
 

-                    
-
back to top @@ -50913,19 +47060,15 @@
Fields
Example
- - - 
{
+                  
{
   "id": 123,
-  "sample_file": "xyz789",
+  "sample_file": "abc123",
   "sample_type": "FILE",
   "sample_url": "abc123",
   "sort_order": 987,
   "title": "abc123"
 }
 

-                    
-
back to top @@ -50989,19 +47132,15 @@
Fields
Example
- - - 
{
+                  
{
   "customizable_options": [SelectedCustomizableOption],
   "links": [DownloadableProductLinks],
   "product": ProductInterface,
   "quantity": 987.65,
   "samples": [DownloadableProductSamples],
-  "uid": 4
+  "uid": "4"
 }
 

-                    
-
back to top @@ -51075,12 +47214,10 @@
Fields
Example
- - - 
{
-  "added_at": "abc123",
+                  
{
+  "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "abc123",
+  "description": "xyz789",
   "id": 4,
   "links_v2": [DownloadableProductLinks],
   "product": ProductInterface,
@@ -51088,8 +47225,6 @@ 
Example

   "samples": [DownloadableProductSamples]
 }
 

-                    
-
back to top @@ -51135,15 +47270,11 @@
Fields
Example
- - - 
{
-  "duplicated_quote_uid": "4",
+                  
{
+  "duplicated_quote_uid": 4,
   "quote_uid": "4"
 }
 

-                    
-
back to top @@ -51182,12 +47313,8 @@
Fields
Example
- - - 
{"quote": NegotiableQuote}
+                  
{"quote": NegotiableQuote}
 

-                    
-
back to top @@ -51231,12 +47358,11 @@
Fields
Example
- - - 
{"content": ComplexTextValue, "uid": 4}
+                  
{
+  "content": ComplexTextValue,
+  "uid": "4"
+}
 

-                    
-
back to top @@ -51305,12 +47431,8 @@
Values
Example
- - - 
"CONTENT"
+                  
"CONTENT"
 

-                    
-
back to top @@ -51365,12 +47487,8 @@
Values
Example
- - - 
"SPECIFIED"
+                  
"SPECIFIED"
 

-                    
-
back to top @@ -51419,16 +47537,12 @@
Fields
Example
- - - 
{
+                  
{
   "items": [DynamicBlock],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 

-                    
-
back to top @@ -51480,16 +47594,12 @@
Fields
Example
- - - 
{
+                  
{
   "dynamic_block_uids": ["4"],
   "locations": ["CONTENT"],
   "type": "SPECIFIED"
 }
 

-                    
-
back to top @@ -51535,15 +47645,11 @@
Fields
Example
- - - 
{
+                  
{
   "attribute_code": "xyz789",
   "value": "abc123"
 }
 

-                    
-
back to top @@ -51589,12 +47695,8 @@
Fields
Example
- - - 
{"uid": 4, "value": "abc123"}
+                  
{"uid": 4, "value": "xyz789"}
 

-                    
-
back to top @@ -51661,19 +47763,15 @@
Fields
Example
- - - 
{
-  "canonical_url": "xyz789",
+                  
{
+  "canonical_url": "abc123",
   "entity_uid": 4,
-  "id": 123,
+  "id": 987,
   "redirectCode": 987,
-  "relative_url": "xyz789",
+  "relative_url": "abc123",
   "type": "CMS_PAGE"
 }
 

-                    
-
back to top @@ -51739,15 +47837,11 @@
Possible Types
Example
- - - 
{
+                  
{
   "code": "PRODUCT_NOT_FOUND",
-  "message": "abc123"
+  "message": "xyz789"
 }
 

-                    
-
back to top @@ -51809,12 +47903,8 @@
Possible Types
Example
- - - 
{"message": "abc123"}
+                  
{"message": "abc123"}
 

-                    
-
back to top @@ -51866,16 +47956,12 @@
Fields
Example
- - - 
{
+                  
{
   "country_code": "AF",
-  "postcode": "abc123",
+  "postcode": "xyz789",
   "region": CustomerAddressRegionInput
 }
 

-                    
-
back to top @@ -51923,16 +48009,12 @@
Fields
Example
- - - 
{
+                  
{
   "address": EstimateAddressInput,
-  "cart_id": "xyz789",
+  "cart_id": "abc123",
   "shipping_method": ShippingMethodInput
 }
 

-                    
-
back to top @@ -51971,12 +48053,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -52020,12 +48098,8 @@
Fields
Example
- - - 
{"currency_to": "abc123", "rate": 987.65}
+                  
{"currency_to": "xyz789", "rate": 123.45}
 

-                    
-
back to top @@ -52071,15 +48145,11 @@
Fields
Example
- - - 
{
-  "eq": "xyz789",
-  "in": ["abc123"]
+                  
{
+  "eq": "abc123",
+  "in": ["xyz789"]
 }
 

-                    
-
back to top @@ -52123,12 +48193,8 @@
Values
Example
- - - 
"FULL"
+                  
"FULL"
 

-                    
-
back to top @@ -52174,12 +48240,8 @@
Fields
Example
- - - 
{"match": "abc123", "match_type": "FULL"}
+                  
{"match": "abc123", "match_type": "FULL"}
 

-                    
-
back to top @@ -52225,15 +48287,11 @@
Fields
Example
- - - 
{
-  "from": "xyz789",
-  "to": "xyz789"
+                  
{
+  "from": "abc123",
+  "to": "abc123"
 }
 

-                    
-
back to top @@ -52285,16 +48343,12 @@
Fields
Example
- - - 
{
+                  
{
   "eq": "xyz789",
-  "in": ["abc123"],
+  "in": ["xyz789"],
   "match": "abc123"
 }
 

-                    
-
back to top @@ -52419,28 +48473,24 @@
Fields
Example
- - - 
{
-  "eq": "xyz789",
+                  
{
+  "eq": "abc123",
   "finset": ["abc123"],
   "from": "xyz789",
   "gt": "abc123",
   "gteq": "abc123",
-  "in": ["abc123"],
-  "like": "abc123",
-  "lt": "abc123",
+  "in": ["xyz789"],
+  "like": "xyz789",
+  "lt": "xyz789",
   "lteq": "xyz789",
-  "moreq": "xyz789",
+  "moreq": "abc123",
   "neq": "abc123",
-  "nin": ["xyz789"],
-  "notnull": "abc123",
+  "nin": ["abc123"],
+  "notnull": "xyz789",
   "null": "xyz789",
   "to": "abc123"
 }
 

-                    
-
back to top @@ -52484,15 +48534,11 @@
Fields
Example
- - - 
{
+                  
{
   "amount": Money,
   "label": "xyz789"
 }
 

-                    
-
back to top @@ -52556,12 +48602,8 @@
Values
Example
- - - 
"INCLUDE_FPT_WITHOUT_DETAILS"
+                  
"INCLUDE_FPT_WITHOUT_DETAILS"
 

-                    
-
back to top @@ -52582,12 +48624,8 @@
Description
Example
- - - 
987.65
+                  
123.45
 

-                    
-
back to top @@ -52627,12 +48665,8 @@
Fields
Example
- - - 
{"customer_email": "abc123"}
+                  
{"customer_email": "abc123"}
 

-                    
-
back to top @@ -52671,12 +48705,8 @@
Fields
Example
- - - 
{"customer_token": "xyz789"}
+                  
{"customer_token": "xyz789"}
 

-                    
-
back to top @@ -52716,12 +48746,8 @@
Fields
Example
- - - 
{"template_id": 4}
+                  
{"template_id": 4}
 

-                    
-
back to top @@ -52760,12 +48786,8 @@
Fields
Example
- - - 
{"negotiable_quote_uid": 4}
+                  
{"negotiable_quote_uid": 4}
 

-                    
-
back to top @@ -52804,12 +48826,8 @@
Fields
Example
- - - 
{"sdkParams": [PaymentSDKParamsItem]}
+                  
{"sdkParams": [PaymentSDKParamsItem]}
 

-                    
-
back to top @@ -52858,16 +48876,12 @@
Fields
Example
- - - 
{
+                  
{
   "balance": Money,
   "code": "xyz789",
-  "expiration_date": "xyz789"
+  "expiration_date": "abc123"
 }
 

-                    
-
back to top @@ -52907,12 +48921,8 @@
Fields
Example
- - - 
{"gift_card_code": "abc123"}
+                  
{"gift_card_code": "xyz789"}
 

-                    
-
back to top @@ -52977,19 +48987,15 @@
Fields
Example
- - - 
{
-  "attribute_id": 987,
-  "uid": 4,
-  "value": 987.65,
+                  
{
+  "attribute_id": 123,
+  "uid": "4",
+  "value": 123.45,
   "value_id": 987,
-  "website_id": 987,
-  "website_value": 987.65
+  "website_id": 123,
+  "website_value": 123.45
 }
 

-                    
-
back to top @@ -53140,9 +49146,7 @@
Fields
Example
- - - 
{
+                  
{
   "amount": Money,
   "available_gift_wrapping": [GiftWrapping],
   "customizable_options": [SelectedCustomizableOption],
@@ -53150,26 +49154,24 @@ 
Example

   "errors": [CartItemError],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": "xyz789",
+  "id": "abc123",
   "is_available": false,
   "max_qty": 987.65,
-  "message": "abc123",
-  "min_qty": 123.45,
-  "not_available_message": "abc123",
+  "message": "xyz789",
+  "min_qty": 987.65,
+  "not_available_message": "xyz789",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 987.65,
-  "recipient_email": "xyz789",
+  "quantity": 123.45,
+  "recipient_email": "abc123",
   "recipient_name": "xyz789",
-  "sender_email": "xyz789",
-  "sender_name": "abc123",
-  "uid": "4"
+  "sender_email": "abc123",
+  "sender_name": "xyz789",
+  "uid": 4
 }
 

-                    
-
back to top @@ -53239,21 +49241,17 @@
Fields
Example
- - - 
{
+                  
{
   "discounts": [Discount],
   "gift_card": GiftCardItem,
   "id": "4",
   "order_item": OrderItemInterface,
-  "product_name": "xyz789",
+  "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "xyz789",
+  "product_sku": "abc123",
   "quantity_refunded": 123.45
 }
 

-                    
-
back to top @@ -53323,21 +49321,17 @@
Fields
Example
- - - 
{
+                  
{
   "discounts": [Discount],
   "gift_card": GiftCardItem,
   "id": 4,
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_invoiced": 123.45
+  "product_sku": "xyz789",
+  "quantity_invoiced": 987.65
 }
 

-                    
-
back to top @@ -53396,18 +49390,14 @@
Fields
Example
- - - 
{
-  "message": "xyz789",
-  "recipient_email": "xyz789",
-  "recipient_name": "xyz789",
-  "sender_email": "abc123",
+                  
{
+  "message": "abc123",
+  "recipient_email": "abc123",
+  "recipient_name": "abc123",
+  "sender_email": "xyz789",
   "sender_name": "abc123"
 }
 

-                    
-
back to top @@ -53476,20 +49466,16 @@
Fields
Example
- - - 
{
+                  
{
   "amount": Money,
   "custom_giftcard_amount": Money,
   "message": "abc123",
   "recipient_email": "abc123",
   "recipient_name": "abc123",
   "sender_email": "abc123",
-  "sender_name": "abc123"
+  "sender_name": "xyz789"
 }
 

-                    
-
back to top @@ -53634,11 +49620,9 @@
Fields
Example
- - - 
{
+                  
{
   "discounts": [Discount],
-  "eligible_for_return": true,
+  "eligible_for_return": false,
   "entered_options": [OrderItemOption],
   "gift_card": GiftCardItem,
   "gift_message": GiftMessage,
@@ -53646,24 +49630,22 @@ 
Example

   "id": "4",
   "prices": OrderItemPrices,
   "product": ProductInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "abc123",
+  "product_sku": "xyz789",
   "product_type": "xyz789",
   "product_url_key": "xyz789",
   "quantity_canceled": 987.65,
   "quantity_invoiced": 987.65,
-  "quantity_ordered": 987.65,
+  "quantity_ordered": 123.45,
   "quantity_refunded": 987.65,
   "quantity_return_requested": 123.45,
   "quantity_returned": 123.45,
   "quantity_shipped": 123.45,
   "selected_options": [OrderItemOption],
-  "status": "xyz789"
+  "status": "abc123"
 }
 

-                    
-
back to top @@ -54262,84 +50244,82 @@
currentPage
Example
- - - 
{
+                  
{
   "activity": "abc123",
   "allow_message": true,
   "allow_open_amount": true,
-  "attribute_set_id": 987,
+  "attribute_set_id": 123,
   "canonical_url": "abc123",
   "categories": [CategoryInterface],
-  "category_gear": "xyz789",
-  "climate": "abc123",
+  "category_gear": "abc123",
+  "climate": "xyz789",
   "collar": "abc123",
-  "color": 987,
+  "color": 123,
   "country_of_manufacture": "xyz789",
   "created_at": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "eco_collection": 987,
+  "eco_collection": 123,
   "erin_recommends": 987,
   "features_bags": "abc123",
   "format": 123,
-  "gender": "xyz789",
+  "gender": "abc123",
   "gift_card_options": [CustomizableOptionInterface],
-  "gift_message_available": true,
-  "gift_wrapping_available": true,
+  "gift_message_available": false,
+  "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
   "giftcard_amounts": [GiftCardAmounts],
   "giftcard_type": "VIRTUAL",
-  "id": 987,
+  "id": 123,
   "image": ProductImage,
-  "is_redeemable": true,
-  "is_returnable": "xyz789",
+  "is_redeemable": false,
+  "is_returnable": "abc123",
   "lifetime": 987,
-  "manufacturer": 123,
-  "material": "abc123",
-  "max_sale_qty": 123.45,
+  "manufacturer": 987,
+  "material": "xyz789",
+  "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
   "message_max_length": 123,
   "meta_description": "xyz789",
-  "meta_keyword": "abc123",
+  "meta_keyword": "xyz789",
   "meta_title": "xyz789",
-  "min_sale_qty": 123.45,
-  "name": "abc123",
-  "new": 987,
+  "min_sale_qty": 987.65,
+  "name": "xyz789",
+  "new": 123,
   "new_from_date": "xyz789",
-  "new_to_date": "abc123",
+  "new_to_date": "xyz789",
   "only_x_left_in_stock": 123.45,
   "open_amount_max": 987.65,
-  "open_amount_min": 987.65,
+  "open_amount_min": 123.45,
   "options": [CustomizableOptionInterface],
-  "options_container": "xyz789",
+  "options_container": "abc123",
   "pattern": "xyz789",
   "performance_fabric": 987,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "purpose": 123,
-  "quantity": 123.45,
+  "purpose": 987,
+  "quantity": 987.65,
   "rating_summary": 123.45,
   "redirect_code": 123,
   "related_products": [ProductInterface],
-  "relative_url": "xyz789",
-  "review_count": 123,
+  "relative_url": "abc123",
+  "review_count": 987,
   "reviews": ProductReviews,
   "rules": [CatalogRule],
-  "sale": 987,
+  "sale": 123,
   "short_description": ComplexTextValue,
   "size": 123,
-  "sku": "abc123",
+  "sku": "xyz789",
   "sleeve": "xyz789",
   "small_image": ProductImage,
-  "special_from_date": "xyz789",
+  "special_from_date": "abc123",
   "special_price": 987.65,
   "special_to_date": "xyz789",
-  "staged": false,
+  "staged": true,
   "stock_status": "IN_STOCK",
   "strap_bags": "abc123",
   "style_bags": "xyz789",
@@ -54350,20 +50330,18 @@ 
Example

   "tier_price": 987.65,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
-  "type_id": "xyz789",
+  "type_id": "abc123",
   "uid": "4",
-  "updated_at": "xyz789",
+  "updated_at": "abc123",
   "upsell_products": [ProductInterface],
   "url_key": "abc123",
   "url_path": "xyz789",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "abc123",
+  "url_suffix": "xyz789",
   "websites": [Website],
-  "weight": 123.45
+  "weight": 987.65
 }
 

-                    
-
back to top @@ -54422,9 +50400,7 @@
Fields
Example
- - - 
{
+                  
{
   "customizable_options": [SelectedCustomizableOption],
   "gift_card_options": GiftCardOptions,
   "product": ProductInterface,
@@ -54432,8 +50408,6 @@ 
Example

   "uid": "4"
 }
 

-                    
-
back to top @@ -54498,20 +50472,16 @@
Fields
Example
- - - 
{
+                  
{
   "gift_card": GiftCardItem,
   "id": 4,
   "order_item": OrderItemInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "xyz789",
   "quantity_shipped": 987.65
 }
 

-                    
-
back to top @@ -54566,12 +50536,8 @@
Values
Example
- - - 
"VIRTUAL"
+                  
"VIRTUAL"
 

-                    
-
back to top @@ -54640,20 +50606,16 @@
Fields
Example
- - - 
{
-  "added_at": "xyz789",
+                  
{
+  "added_at": "abc123",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "abc123",
+  "description": "xyz789",
   "gift_card_options": GiftCardOptions,
   "id": "4",
   "product": ProductInterface,
   "quantity": 123.45
 }
 

-                    
-
back to top @@ -54702,16 +50664,12 @@
Fields
Example
- - - 
{
+                  
{
   "from": "xyz789",
   "message": "xyz789",
   "to": "xyz789"
 }
 

-                    
-
back to top @@ -54763,16 +50721,12 @@
Fields
Example
- - - 
{
+                  
{
   "from": "abc123",
-  "message": "abc123",
-  "to": "xyz789"
+  "message": "xyz789",
+  "to": "abc123"
 }
 

-                    
-
back to top @@ -54836,9 +50790,7 @@
Fields
Example
- - - 
{
+                  
{
   "gift_wrapping_for_items": Money,
   "gift_wrapping_for_items_incl_tax": Money,
   "gift_wrapping_for_order": Money,
@@ -54847,8 +50799,6 @@ 
Example

   "printed_card_incl_tax": Money
 }
 

-                    
-
back to top @@ -54942,25 +50892,21 @@
Fields
Example
- - - 
{
-  "created_at": "xyz789",
+                  
{
+  "created_at": "abc123",
   "dynamic_attributes": [GiftRegistryDynamicAttribute],
   "event_name": "abc123",
   "items": [GiftRegistryItemInterface],
   "message": "xyz789",
-  "owner_name": "abc123",
+  "owner_name": "xyz789",
   "privacy_settings": "PRIVATE",
   "registrants": [GiftRegistryRegistrant],
   "shipping_address": CustomerAddress,
   "status": "ACTIVE",
   "type": GiftRegistryType,
-  "uid": 4
+  "uid": "4"
 }
 

-                    
-
back to top @@ -55010,17 +50956,13 @@
Fields
Example
- - - 
{
+                  
{
   "code": "4",
   "group": "EVENT_INFORMATION",
   "label": "abc123",
   "value": "xyz789"
 }
 

-                    
-
back to top @@ -55096,12 +51038,8 @@
Values
Example
- - - 
"EVENT_INFORMATION"
+                  
"EVENT_INFORMATION"
 

-                    
-
back to top @@ -55147,12 +51085,8 @@
Fields
Example
- - - 
{"code": 4, "value": "abc123"}
+                  
{"code": 4, "value": "abc123"}
 

-                    
-
back to top @@ -55219,16 +51153,12 @@
Possible Types
Example
- - - 
{
-  "code": "4",
+                  
{
+  "code": 4,
   "label": "xyz789",
-  "value": "xyz789"
+  "value": "abc123"
 }
 

-                    
-
back to top @@ -55288,19 +51218,15 @@
Fields
Example
- - - 
{
-  "attribute_group": "abc123",
+                  
{
+  "attribute_group": "xyz789",
   "code": 4,
-  "input_type": "xyz789",
-  "is_required": true,
+  "input_type": "abc123",
+  "is_required": false,
   "label": "abc123",
   "sort_order": 987
 }
 

-                    
-
back to top @@ -55377,19 +51303,15 @@
Possible Types
Example
- - - 
{
+                  
{
   "attribute_group": "abc123",
-  "code": "4",
+  "code": 4,
   "input_type": "xyz789",
   "is_required": false,
   "label": "abc123",
   "sort_order": 987
 }
 

-                    
-
back to top @@ -55449,19 +51371,15 @@
Fields
Example
- - - 
{
+                  
{
   "created_at": "abc123",
-  "note": "abc123",
+  "note": "xyz789",
   "product": ProductInterface,
-  "quantity": 123.45,
+  "quantity": 987.65,
   "quantity_fulfilled": 987.65,
   "uid": "4"
 }
 

-                    
-
back to top @@ -55538,19 +51456,15 @@
Possible Types
Example
- - - 
{
+                  
{
   "created_at": "abc123",
   "note": "xyz789",
   "product": ProductInterface,
   "quantity": 123.45,
   "quantity_fulfilled": 123.45,
-  "uid": "4"
+  "uid": 4
 }
 

-                    
-
back to top @@ -55611,15 +51525,11 @@
Possible Types
Example
- - - 
{
-  "status": true,
+                  
{
+  "status": false,
   "user_errors": [GiftRegistryItemsUserError]
 }
 

-                    
-
back to top @@ -55678,18 +51588,14 @@
Fields
Example
- - - 
{
+                  
{
   "code": "OUT_OF_STOCK",
-  "gift_registry_item_uid": 4,
-  "gift_registry_uid": 4,
-  "message": "xyz789",
+  "gift_registry_item_uid": "4",
+  "gift_registry_uid": "4",
+  "message": "abc123",
   "product_uid": 4
 }
 

-                    
-
back to top @@ -55741,12 +51647,8 @@
Values
Example
- - - 
"OUT_OF_STOCK"
+                  
"OUT_OF_STOCK"
 

-                    
-
back to top @@ -55802,12 +51704,8 @@
Possible Types
Example
- - - 
{"gift_registry": GiftRegistry}
+                  
{"gift_registry": GiftRegistry}
 

-                    
-
back to top @@ -55855,12 +51753,8 @@
Values
Example
- - - 
"PRIVATE"
+                  
"PRIVATE"
 

-                    
-
back to top @@ -55919,20 +51813,16 @@
Fields
Example
- - - 
{
+                  
{
   "dynamic_attributes": [
     GiftRegistryRegistrantDynamicAttribute
   ],
   "email": "abc123",
   "firstname": "xyz789",
-  "lastname": "xyz789",
-  "uid": "4"
+  "lastname": "abc123",
+  "uid": 4
 }
 

-                    
-
back to top @@ -55977,16 +51867,12 @@
Fields
Example
- - - 
{
+                  
{
   "code": "4",
   "label": "abc123",
-  "value": "xyz789"
+  "value": "abc123"
 }
 

-                    
-
back to top @@ -56050,19 +51936,15 @@
Fields
Example
- - - 
{
-  "event_date": "abc123",
-  "event_title": "xyz789",
+                  
{
+  "event_date": "xyz789",
+  "event_title": "abc123",
   "gift_registry_uid": "4",
-  "location": "xyz789",
-  "name": "abc123",
-  "type": "abc123"
+  "location": "abc123",
+  "name": "xyz789",
+  "type": "xyz789"
 }
 

-                    
-
back to top @@ -56108,15 +51990,8 @@
Fields
Example
- - - 
{
-  "address_data": CustomerAddressInput,
-  "address_id": "4"
-}
+                  
{"address_data": CustomerAddressInput, "address_id": 4}
 

-                    
-
back to top @@ -56164,12 +52039,8 @@
Values
Example
- - - 
"ACTIVE"
+                  
"ACTIVE"
 

-                    
-
back to top @@ -56218,9 +52089,7 @@
Fields
Example
- - - 
{
+                  
{
   "dynamic_attributes_metadata": [
     GiftRegistryDynamicAttributeMetadataInterface
   ],
@@ -56228,8 +52097,6 @@ 
Example

   "uid": "4"
 }
 

-                    
-
back to top @@ -56289,18 +52156,14 @@
Fields
Example
- - - 
{
-  "design": "abc123",
-  "id": "4",
+                  
{
+  "design": "xyz789",
+  "id": 4,
   "image": GiftWrappingImage,
   "price": Money,
-  "uid": 4
+  "uid": "4"
 }
 

-                    
-
back to top @@ -56344,15 +52207,11 @@
Fields
Example
- - - 
{
-  "label": "abc123",
-  "url": "abc123"
+                  
{
+  "label": "xyz789",
+  "url": "xyz789"
 }
 

-                    
-
back to top @@ -56397,16 +52256,12 @@
Fields
Example
- - - 
{
-  "color": "abc123",
+                  
{
+  "color": "xyz789",
   "height": 123,
   "type": "xyz789"
 }
 

-                    
-
back to top @@ -56481,22 +52336,18 @@
Fields
Example
- - - 
{
+                  
{
   "button_styles": GooglePayButtonStyles,
-  "code": "xyz789",
-  "is_visible": false,
-  "payment_intent": "abc123",
-  "payment_source": "xyz789",
+  "code": "abc123",
+  "is_visible": true,
+  "payment_intent": "xyz789",
+  "payment_source": "abc123",
   "sdk_params": [SDKParams],
   "sort_order": "xyz789",
   "three_ds_mode": "OFF",
   "title": "xyz789"
 }
 

-                    
-
back to top @@ -56548,16 +52399,12 @@
Fields
Example
- - - 
{
+                  
{
   "payment_source": "xyz789",
-  "payments_order_id": "xyz789",
+  "payments_order_id": "abc123",
   "paypal_order_id": "abc123"
 }
 

-                    
-
back to top @@ -57106,61 +52953,59 @@
currentPage
Example
- - - 
{
+                  
{
   "activity": "xyz789",
-  "attribute_set_id": 123,
+  "attribute_set_id": 987,
   "canonical_url": "abc123",
   "categories": [CategoryInterface],
   "category_gear": "abc123",
   "climate": "abc123",
-  "collar": "xyz789",
-  "color": 123,
+  "collar": "abc123",
+  "color": 987,
   "country_of_manufacture": "xyz789",
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
   "eco_collection": 987,
-  "erin_recommends": 987,
+  "erin_recommends": 123,
   "features_bags": "xyz789",
-  "format": 123,
-  "gender": "abc123",
-  "gift_message_available": true,
+  "format": 987,
+  "gender": "xyz789",
+  "gift_message_available": false,
   "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
-  "id": 123,
+  "id": 987,
   "image": ProductImage,
   "is_returnable": "abc123",
   "items": [GroupedProductItem],
   "manufacturer": 987,
   "material": "xyz789",
-  "max_sale_qty": 987.65,
+  "max_sale_qty": 123.45,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
   "meta_description": "xyz789",
   "meta_keyword": "xyz789",
   "meta_title": "xyz789",
-  "min_sale_qty": 123.45,
+  "min_sale_qty": 987.65,
   "name": "xyz789",
   "new": 123,
-  "new_from_date": "abc123",
+  "new_from_date": "xyz789",
   "new_to_date": "abc123",
   "only_x_left_in_stock": 987.65,
   "options_container": "xyz789",
-  "pattern": "abc123",
+  "pattern": "xyz789",
   "performance_fabric": 987,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
   "purpose": 987,
-  "quantity": 123.45,
+  "quantity": 987.65,
   "rating_summary": 123.45,
   "redirect_code": 123,
   "related_products": [ProductInterface],
-  "relative_url": "abc123",
+  "relative_url": "xyz789",
   "review_count": 123,
   "reviews": ProductReviews,
   "rules": [CatalogRule],
@@ -57170,13 +53015,13 @@ 
Example

   "sku": "abc123",
   "sleeve": "abc123",
   "small_image": ProductImage,
-  "special_from_date": "abc123",
+  "special_from_date": "xyz789",
   "special_price": 987.65,
-  "special_to_date": "xyz789",
+  "special_to_date": "abc123",
   "staged": true,
   "stock_status": "IN_STOCK",
-  "strap_bags": "abc123",
-  "style_bags": "xyz789",
+  "strap_bags": "xyz789",
+  "style_bags": "abc123",
   "style_bottom": "xyz789",
   "style_general": "abc123",
   "swatch_image": "xyz789",
@@ -57185,19 +53030,17 @@ 
Example

   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
   "type_id": "xyz789",
-  "uid": 4,
+  "uid": "4",
   "updated_at": "abc123",
   "upsell_products": [ProductInterface],
   "url_key": "xyz789",
   "url_path": "abc123",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "xyz789",
+  "url_suffix": "abc123",
   "websites": [Website],
   "weight": 123.45
 }
 

-                    
-
back to top @@ -57246,16 +53089,12 @@
Fields
Example
- - - 
{
-  "position": 123,
+                  
{
+  "position": 987,
   "product": ProductInterface,
-  "qty": 123.45
+  "qty": 987.65
 }
 

-                    
-
back to top @@ -57319,19 +53158,15 @@
Fields
Example
- - - 
{
+                  
{
   "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "abc123",
-  "id": 4,
+  "description": "xyz789",
+  "id": "4",
   "product": ProductInterface,
   "quantity": 987.65
 }
 

-                    
-
back to top @@ -57377,15 +53212,11 @@
Fields
Example
- - - 
{
+                  
{
   "reason": "xyz789",
-  "token": "abc123"
+  "token": "xyz789"
 }
 

-                    
-
back to top @@ -57476,25 +53307,21 @@
Fields
Example
- - - 
{
+                  
{
   "cc_vault_code": "xyz789",
-  "code": "xyz789",
-  "is_vault_enabled": true,
-  "is_visible": false,
-  "payment_intent": "xyz789",
+  "code": "abc123",
+  "is_vault_enabled": false,
+  "is_visible": true,
+  "payment_intent": "abc123",
   "payment_source": "abc123",
   "requires_card_details": false,
   "sdk_params": [SDKParams],
-  "sort_order": "xyz789",
+  "sort_order": "abc123",
   "three_ds": false,
   "three_ds_mode": "OFF",
   "title": "abc123"
 }
 

-                    
-
back to top @@ -57582,22 +53409,18 @@
Fields
Example
- - - 
{
-  "cardBin": "xyz789",
+                  
{
+  "cardBin": "abc123",
   "cardExpiryMonth": "abc123",
   "cardExpiryYear": "abc123",
   "cardLast4": "abc123",
   "holderName": "abc123",
-  "is_active_payment_token_enabler": true,
-  "payment_source": "abc123",
-  "payments_order_id": "xyz789",
-  "paypal_order_id": "xyz789"
+  "is_active_payment_token_enabler": false,
+  "payment_source": "xyz789",
+  "payments_order_id": "abc123",
+  "paypal_order_id": "abc123"
 }
 

-                    
-
back to top @@ -57643,15 +53466,11 @@
Fields
Example
- - - 
{
-  "cancel_url": "abc123",
+                  
{
+  "cancel_url": "xyz789",
   "return_url": "xyz789"
 }
 

-                    
-
back to top @@ -57690,12 +53509,8 @@
Fields
Example
- - - 
{"secure_form_url": "abc123"}
+                  
{"secure_form_url": "xyz789"}
 

-                    
-
back to top @@ -57735,12 +53550,8 @@
Fields
Example
- - - 
{"cart_id": "xyz789"}
+                  
{"cart_id": "abc123"}
 

-                    
-
back to top @@ -57784,15 +53595,11 @@
Fields
Example
- - - 
{
+                  
{
   "name": "abc123",
-  "value": "abc123"
+  "value": "xyz789"
 }
 

-                    
-
back to top @@ -57813,12 +53620,8 @@
Description
Example
- - - 
"4"
+                  
"4"
 

-                    
-
back to top @@ -57858,15 +53661,11 @@
Fields
Example
- - - 
{
+                  
{
   "thumbnail": "abc123",
-  "value": "xyz789"
+  "value": "abc123"
 }
 

-                    
-
back to top @@ -57930,12 +53729,8 @@
Values
Example
- - - 
"NONE"
+                  
"NONE"
 

-                    
-
back to top @@ -57980,16 +53775,12 @@
Fields
Example
- - - 
{
+                  
{
   "code": "PRODUCT_NOT_FOUND",
-  "message": "xyz789",
+  "message": "abc123",
   "quantity": 987.65
 }
 

-                    
-
back to top @@ -58010,12 +53801,8 @@
Description
Example
- - - 
123
+                  
987
 

-                    
-
back to top @@ -58054,12 +53841,8 @@
Fields
Example
- - - 
{"message": "xyz789"}
+                  
{"message": "xyz789"}
 

-                    
-
back to top @@ -58118,18 +53901,14 @@
Fields
Example
- - - 
{
+                  
{
   "comments": [SalesCommentItem],
-  "id": "4",
+  "id": 4,
   "items": [InvoiceItemInterface],
   "number": "abc123",
   "total": InvoiceTotal
 }
 

-                    
-
back to top @@ -58194,20 +53973,16 @@
Fields
Example
- - - 
{
+                  
{
   "discounts": [Discount],
-  "id": 4,
+  "id": "4",
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
   "product_sku": "abc123",
-  "quantity_invoiced": 987.65
+  "quantity_invoiced": 123.45
 }
 

-                    
-
back to top @@ -58308,20 +54083,16 @@
Possible Types
Example
- - - 
{
+                  
{
   "discounts": [Discount],
-  "id": "4",
+  "id": 4,
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_invoiced": 123.45
+  "product_sku": "xyz789",
+  "quantity_invoiced": 987.65
 }
 

-                    
-
back to top @@ -58395,9 +54166,7 @@
Fields
Example
- - - 
{
+                  
{
   "base_grand_total": Money,
   "discounts": [Discount],
   "grand_total": Money,
@@ -58408,8 +54177,6 @@ 
Example

   "total_tax": Money
 }
 

-                    
-
back to top @@ -58448,12 +54215,8 @@
Fields
Example
- - - 
{"is_email_available": true}
+                  
{"is_email_available": true}
 

-                    
-
back to top @@ -58492,12 +54255,8 @@
Fields
Example
- - - 
{"is_email_available": false}
+                  
{"is_email_available": false}
 

-                    
-
back to top @@ -58536,12 +54295,8 @@
Fields
Example
- - - 
{"is_role_name_available": false}
+                  
{"is_role_name_available": true}
 

-                    
-
back to top @@ -58580,12 +54335,8 @@
Fields
Example
- - - 
{"is_email_available": false}
+                  
{"is_email_available": false}
 

-                    
-
back to top @@ -58624,12 +54375,8 @@
Fields
Example
- - - 
{"is_email_available": true}
+                  
{"is_email_available": true}
 

-                    
-
back to top @@ -58693,19 +54440,15 @@
Fields
Example
- - - 
{
+                  
{
   "created_at": "abc123",
-  "creator_id": 123,
-  "creator_type": 123,
+  "creator_id": 987,
+  "creator_type": 987,
   "negotiable_quote_item_uid": "4",
-  "note": "xyz789",
-  "note_uid": 4
+  "note": "abc123",
+  "note_uid": "4"
 }
 

-                    
-
back to top @@ -58760,17 +54503,13 @@
Fields
Example
- - - 
{
+                  
{
   "id": 4,
   "label": "xyz789",
-  "uid": "4",
+  "uid": 4,
   "values": [ItemSelectedBundleOptionValue]
 }
 

-                    
-
back to top @@ -58835,19 +54574,15 @@
Fields
Example
- - - 
{
+                  
{
   "id": "4",
   "price": Money,
-  "product_name": "xyz789",
-  "product_sku": "xyz789",
+  "product_name": "abc123",
+  "product_sku": "abc123",
   "quantity": 123.45,
-  "uid": 4
+  "uid": "4"
 }
 

-                    
-
back to top @@ -58891,15 +54626,11 @@
Fields
Example
- - - 
{
-  "name": "xyz789",
+                  
{
+  "name": "abc123",
   "value": "xyz789"
 }
 

-                    
-
back to top @@ -58957,17 +54688,13 @@
Fields
Example
- - - 
{
+                  
{
   "filter_items": [LayerFilterItemInterface],
   "filter_items_count": 123,
   "name": "abc123",
-  "request_var": "abc123"
+  "request_var": "xyz789"
 }
 

-                    
-
back to top @@ -59015,16 +54742,12 @@
Fields
Example
- - - 
{
+                  
{
   "items_count": 123,
-  "label": "xyz789",
-  "value_string": "abc123"
+  "label": "abc123",
+  "value_string": "xyz789"
 }
 

-                    
-
back to top @@ -59094,16 +54817,12 @@
Possible Types
Example
- - - 
{
+                  
{
   "items_count": 987,
-  "label": "xyz789",
-  "value_string": "abc123"
+  "label": "abc123",
+  "value_string": "xyz789"
 }
 

-                    
-
back to top @@ -59155,16 +54874,12 @@
Fields
Example
- - - 
{
-  "note": "abc123",
-  "quote_item_uid": "4",
-  "quote_uid": 4
+                  
{
+  "note": "xyz789",
+  "quote_item_uid": 4,
+  "quote_uid": "4"
 }
 

-                    
-
back to top @@ -59249,23 +54964,19 @@
Fields
Example
- - - 
{
+                  
{
   "content": ProductMediaGalleryEntriesContent,
   "disabled": false,
-  "file": "abc123",
-  "id": 123,
+  "file": "xyz789",
+  "id": 987,
   "label": "xyz789",
   "media_type": "abc123",
-  "position": 987,
-  "types": ["xyz789"],
+  "position": 123,
+  "types": ["abc123"],
   "uid": 4,
   "video_content": ProductMediaGalleryEntriesVideoContent
 }
 

-                    
-
back to top @@ -59341,17 +55052,13 @@
Possible Types
Example
- - - 
{
+                  
{
   "disabled": true,
-  "label": "xyz789",
+  "label": "abc123",
   "position": 123,
   "url": "abc123"
 }
 

-                    
-
back to top @@ -59386,12 +55093,8 @@
Fields
Example
- - - 
{"type": "abc123"}
+                  
{"type": "abc123"}
 

-                    
-
back to top @@ -59431,15 +55134,11 @@
Fields
Example
- - - 
{
+                  
{
   "layout": "abc123",
   "logo": MessageStyleLogo
 }
 

-                    
-
back to top @@ -59483,12 +55182,8 @@
Fields
Example
- - - 
{"currency": "AFN", "value": 123.45}
+                  
{"currency": "AFN", "value": 987.65}
 

-                    
-
back to top @@ -59537,16 +55232,12 @@
Fields
Example
- - - 
{
+                  
{
   "gift_registry": GiftRegistry,
-  "status": false,
+  "status": true,
   "user_errors": [GiftRegistryItemsUserError]
 }
 

-                    
-
back to top @@ -59586,12 +55277,8 @@
Fields
Example
- - - 
{"requisitionListItemUids": [4]}
+                  
{"requisitionListItemUids": ["4"]}
 

-                    
-
back to top @@ -59635,15 +55322,11 @@
Fields
Example
- - - 
{
+                  
{
   "destination_requisition_list": RequisitionList,
   "source_requisition_list": RequisitionList
 }
 

-                    
-
back to top @@ -59695,16 +55378,8 @@
Fields
Example
- - - 
{
-  "quote_item_uid": 4,
-  "quote_uid": 4,
-  "requisition_list_uid": "4"
-}
+                  
{"quote_item_uid": 4, "quote_uid": 4, "requisition_list_uid": 4}
 

-                    
-
back to top @@ -59743,12 +55418,8 @@
Fields
Example
- - - 
{"quote": NegotiableQuote}
+                  
{"quote": NegotiableQuote}
 

-                    
-
back to top @@ -59797,16 +55468,12 @@
Fields
Example
- - - 
{
+                  
{
   "destination_wishlist": Wishlist,
   "source_wishlist": Wishlist,
   "user_errors": [WishListUserInputError]
 }
 

-                    
-
back to top @@ -59925,30 +55592,26 @@
Fields
Example
- - - 
{
+                  
{
   "available_payment_methods": [AvailablePaymentMethod],
   "billing_address": NegotiableQuoteBillingAddress,
   "buyer": NegotiableQuoteUser,
   "comments": [NegotiableQuoteComment],
   "created_at": "xyz789",
-  "email": "abc123",
+  "email": "xyz789",
   "history": [NegotiableQuoteHistoryEntry],
-  "is_virtual": false,
+  "is_virtual": true,
   "items": [CartItemInterface],
-  "name": "abc123",
+  "name": "xyz789",
   "prices": CartPrices,
   "selected_payment_method": SelectedPaymentMethod,
   "shipping_addresses": [NegotiableQuoteShippingAddress],
   "status": "SUBMITTED",
   "total_quantity": 987.65,
-  "uid": 4,
-  "updated_at": "xyz789"
+  "uid": "4",
+  "updated_at": "abc123"
 }
 

-                    
-
back to top @@ -59992,15 +55655,11 @@
Fields
Example
- - - 
{
+                  
{
   "code": "xyz789",
-  "label": "abc123"
+  "label": "xyz789"
 }
 

-                    
-
back to top @@ -60100,24 +55759,20 @@
Fields
Example
- - - 
{
+                  
{
   "city": "abc123",
-  "company": "abc123",
-  "country_code": "xyz789",
+  "company": "xyz789",
+  "country_code": "abc123",
   "firstname": "abc123",
-  "lastname": "xyz789",
-  "postcode": "xyz789",
-  "region": "xyz789",
+  "lastname": "abc123",
+  "postcode": "abc123",
+  "region": "abc123",
   "region_id": 123,
-  "save_in_address_book": false,
-  "street": ["xyz789"],
-  "telephone": "abc123"
+  "save_in_address_book": true,
+  "street": ["abc123"],
+  "telephone": "xyz789"
 }
 

-                    
-
back to top @@ -60214,22 +55869,18 @@
Possible Types
Example
- - - 
{
-  "city": "xyz789",
-  "company": "abc123",
+                  
{
+  "city": "abc123",
+  "company": "xyz789",
   "country": NegotiableQuoteAddressCountry,
   "firstname": "xyz789",
-  "lastname": "xyz789",
+  "lastname": "abc123",
   "postcode": "xyz789",
   "region": NegotiableQuoteAddressRegion,
-  "street": ["abc123"],
-  "telephone": "abc123"
+  "street": ["xyz789"],
+  "telephone": "xyz789"
 }
 

-                    
-
back to top @@ -60278,16 +55929,12 @@
Fields
Example
- - - 
{
+                  
{
   "code": "abc123",
   "label": "abc123",
   "region_id": 123
 }
 

-                    
-
back to top @@ -60362,22 +56009,18 @@
Fields
Example
- - - 
{
-  "city": "xyz789",
-  "company": "abc123",
+                  
{
+  "city": "abc123",
+  "company": "xyz789",
   "country": NegotiableQuoteAddressCountry,
   "firstname": "xyz789",
-  "lastname": "abc123",
-  "postcode": "abc123",
+  "lastname": "xyz789",
+  "postcode": "xyz789",
   "region": NegotiableQuoteAddressRegion,
-  "street": ["abc123"],
-  "telephone": "abc123"
+  "street": ["xyz789"],
+  "telephone": "xyz789"
 }
 

-                    
-
back to top @@ -60435,17 +56078,13 @@
Fields
Example
- - - 
{
+                  
{
   "address": NegotiableQuoteAddressInput,
   "customer_address_uid": 4,
-  "same_as_shipping": false,
+  "same_as_shipping": true,
   "use_for_shipping": false
 }
 

-                    
-
back to top @@ -60504,18 +56143,14 @@
Fields
Example
- - - 
{
+                  
{
   "author": NegotiableQuoteUser,
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "creator_type": "BUYER",
-  "text": "xyz789",
+  "text": "abc123",
   "uid": 4
 }
 

-                    
-
back to top @@ -60559,12 +56194,8 @@
Values
Example
- - - 
"BUYER"
+                  
"BUYER"
 

-                    
-
back to top @@ -60604,12 +56235,8 @@
Fields
Example
- - - 
{"comment": "xyz789"}
+                  
{"comment": "xyz789"}
 

-                    
-
back to top @@ -60658,16 +56285,12 @@
Fields
Example
- - - 
{
+                  
{
   "new_value": "xyz789",
   "old_value": "xyz789",
   "title": "abc123"
 }
 

-                    
-
back to top @@ -60713,15 +56336,11 @@
Fields
Example
- - - 
{
+                  
{
   "ids": FilterEqualTypeInput,
   "name": FilterMatchTypeInput
 }
 

-                    
-
back to top @@ -60785,9 +56404,7 @@
Fields
Example
- - - 
{
+                  
{
   "comment_added": NegotiableQuoteHistoryCommentChange,
   "custom_changes": NegotiableQuoteCustomLogChange,
   "expiration": NegotiableQuoteHistoryExpirationChange,
@@ -60796,8 +56413,6 @@ 
Example

   "total": NegotiableQuoteHistoryTotalChange
 }
 

-                    
-
back to top @@ -60836,12 +56451,8 @@
Fields
Example
- - - 
{"comment": "xyz789"}
+                  
{"comment": "xyz789"}
 

-                    
-
back to top @@ -60900,9 +56511,7 @@
Fields
Example
- - - 
{
+                  
{
   "author": NegotiableQuoteUser,
   "change_type": "CREATED",
   "changes": NegotiableQuoteHistoryChanges,
@@ -60910,8 +56519,6 @@ 
Example

   "uid": "4"
 }
 

-                    
-
back to top @@ -60969,12 +56576,8 @@
Values
Example
- - - 
"CREATED"
+                  
"CREATED"
 

-                    
-
back to top @@ -61018,15 +56621,11 @@
Fields
Example
- - - 
{
-  "new_expiration": "xyz789",
+                  
{
+  "new_expiration": "abc123",
   "old_expiration": "xyz789"
 }
 

-                    
-
back to top @@ -61070,15 +56669,11 @@
Fields
Example
- - - 
{
+                  
{
   "products_removed_from_catalog": [4],
   "products_removed_from_quote": [ProductInterface]
 }
 

-                    
-
back to top @@ -61122,12 +56717,8 @@
Fields
Example
- - - 
{"new_status": "SUBMITTED", "old_status": "SUBMITTED"}
+                  
{"new_status": "SUBMITTED", "old_status": "SUBMITTED"}
 

-                    
-
back to top @@ -61166,12 +56757,8 @@
Fields
Example
- - - 
{"changes": [NegotiableQuoteHistoryStatusChange]}
+                  
{"changes": [NegotiableQuoteHistoryStatusChange]}
 

-                    
-
back to top @@ -61215,15 +56802,11 @@
Fields
Example
- - - 
{
+                  
{
   "new_price": Money,
   "old_price": Money
 }
 

-                    
-
back to top @@ -61262,12 +56845,8 @@
Fields
Example
- - - 
{"message": "abc123"}
+                  
{"message": "abc123"}
 

-                    
-
back to top @@ -61313,12 +56892,8 @@
Fields
Example
- - - 
{"quantity": 123.45, "quote_item_uid": 4}
+                  
{"quantity": 987.65, "quote_item_uid": 4}
 

-                    
-
back to top @@ -61364,15 +56939,11 @@
Fields
Example
- - - 
{
+                  
{
   "code": "xyz789",
   "purchase_order_number": "abc123"
 }
 

-                    
-
back to top @@ -61426,17 +56997,13 @@
Fields
Example
- - - 
{
+                  
{
   "document_identifier": "xyz789",
-  "document_name": "xyz789",
-  "link_id": "4",
-  "reference_document_url": "abc123"
+  "document_name": "abc123",
+  "link_id": 4,
+  "reference_document_url": "xyz789"
 }
 

-                    
-
back to top @@ -61521,24 +57088,20 @@
Fields
Example
- - - 
{
+                  
{
   "available_shipping_methods": [AvailableShippingMethod],
-  "city": "xyz789",
-  "company": "xyz789",
+  "city": "abc123",
+  "company": "abc123",
   "country": NegotiableQuoteAddressCountry,
   "firstname": "abc123",
   "lastname": "xyz789",
   "postcode": "xyz789",
   "region": NegotiableQuoteAddressRegion,
   "selected_shipping_method": SelectedShippingMethod,
-  "street": ["xyz789"],
+  "street": ["abc123"],
   "telephone": "xyz789"
 }
 

-                    
-
back to top @@ -61590,16 +57153,12 @@
Fields
Example
- - - 
{
+                  
{
   "address": NegotiableQuoteAddressInput,
   "customer_address_uid": 4,
   "customer_notes": "xyz789"
 }
 

-                    
-
back to top @@ -61645,12 +57204,8 @@
Fields
Example
- - - 
{"sort_direction": "ASC", "sort_field": "QUOTE_NAME"}
+                  
{"sort_direction": "ASC", "sort_field": "QUOTE_NAME"}
 

-                    
-
back to top @@ -61698,12 +57253,8 @@
Values
Example
- - - 
"QUOTE_NAME"
+                  
"QUOTE_NAME"
 

-                    
-
back to top @@ -61796,12 +57347,8 @@
Values
Example
- - - 
"SUBMITTED"
+                  
"SUBMITTED"
 

-                    
-
back to top @@ -61920,18 +57467,16 @@
Fields
Example
- - - 
{
+                  
{
   "buyer": NegotiableQuoteUser,
   "comments": [NegotiableQuoteComment],
   "expiration_date": "abc123",
   "history": [NegotiableQuoteHistoryEntry],
-  "is_min_max_qty_used": true,
-  "is_virtual": false,
+  "is_min_max_qty_used": false,
+  "is_virtual": true,
   "items": [CartItemInterface],
-  "max_order_commitment": 123,
-  "min_order_commitment": 987,
+  "max_order_commitment": 987,
+  "min_order_commitment": 123,
   "name": "xyz789",
   "notifications": [QuoteTemplateNotificationMessage],
   "prices": CartPrices,
@@ -61939,13 +57484,11 @@ 
Example

     NegotiableQuoteReferenceDocumentLink
   ],
   "shipping_addresses": [NegotiableQuoteShippingAddress],
-  "status": "abc123",
+  "status": "xyz789",
   "template_id": "4",
-  "total_quantity": 123.45
+  "total_quantity": 987.65
 }
 

-                    
-
back to top @@ -61991,15 +57534,11 @@
Fields
Example
- - - 
{
+                  
{
   "state": FilterEqualTypeInput,
   "status": FilterEqualTypeInput
 }
 

-                    
-
back to top @@ -62108,28 +57647,24 @@
Fields
Example
- - - 
{
+                  
{
   "activated_at": "abc123",
-  "company_name": "xyz789",
-  "expiration_date": "xyz789",
+  "company_name": "abc123",
+  "expiration_date": "abc123",
   "is_min_max_qty_used": true,
-  "last_shared_at": "abc123",
-  "max_order_commitment": 987,
+  "last_shared_at": "xyz789",
+  "max_order_commitment": 123,
   "min_negotiated_grand_total": 123.45,
-  "min_order_commitment": 987,
-  "name": "abc123",
+  "min_order_commitment": 123,
+  "name": "xyz789",
   "orders_placed": 987,
-  "sales_rep_name": "abc123",
+  "sales_rep_name": "xyz789",
   "state": "xyz789",
-  "status": "xyz789",
-  "submitted_by": "abc123",
-  "template_id": "4"
+  "status": "abc123",
+  "submitted_by": "xyz789",
+  "template_id": 4
 }
 

-                    
-
back to top @@ -62187,17 +57722,13 @@
Fields
Example
- - - 
{
+                  
{
   "item_id": "4",
-  "max_qty": 123.45,
+  "max_qty": 987.65,
   "min_qty": 987.65,
   "quantity": 987.65
 }
 

-                    
-
back to top @@ -62255,17 +57786,13 @@
Fields
Example
- - - 
{
+                  
{
   "document_identifier": "abc123",
-  "document_name": "xyz789",
-  "link_id": 4,
+  "document_name": "abc123",
+  "link_id": "4",
   "reference_document_url": "xyz789"
 }
 

-                    
-
back to top @@ -62317,16 +57844,12 @@
Fields
Example
- - - 
{
+                  
{
   "address": NegotiableQuoteAddressInput,
   "customer_address_uid": 4,
-  "customer_notes": "xyz789"
+  "customer_notes": "abc123"
 }
 

-                    
-
back to top @@ -62372,12 +57895,8 @@
Fields
Example
- - - 
{"sort_direction": "ASC", "sort_field": "TEMPLATE_ID"}
+                  
{"sort_direction": "ASC", "sort_field": "TEMPLATE_ID"}
 

-                    
-
back to top @@ -62419,12 +57938,8 @@
Values
Example
- - - 
"TEMPLATE_ID"
+                  
"TEMPLATE_ID"
 

-                    
-
back to top @@ -62478,17 +57993,13 @@
Fields
Example
- - - 
{
+                  
{
   "items": [NegotiableQuoteTemplateGridItem],
   "page_info": SearchResultPageInfo,
   "sort_fields": SortFields,
-  "total_count": 123
+  "total_count": 987
 }
 

-                    
-
back to top @@ -62540,12 +58051,8 @@
Possible Types
Example
- - - 
{"quote_uid": 4}
+                  
{"quote_uid": 4}
 

-                    
-
back to top @@ -62584,12 +58091,8 @@
Fields
Example
- - - 
{"quote_uid": "4"}
+                  
{"quote_uid": "4"}
 

-                    
-
back to top @@ -62633,15 +58136,11 @@
Fields
Example
- - - 
{
-  "firstname": "abc123",
+                  
{
+  "firstname": "xyz789",
   "lastname": "abc123"
 }
 

-                    
-
back to top @@ -62695,17 +58194,13 @@
Fields
Example
- - - 
{
+                  
{
   "items": [NegotiableQuote],
   "page_info": SearchResultPageInfo,
   "sort_fields": SortFields,
   "total_count": 123
 }
 

-                    
-
back to top @@ -62749,15 +58244,11 @@
Fields
Example
- - - 
{
-  "message": "xyz789",
+                  
{
+  "message": "abc123",
   "uid": "4"
 }
 

-                    
-
back to top @@ -62797,12 +58288,8 @@
Fields
Example
- - - 
{"template_id": "4"}
+                  
{"template_id": "4"}
 

-                    
-
back to top @@ -62848,15 +58335,11 @@
Fields
Example
- - - 
{
+                  
{
   "order_id": "abc123",
   "order_number": "xyz789"
 }
 

-                    
-
back to top @@ -62911,12 +58394,8 @@
Values
Example
- - - 
"REORDER"
+                  
"REORDER"
 

-                    
-
back to top @@ -63043,29 +58522,25 @@
attributeCodes
Example
- - - 
{
+                  
{
   "city": "xyz789",
   "company": "abc123",
   "country_code": "AF",
   "custom_attributesV2": [AttributeValueInterface],
   "fax": "xyz789",
-  "firstname": "xyz789",
+  "firstname": "abc123",
   "lastname": "abc123",
-  "middlename": "abc123",
+  "middlename": "xyz789",
   "postcode": "abc123",
   "prefix": "xyz789",
   "region": "abc123",
   "region_id": "4",
   "street": ["abc123"],
-  "suffix": "xyz789",
+  "suffix": "abc123",
   "telephone": "xyz789",
   "vat_id": "xyz789"
 }
 

-                    
-
back to top @@ -63120,18 +58595,14 @@
Fields
Example
- - - 
{
-  "firstname": "abc123",
+                  
{
+  "firstname": "xyz789",
   "lastname": "abc123",
-  "middlename": "abc123",
-  "prefix": "abc123",
-  "suffix": "abc123"
+  "middlename": "xyz789",
+  "prefix": "xyz789",
+  "suffix": "xyz789"
 }
 

-                    
-
back to top @@ -63183,16 +58654,12 @@
Fields
Example
- - - 
{
-  "email": "xyz789",
-  "lastname": "xyz789",
+                  
{
+  "email": "abc123",
+  "lastname": "abc123",
   "number": "abc123"
 }
 

-                    
-
back to top @@ -63332,9 +58799,7 @@
Fields
Example
- - - 
{
+                  
{
   "discounts": [Discount],
   "eligible_for_return": true,
   "entered_options": [OrderItemOption],
@@ -63345,22 +58810,20 @@ 
Example

   "product": ProductInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "abc123",
-  "product_type": "abc123",
+  "product_sku": "xyz789",
+  "product_type": "xyz789",
   "product_url_key": "abc123",
-  "quantity_canceled": 123.45,
-  "quantity_invoiced": 123.45,
-  "quantity_ordered": 987.65,
+  "quantity_canceled": 987.65,
+  "quantity_invoiced": 987.65,
+  "quantity_ordered": 123.45,
   "quantity_refunded": 123.45,
-  "quantity_return_requested": 123.45,
+  "quantity_return_requested": 987.65,
   "quantity_returned": 123.45,
   "quantity_shipped": 123.45,
   "selected_options": [OrderItemOption],
-  "status": "abc123"
+  "status": "xyz789"
 }
 

-                    
-
back to top @@ -63541,11 +59004,9 @@
Possible Types
Example
- - - 
{
+                  
{
   "discounts": [Discount],
-  "eligible_for_return": false,
+  "eligible_for_return": true,
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
@@ -63555,21 +59016,19 @@ 
Example

   "product_name": "abc123",
   "product_sale_price": Money,
   "product_sku": "abc123",
-  "product_type": "xyz789",
+  "product_type": "abc123",
   "product_url_key": "abc123",
   "quantity_canceled": 987.65,
   "quantity_invoiced": 987.65,
-  "quantity_ordered": 123.45,
+  "quantity_ordered": 987.65,
   "quantity_refunded": 987.65,
   "quantity_return_requested": 987.65,
   "quantity_returned": 987.65,
-  "quantity_shipped": 123.45,
+  "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
-  "status": "xyz789"
+  "status": "abc123"
 }
 

-                    
-
back to top @@ -63613,15 +59072,11 @@
Fields
Example
- - - 
{
-  "label": "xyz789",
+                  
{
+  "label": "abc123",
   "value": "xyz789"
 }
 

-                    
-
back to top @@ -63707,9 +59162,7 @@
Fields
Example
- - - 
{
+                  
{
   "discounts": [Discount],
   "fixed_product_taxes": [FixedProductTax],
   "original_price": Money,
@@ -63723,8 +59176,6 @@ 
Example

   "total_item_discount": Money
 }
 

-                    
-
back to top @@ -63773,16 +59224,12 @@
Fields
Example
- - - 
{
+                  
{
   "additional_data": [KeyValue],
-  "name": "abc123",
+  "name": "xyz789",
   "type": "xyz789"
 }
 

-                    
-
back to top @@ -63841,18 +59288,14 @@
Fields
Example
- - - 
{
+                  
{
   "comments": [SalesCommentItem],
-  "id": 4,
+  "id": "4",
   "items": [ShipmentItemInterface],
   "number": "abc123",
   "tracking": [ShipmentTracking]
 }
 

-                    
-
back to top @@ -63892,12 +59335,8 @@
Fields
Example
- - - 
{"token": "xyz789"}
+                  
{"token": "xyz789"}
 

-                    
-
back to top @@ -64003,9 +59442,7 @@
Fields
Example
- - - 
{
+                  
{
   "base_grand_total": Money,
   "discounts": [Discount],
   "gift_options": GiftOptionsPrices,
@@ -64022,8 +59459,6 @@ 
Example

   "total_tax": Money
 }
 

-                    
-
back to top @@ -64069,15 +59504,11 @@
Fields
Example
- - - 
{
+                  
{
   "payer_id": "abc123",
   "token": "abc123"
 }
 

-                    
-
back to top @@ -64129,16 +59560,12 @@
Fields
Example
- - - 
{
-  "cancel_url": "xyz789",
-  "error_url": "abc123",
-  "return_url": "xyz789"
+                  
{
+  "cancel_url": "abc123",
+  "error_url": "xyz789",
+  "return_url": "abc123"
 }
 

-                    
-
back to top @@ -64186,12 +59613,8 @@
Values
Example
- - - 
"TEST"
+                  
"TEST"
 

-                    
-
back to top @@ -64245,17 +59668,13 @@
Fields
Example
- - - 
{
+                  
{
   "mode": "TEST",
-  "paypal_url": "abc123",
+  "paypal_url": "xyz789",
   "secure_token": "xyz789",
-  "secure_token_id": "xyz789"
+  "secure_token_id": "abc123"
 }
 

-                    
-
back to top @@ -64295,12 +59714,8 @@
Fields
Example
- - - 
{"cart_id": "abc123"}
+                  
{"cart_id": "abc123"}
 

-                    
-
back to top @@ -64346,15 +59761,11 @@
Fields
Example
- - - 
{
+                  
{
   "cc_details": CreditCardDetailsInput,
-  "is_active_payment_token_enabler": false
+  "is_active_payment_token_enabler": true
 }
 

-                    
-
back to top @@ -64400,15 +59811,11 @@
Fields
Example
- - - 
{
-  "cart_id": "abc123",
-  "paypal_payload": "abc123"
+                  
{
+  "cart_id": "xyz789",
+  "paypal_payload": "xyz789"
 }
 

-                    
-
back to top @@ -64443,12 +59850,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -64494,15 +59897,11 @@
Fields
Example
- - - 
{
+                  
{
   "cart_id": "abc123",
   "urls": PayflowProUrlInput
 }
 

-                    
-
back to top @@ -64554,16 +59953,12 @@
Fields
Example
- - - 
{
+                  
{
   "cancel_url": "abc123",
   "error_url": "abc123",
-  "return_url": "xyz789"
+  "return_url": "abc123"
 }
 

-                    
-
back to top @@ -64659,19 +60054,15 @@
Possible Types
Example
- - - 
{
-  "code": "abc123",
-  "is_visible": true,
+                  
{
+  "code": "xyz789",
+  "is_visible": false,
   "payment_intent": "xyz789",
   "sdk_params": [SDKParams],
   "sort_order": "abc123",
   "title": "abc123"
 }
 

-                    
-
back to top @@ -64725,17 +60116,13 @@
Fields
Example
- - - 
{
+                  
{
   "apple_pay": ApplePayConfig,
   "google_pay": GooglePayConfig,
   "hosted_fields": HostedFieldsConfig,
   "smart_buttons": SmartButtonsConfig
 }
 

-                    
-
back to top @@ -64804,12 +60191,8 @@
Values
Example
- - - 
"PRODUCT_DETAIL"
+                  
"PRODUCT_DETAIL"
 

-                    
-
back to top @@ -64977,9 +60360,7 @@
Fields
Example
- - - 
{
+                  
{
   "braintree": BraintreeInput,
   "braintree_ach_direct_debit": BraintreeInput,
   "braintree_ach_direct_debit_vault": BraintreeVaultInput,
@@ -65000,11 +60381,9 @@ 
Example

   "payment_services_paypal_smart_buttons": SmartButtonMethodInput,
   "payment_services_paypal_vault": VaultMethodInput,
   "paypal_express": PaypalExpressInput,
-  "purchase_order_number": "abc123"
+  "purchase_order_number": "xyz789"
 }
 

-                    
-
back to top @@ -65058,17 +60437,13 @@
Fields
Example
- - - 
{
+                  
{
   "id": "xyz789",
   "mp_order_id": "abc123",
   "payment_source_details": PaymentSourceDetails,
   "status": "abc123"
 }
 

-                    
-
back to top @@ -65108,15 +60483,11 @@
Fields
Example
- - - 
{
-  "code": "xyz789",
+                  
{
+  "code": "abc123",
   "params": [SDKParams]
 }
 

-                    
-
back to top @@ -65151,12 +60522,8 @@
Fields
Example
- - - 
{"card": Card}
+                  
{"card": Card}
 

-                    
-
back to top @@ -65196,12 +60563,8 @@
Fields
Example
- - - 
{"card": CardPaymentSourceInput}
+                  
{"card": CardPaymentSourceInput}
 

-                    
-
back to top @@ -65240,12 +60603,8 @@
Fields
Example
- - - 
{"card": CardPaymentSourceOutput}
+                  
{"card": CardPaymentSourceOutput}
 

-                    
-
back to top @@ -65299,17 +60658,13 @@
Fields
Example
- - - 
{
+                  
{
   "details": "xyz789",
   "payment_method_code": "xyz789",
   "public_hash": "xyz789",
   "type": "card"
 }
 

-                    
-
back to top @@ -65355,12 +60710,8 @@
Values
Example
- - - 
"card"
+                  
"card"
 

-                    
-
back to top @@ -65406,15 +60757,11 @@
Fields
Example
- - - 
{
+                  
{
   "payer_id": "abc123",
   "token": "xyz789"
 }
 

-                    
-
back to top @@ -65478,18 +60825,14 @@
Fields
Example
- - - 
{
-  "cart_id": "abc123",
-  "code": "xyz789",
+                  
{
+  "cart_id": "xyz789",
+  "code": "abc123",
   "express_button": true,
   "urls": PaypalExpressUrlsInput,
   "use_paypal_credit": true
 }
 

-                    
-
back to top @@ -65533,15 +60876,11 @@
Fields
Example
- - - 
{
+                  
{
   "paypal_urls": PaypalExpressUrlList,
   "token": "xyz789"
 }
 

-                    
-
back to top @@ -65585,15 +60924,11 @@
Fields
Example
- - - 
{
-  "edit": "xyz789",
-  "start": "xyz789"
+                  
{
+  "edit": "abc123",
+  "start": "abc123"
 }
 

-                    
-
back to top @@ -65651,17 +60986,13 @@
Fields
Example
- - - 
{
-  "cancel_url": "abc123",
-  "pending_url": "xyz789",
+                  
{
+  "cancel_url": "xyz789",
+  "pending_url": "abc123",
   "return_url": "xyz789",
   "success_url": "abc123"
 }
 

-                    
-
back to top @@ -65737,12 +61068,8 @@
Possible Types
Example
- - - 
{"weight": 987.65}
+                  
{"weight": 987.65}
 

-                    
-
back to top @@ -65866,28 +61193,24 @@
Fields
Example
- - - 
{
-  "city": "abc123",
+                  
{
+  "city": "xyz789",
   "contact_name": "abc123",
-  "country_id": "abc123",
-  "description": "xyz789",
-  "email": "xyz789",
+  "country_id": "xyz789",
+  "description": "abc123",
+  "email": "abc123",
   "fax": "abc123",
   "latitude": 123.45,
   "longitude": 123.45,
   "name": "abc123",
   "phone": "xyz789",
-  "pickup_location_code": "xyz789",
+  "pickup_location_code": "abc123",
   "postcode": "abc123",
-  "region": "xyz789",
+  "region": "abc123",
   "region_id": 987,
-  "street": "abc123"
+  "street": "xyz789"
 }
 

-                    
-
back to top @@ -65969,9 +61292,7 @@
Fields
Example
- - - 
{
+                  
{
   "city": FilterTypeInput,
   "country_id": FilterTypeInput,
   "name": FilterTypeInput,
@@ -65982,8 +61303,6 @@ 
Example

   "street": FilterTypeInput
 }
 

-                    
-
back to top @@ -66113,9 +61432,7 @@
Fields
Example
- - - 
{
+                  
{
   "city": "ASC",
   "contact_name": "ASC",
   "country_id": "ASC",
@@ -66134,8 +61451,6 @@ 
Example

   "street": "ASC"
 }
 

-                    
-
back to top @@ -66184,16 +61499,12 @@
Fields
Example
- - - 
{
+                  
{
   "items": [PickupLocation],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 

-                    
-
back to top @@ -66233,12 +61544,8 @@
Fields
Example
- - - 
{"quote_uid": "4"}
+                  
{"quote_uid": "4"}
 

-                    
-
back to top @@ -66277,12 +61584,8 @@
Fields
Example
- - - 
{"order": Order}
+                  
{"order": Order}
 

-                    
-
back to top @@ -66326,15 +61629,11 @@
Fields
Example
- - - 
{
+                  
{
   "code": "CART_NOT_FOUND",
   "message": "xyz789"
 }
 

-                    
-
back to top @@ -66399,12 +61698,8 @@
Values
Example
- - - 
"CART_NOT_FOUND"
+                  
"CART_NOT_FOUND"
 

-                    
-
back to top @@ -66444,12 +61739,8 @@
Fields
Example
- - - 
{"purchase_order_uid": 4}
+                  
{"purchase_order_uid": "4"}
 

-                    
-
back to top @@ -66488,12 +61779,8 @@
Fields
Example
- - - 
{"order": CustomerOrder}
+                  
{"order": CustomerOrder}
 

-                    
-
back to top @@ -66533,12 +61820,8 @@
Fields
Example
- - - 
{"cart_id": "abc123"}
+                  
{"cart_id": "xyz789"}
 

-                    
-
back to top @@ -66588,16 +61871,12 @@
Fields
Example
- - - 
{
+                  
{
   "errors": [PlaceOrderError],
   "order": Order,
   "orderV2": CustomerOrder
 }
 

-                    
-
back to top @@ -66637,12 +61916,8 @@
Fields
Example
- - - 
{"cart_id": "abc123"}
+                  
{"cart_id": "xyz789"}
 

-                    
-
back to top @@ -66681,12 +61956,8 @@
Fields
Example
- - - 
{"purchase_order": PurchaseOrder}
+                  
{"purchase_order": PurchaseOrder}
 

-                    
-
back to top @@ -66732,15 +62003,11 @@
Fields
Example
- - - 
{
+                  
{
   "adjustments": [PriceAdjustment],
   "amount": Money
 }
 

-                    
-
back to top @@ -66791,16 +62058,12 @@
Fields
Example
- - - 
{
+                  
{
   "amount": Money,
   "code": "TAX",
   "description": "INCLUDED"
 }
 

-                    
-
back to top @@ -66858,12 +62121,8 @@
Values
Example
- - - 
"TAX"
+                  
"TAX"
 

-                    
-
back to top @@ -66911,12 +62170,8 @@
Values
Example
- - - 
"INCLUDED"
+                  
"INCLUDED"
 

-                    
-
back to top @@ -66965,16 +62220,12 @@
Fields
Example
- - - 
{
-  "discount_percentage": 123.45,
+                  
{
+  "discount_percentage": 987.65,
   "main_final_price": 987.65,
-  "main_price": 123.45
+  "main_price": 987.65
 }
 

-                    
-
back to top @@ -67018,15 +62269,11 @@
Fields
Example
- - - 
{
+                  
{
   "maximum_price": ProductPrice,
   "minimum_price": ProductPrice
 }
 

-                    
-
back to top @@ -67081,12 +62328,8 @@
Values
Example
- - - 
"FIXED"
+                  
"FIXED"
 

-                    
-
back to top @@ -67134,12 +62377,8 @@
Values
Example
- - - 
"PRICE_RANGE"
+                  
"PRICE_RANGE"
 

-                    
-
back to top @@ -67183,15 +62422,11 @@
Fields
Example
- - - 
{
+                  
{
   "code": "xyz789",
-  "value": "abc123"
+  "value": "xyz789"
 }
 

-                    
-
back to top @@ -67411,9 +62646,7 @@
Fields
Example
- - - 
{
+                  
{
   "activity": FilterEqualTypeInput,
   "category_gear": FilterEqualTypeInput,
   "category_id": FilterEqualTypeInput,
@@ -67447,8 +62680,6 @@ 
Example

   "url_key": FilterEqualTypeInput
 }
 

-                    
-
back to top @@ -67506,12 +62737,8 @@
Fields
Example
- - - 
{"name": "ASC", "position": "ASC", "price": "ASC", "relevance": "ASC"}
+                  
{"name": "ASC", "position": "ASC", "price": "ASC", "relevance": "ASC"}
 

-                    
-
back to top @@ -67555,15 +62782,11 @@
Fields
Example
- - - 
{
+                  
{
   "errors": [AttributeMetadataError],
   "items": [AttributeValueInterface]
 }
 

-                    
-
back to top @@ -67607,12 +62830,8 @@
Fields
Example
- - - 
{"amount_off": 987.65, "percent_off": 987.65}
+                  
{"amount_off": 123.45, "percent_off": 987.65}
 

-                    
-
back to top @@ -67881,9 +63100,7 @@
Fields
Example
- - - 
{
+                  
{
   "category_id": FilterTypeInput,
   "country_of_manufacture": FilterTypeInput,
   "created_at": FilterTypeInput,
@@ -67925,8 +63142,6 @@ 
Example

   "weight": FilterTypeInput
 }
 

-                    
-
back to top @@ -67980,17 +63195,13 @@
Fields
Example
- - - 
{
-  "disabled": true,
-  "label": "abc123",
-  "position": 123,
-  "url": "abc123"
+                  
{
+  "disabled": false,
+  "label": "xyz789",
+  "position": 987,
+  "url": "xyz789"
 }
 

-                    
-
back to top @@ -68032,12 +63243,8 @@
Values
Example
- - - 
"ITSELF"
+                  
"ITSELF"
 

-                    
-
back to top @@ -68077,12 +63284,8 @@
Fields
Example
- - - 
{"sku": "xyz789"}
+                  
{"sku": "xyz789"}
 

-                    
-
back to top @@ -68653,48 +63856,46 @@
Possible Types
Example
- - - 
{
+                  
{
   "activity": "xyz789",
   "attribute_set_id": 987,
-  "canonical_url": "xyz789",
+  "canonical_url": "abc123",
   "categories": [CategoryInterface],
-  "category_gear": "abc123",
+  "category_gear": "xyz789",
   "climate": "xyz789",
   "collar": "abc123",
   "color": 123,
   "country_of_manufacture": "xyz789",
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
   "eco_collection": 123,
   "erin_recommends": 123,
   "features_bags": "abc123",
-  "format": 987,
-  "gender": "abc123",
-  "gift_message_available": true,
-  "gift_wrapping_available": false,
+  "format": 123,
+  "gender": "xyz789",
+  "gift_message_available": false,
+  "gift_wrapping_available": true,
   "gift_wrapping_price": Money,
   "id": 987,
   "image": ProductImage,
   "is_returnable": "abc123",
   "manufacturer": 987,
-  "material": "xyz789",
+  "material": "abc123",
   "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
-  "meta_description": "abc123",
+  "meta_description": "xyz789",
   "meta_keyword": "xyz789",
   "meta_title": "abc123",
-  "min_sale_qty": 987.65,
+  "min_sale_qty": 123.45,
   "name": "abc123",
-  "new": 123,
+  "new": 987,
   "new_from_date": "abc123",
   "new_to_date": "xyz789",
-  "only_x_left_in_stock": 123.45,
-  "options_container": "xyz789",
+  "only_x_left_in_stock": 987.65,
+  "options_container": "abc123",
   "pattern": "xyz789",
   "performance_fabric": 987,
   "price": ProductPrices,
@@ -68702,44 +63903,42 @@ 
Example

   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
   "purpose": 123,
-  "quantity": 123.45,
+  "quantity": 987.65,
   "rating_summary": 987.65,
   "related_products": [ProductInterface],
-  "review_count": 123,
+  "review_count": 987,
   "reviews": ProductReviews,
   "rules": [CatalogRule],
-  "sale": 123,
+  "sale": 987,
   "short_description": ComplexTextValue,
-  "size": 987,
+  "size": 123,
   "sku": "xyz789",
-  "sleeve": "abc123",
+  "sleeve": "xyz789",
   "small_image": ProductImage,
-  "special_from_date": "xyz789",
+  "special_from_date": "abc123",
   "special_price": 987.65,
-  "special_to_date": "xyz789",
+  "special_to_date": "abc123",
   "staged": false,
   "stock_status": "IN_STOCK",
   "strap_bags": "xyz789",
-  "style_bags": "xyz789",
+  "style_bags": "abc123",
   "style_bottom": "xyz789",
-  "style_general": "xyz789",
+  "style_general": "abc123",
   "swatch_image": "abc123",
   "thumbnail": ProductImage,
   "tier_price": 987.65,
   "tier_prices": [ProductTierPrices],
   "type_id": "abc123",
-  "uid": 4,
-  "updated_at": "xyz789",
+  "uid": "4",
+  "updated_at": "abc123",
   "upsell_products": [ProductInterface],
-  "url_key": "xyz789",
+  "url_key": "abc123",
   "url_path": "xyz789",
   "url_rewrites": [UrlRewrite],
-  "url_suffix": "xyz789",
+  "url_suffix": "abc123",
   "websites": [Website]
 }
 

-                    
-
back to top @@ -68798,18 +63997,14 @@
Fields
Example
- - - 
{
-  "link_type": "xyz789",
+                  
{
+  "link_type": "abc123",
   "linked_product_sku": "xyz789",
   "linked_product_type": "xyz789",
   "position": 987,
-  "sku": "abc123"
+  "sku": "xyz789"
 }
 

-                    
-
back to top @@ -68885,18 +64080,14 @@
Possible Types
Example
- - - 
{
-  "link_type": "xyz789",
-  "linked_product_sku": "abc123",
-  "linked_product_type": "xyz789",
+                  
{
+  "link_type": "abc123",
+  "linked_product_sku": "xyz789",
+  "linked_product_type": "abc123",
   "position": 987,
-  "sku": "abc123"
+  "sku": "xyz789"
 }
 

-                    
-
back to top @@ -68945,16 +64136,12 @@
Fields
Example
- - - 
{
+                  
{
   "base64_encoded_data": "abc123",
-  "name": "xyz789",
-  "type": "xyz789"
+  "name": "abc123",
+  "type": "abc123"
 }
 

-                    
-
back to top @@ -69018,19 +64205,15 @@
Fields
Example
- - - 
{
-  "media_type": "xyz789",
-  "video_description": "xyz789",
-  "video_metadata": "xyz789",
+                  
{
+  "media_type": "abc123",
+  "video_description": "abc123",
+  "video_metadata": "abc123",
   "video_provider": "abc123",
-  "video_title": "abc123",
+  "video_title": "xyz789",
   "video_url": "xyz789"
 }
 

-                    
-
back to top @@ -69084,17 +64267,13 @@
Fields
Example
- - - 
{
+                  
{
   "discount": ProductDiscount,
   "final_price": Money,
   "fixed_product_taxes": [FixedProductTax],
   "regular_price": Money
 }
 

-                    
-
back to top @@ -69146,16 +64325,12 @@
Fields
Example
- - - 
{
+                  
{
   "maximalPrice": Price,
   "minimalPrice": Price,
   "regularPrice": Price
 }
 

-                    
-
back to top @@ -69224,20 +64399,16 @@
Fields
Example
- - - 
{
-  "average_rating": 123.45,
-  "created_at": "abc123",
-  "nickname": "xyz789",
+                  
{
+  "average_rating": 987.65,
+  "created_at": "xyz789",
+  "nickname": "abc123",
   "product": ProductInterface,
   "ratings_breakdown": [ProductReviewRating],
-  "summary": "xyz789",
-  "text": "xyz789"
+  "summary": "abc123",
+  "text": "abc123"
 }
 

-                    
-
back to top @@ -69281,15 +64452,11 @@
Fields
Example
- - - 
{
+                  
{
   "name": "xyz789",
-  "value": "abc123"
+  "value": "xyz789"
 }
 

-                    
-
back to top @@ -69335,15 +64502,11 @@
Fields
Example
- - - 
{
-  "id": "xyz789",
-  "value_id": "xyz789"
+                  
{
+  "id": "abc123",
+  "value_id": "abc123"
 }
 

-                    
-
back to top @@ -69392,16 +64555,12 @@
Fields
Example
- - - 
{
-  "id": "abc123",
+                  
{
+  "id": "xyz789",
   "name": "xyz789",
   "values": [ProductReviewRatingValueMetadata]
 }
 

-                    
-
back to top @@ -69445,15 +64604,11 @@
Fields
Example
- - - 
{
+                  
{
   "value": "abc123",
   "value_id": "xyz789"
 }
 

-                    
-
back to top @@ -69492,12 +64647,8 @@
Fields
Example
- - - 
{"items": [ProductReviewRatingMetadata]}
+                  
{"items": [ProductReviewRatingMetadata]}
 

-                    
-
back to top @@ -69541,15 +64692,11 @@
Fields
Example
- - - 
{
+                  
{
   "items": [ProductReview],
   "page_info": SearchResultPageInfo
 }
 

-                    
-
back to top @@ -69597,12 +64744,8 @@
Values
Example
- - - 
"IN_STOCK"
+                  
"IN_STOCK"
 

-                    
-
back to top @@ -69666,18 +64809,14 @@
Fields
Example
- - - 
{
-  "customer_group_id": "xyz789",
-  "percentage_value": 123.45,
+                  
{
+  "customer_group_id": "abc123",
+  "percentage_value": 987.65,
   "qty": 123.45,
-  "value": 987.65,
-  "website_id": 987.65
+  "value": 123.45,
+  "website_id": 123.45
 }
 

-                    
-
back to top @@ -69736,18 +64875,14 @@
Fields
Example
- - - 
{
-  "disabled": true,
+                  
{
+  "disabled": false,
   "label": "xyz789",
-  "position": 987,
-  "url": "xyz789",
+  "position": 123,
+  "url": "abc123",
   "video_content": ProductMediaGalleryEntriesVideoContent
 }
 

-                    
-
back to top @@ -69830,9 +64965,7 @@
filter<
Example
- - - 
{
+                  
{
   "aggregations": [Aggregation],
   "filters": [LayerFilter],
   "items": [ProductInterface],
@@ -69842,8 +64975,6 @@ 
Example

   "total_count": 123
 }
 

-                    
-
back to top @@ -69937,9 +65068,7 @@
Fields
Example
- - - 
{
+                  
{
   "approval_flow": [PurchaseOrderRuleApprovalFlow],
   "available_actions": ["REJECT"],
   "comments": [PurchaseOrderComment],
@@ -69954,8 +65083,6 @@ 
Example

   "updated_at": "abc123"
 }
 

-                    
-
back to top @@ -70020,12 +65147,8 @@
Values
Example
- - - 
"REJECT"
+                  
"REJECT"
 

-                    
-
back to top @@ -70069,12 +65192,8 @@
Fields
Example
- - - 
{"message": "abc123", "type": "NOT_FOUND"}
+                  
{"message": "abc123", "type": "NOT_FOUND"}
 

-                    
-
back to top @@ -70133,18 +65252,14 @@
Fields
Example
- - - 
{
+                  
{
   "message": "abc123",
   "name": "abc123",
   "role": "abc123",
   "status": "PENDING",
-  "updated_at": "abc123"
+  "updated_at": "xyz789"
 }
 

-                    
-
back to top @@ -70195,12 +65310,8 @@
Values
Example
- - - 
"PENDING"
+                  
"PENDING"
 

-                    
-
back to top @@ -70284,23 +65395,19 @@
Fields
Example
- - - 
{
+                  
{
   "applies_to_roles": [CompanyRole],
   "approver_roles": [CompanyRole],
   "condition": PurchaseOrderApprovalRuleConditionInterface,
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "created_by": "abc123",
   "description": "xyz789",
   "name": "abc123",
   "status": "ENABLED",
-  "uid": "4",
+  "uid": 4,
   "updated_at": "xyz789"
 }
 

-                    
-
back to top @@ -70349,16 +65456,12 @@
Fields
Example
- - - 
{
+                  
{
   "amount": Money,
   "attribute": "GRAND_TOTAL",
   "operator": "MORE_THAN"
 }
 

-                    
-
back to top @@ -70424,12 +65527,8 @@
Possible Types
Example
- - - 
{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"}
+                  
{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"}
 

-                    
-
back to top @@ -70487,12 +65586,8 @@
Values
Example
- - - 
"MORE_THAN"
+                  
"MORE_THAN"
 

-                    
-
back to top @@ -70541,12 +65636,8 @@
Fields
Example
- - - 
{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987}
+                  
{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123}
 

-                    
-
back to top @@ -70616,19 +65707,15 @@
Fields
Example
- - - 
{
-  "applies_to": [4],
-  "approvers": [4],
+                  
{
+  "applies_to": ["4"],
+  "approvers": ["4"],
   "condition": CreatePurchaseOrderApprovalRuleConditionInput,
   "description": "xyz789",
   "name": "abc123",
   "status": "ENABLED"
 }
 

-                    
-
back to top @@ -70677,16 +65764,12 @@
Fields
Example
- - - 
{
+                  
{
   "available_applies_to": [CompanyRole],
   "available_condition_currencies": [AvailableCurrency],
   "available_requires_approval_from": [CompanyRole]
 }
 

-                    
-
back to top @@ -70730,12 +65813,8 @@
Values
Example
- - - 
"ENABLED"
+                  
"ENABLED"
 

-                    
-
back to top @@ -70786,12 +65865,8 @@
Values
Example
- - - 
"GRAND_TOTAL"
+                  
"GRAND_TOTAL"
 

-                    
-
back to top @@ -70840,16 +65915,12 @@
Fields
Example
- - - 
{
+                  
{
   "items": [PurchaseOrderApprovalRule],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 

-                    
-
back to top @@ -70903,17 +65974,13 @@
Fields
Example
- - - 
{
+                  
{
   "author": Customer,
   "created_at": "xyz789",
   "text": "xyz789",
   "uid": 4
 }
 

-                    
-
back to top @@ -70978,12 +66045,8 @@
Values
Example
- - - 
"NOT_FOUND"
+                  
"NOT_FOUND"
 

-                    
-
back to top @@ -71037,17 +66100,13 @@
Fields
Example
- - - 
{
-  "activity": "abc123",
-  "created_at": "abc123",
+                  
{
+  "activity": "xyz789",
+  "created_at": "xyz789",
   "message": "abc123",
-  "uid": "4"
+  "uid": 4
 }
 

-                    
-
back to top @@ -71091,15 +66150,11 @@
Fields
Example
- - - 
{
+                  
{
   "events": [PurchaseOrderApprovalFlowEvent],
   "rule_name": "abc123"
 }
 

-                    
-
back to top @@ -71192,12 +66247,8 @@
Values
Example
- - - 
"PENDING"
+                  
"PENDING"
 

-                    
-
back to top @@ -71246,16 +66297,12 @@
Fields
Example
- - - 
{
+                  
{
   "items": [PurchaseOrder],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
 

-                    
-
back to top @@ -71295,12 +66342,8 @@
Fields
Example
- - - 
{"purchase_order_uids": ["4"]}
+                  
{"purchase_order_uids": [4]}
 

-                    
-
back to top @@ -71344,15 +66387,11 @@
Fields
Example
- - - 
{
+                  
{
   "errors": [PurchaseOrderActionError],
   "purchase_orders": [PurchaseOrder]
 }
 

-                    
-
back to top @@ -71410,17 +66449,13 @@
Fields
Example
- - - 
{
-  "company_purchase_orders": true,
+                  
{
+  "company_purchase_orders": false,
   "created_date": FilterRangeTypeInput,
   "require_my_approval": false,
   "status": "PENDING"
 }
 

-                    
-
back to top @@ -71466,12 +66501,8 @@
Fields
Example
- - - 
{"field": "ITEM_ID", "order": "ASC"}
+                  
{"field": "ITEM_ID", "order": "ASC"}
 

-                    
-
back to top @@ -71523,16 +66554,12 @@
Fields
Example
- - - 
{
-  "item_id": "4",
+                  
{
+  "item_id": 4,
   "note": "abc123",
-  "templateId": 4
+  "templateId": "4"
 }
 

-                    
-
back to top @@ -71576,15 +66603,11 @@
Fields
Example
- - - 
{
-  "message": "xyz789",
+                  
{
+  "message": "abc123",
   "type": "xyz789"
 }
 

-                    
-
back to top @@ -71624,15 +66647,11 @@
Fields
Example
- - - 
{
+                  
{
   "configurations": ReCaptchaConfiguration,
-  "is_enabled": false
+  "is_enabled": true
 }
 

-                    
-
back to top @@ -71707,21 +66726,17 @@
Fields
Example
- - - 
{
+                  
{
   "badge_position": "xyz789",
-  "language_code": "abc123",
-  "minimum_score": 987.65,
+  "language_code": "xyz789",
+  "minimum_score": 123.45,
   "re_captcha_type": "INVISIBLE",
-  "technical_failure_message": "xyz789",
+  "technical_failure_message": "abc123",
   "theme": "abc123",
   "validation_failure_message": "abc123",
   "website_key": "abc123"
 }
 

-                    
-
back to top @@ -71795,21 +66810,17 @@
Fields
Example
- - - 
{
-  "badge_position": "abc123",
-  "failure_message": "abc123",
+                  
{
+  "badge_position": "xyz789",
+  "failure_message": "xyz789",
   "forms": ["PLACE_ORDER"],
-  "is_enabled": false,
+  "is_enabled": true,
   "language_code": "abc123",
-  "minimum_score": 123.45,
-  "theme": "xyz789",
+  "minimum_score": 987.65,
+  "theme": "abc123",
   "website_key": "abc123"
 }
 

-                    
-
back to top @@ -71916,12 +66927,8 @@
Values
Example
- - - 
"PLACE_ORDER"
+                  
"PLACE_ORDER"
 

-                    
-
back to top @@ -71972,12 +66979,8 @@
Values
Example
- - - 
"INVISIBLE"
+                  
"INVISIBLE"
 

-                    
-
back to top @@ -72022,16 +67025,12 @@
Fields
Example
- - - 
{
+                  
{
   "code": "abc123",
   "id": 987,
-  "name": "abc123"
+  "name": "xyz789"
 }
 

-                    
-
back to top @@ -72071,12 +67070,8 @@
Fields
Example
- - - 
{"cart_id": "xyz789"}
+                  
{"cart_id": "abc123"}
 

-                    
-
back to top @@ -72115,12 +67110,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -72166,15 +67157,11 @@
Fields
Example
- - - 
{
-  "cart_id": "abc123",
+                  
{
+  "cart_id": "xyz789",
   "coupon_codes": ["abc123"]
 }
 

-                    
-
back to top @@ -72220,15 +67207,11 @@
Fields
Example
- - - 
{
-  "cart_id": "abc123",
+                  
{
+  "cart_id": "xyz789",
   "gift_card_code": "xyz789"
 }
 

-                    
-
back to top @@ -72267,12 +67250,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -72311,12 +67290,8 @@
Fields
Example
- - - 
{"gift_registry": GiftRegistry}
+                  
{"gift_registry": GiftRegistry}
 

-                    
-
back to top @@ -72355,12 +67330,8 @@
Fields
Example
- - - 
{"success": true}
+                  
{"success": false}
 

-                    
-
back to top @@ -72399,12 +67370,8 @@
Fields
Example
- - - 
{"gift_registry": GiftRegistry}
+                  
{"gift_registry": GiftRegistry}
 

-                    
-
back to top @@ -72456,16 +67423,12 @@
Fields
Example
- - - 
{
-  "cart_id": "abc123",
-  "cart_item_id": 123,
-  "cart_item_uid": "4"
+                  
{
+  "cart_id": "xyz789",
+  "cart_item_id": 987,
+  "cart_item_uid": 4
 }
 

-                    
-
back to top @@ -72504,12 +67467,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -72555,12 +67514,11 @@
Fields
Example
- - - 
{"quote_item_uids": ["4"], "quote_uid": 4}
+                  
{
+  "quote_item_uids": ["4"],
+  "quote_uid": "4"
+}
 

-                    
-
back to top @@ -72599,12 +67557,8 @@
Fields
Example
- - - 
{"quote": NegotiableQuote}
+                  
{"quote": NegotiableQuote}
 

-                    
-
back to top @@ -72650,12 +67604,11 @@
Fields
Example
- - - 
{"item_uids": ["4"], "template_id": 4}
+                  
{
+  "item_uids": ["4"],
+  "template_id": "4"
+}
 

-                    
-
back to top @@ -72701,12 +67654,11 @@
Fields
Example
- - - 
{"products": [4], "uid": "4"}
+                  
{
+  "products": ["4"],
+  "uid": "4"
+}
 

-                    
-
back to top @@ -72750,15 +67702,11 @@
Fields
Example
- - - 
{
+                  
{
   "user_errors": [WishListUserInputError],
   "wishlist": Wishlist
 }
 

-                    
-
back to top @@ -72798,12 +67746,8 @@
Fields
Example
- - - 
{"return_shipping_tracking_uid": 4}
+                  
{"return_shipping_tracking_uid": 4}
 

-                    
-
back to top @@ -72842,12 +67786,8 @@
Fields
Example
- - - 
{"return": Return}
+                  
{"return": Return}
 

-                    
-
back to top @@ -72886,12 +67826,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -72931,12 +67867,8 @@
Fields
Example
- - - 
{"cart_id": "xyz789"}
+                  
{"cart_id": "xyz789"}
 

-                    
-
back to top @@ -72975,12 +67907,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -73032,16 +67960,12 @@
Fields
Example
- - - 
{
-  "quote_comment": "xyz789",
-  "quote_name": "xyz789",
-  "quote_uid": 4
+                  
{
+  "quote_comment": "abc123",
+  "quote_name": "abc123",
+  "quote_uid": "4"
 }
 

-                    
-
back to top @@ -73080,12 +68004,8 @@
Fields
Example
- - - 
{"quote": NegotiableQuote}
+                  
{"quote": NegotiableQuote}
 

-                    
-
back to top @@ -73129,15 +68049,11 @@
Fields
Example
- - - 
{
+                  
{
   "cart": Cart,
   "userInputErrors": [CheckoutUserInputError]
 }
 

-                    
-
back to top @@ -73195,17 +68111,13 @@
Fields
Example
- - - 
{
+                  
{
   "comment_text": "abc123",
   "contact_email": "abc123",
   "items": [RequestReturnItemInput],
-  "token": "abc123"
+  "token": "xyz789"
 }
 

-                    
-
back to top @@ -73263,17 +68175,13 @@
Fields
Example
- - - 
{
-  "cart_id": 4,
+                  
{
+  "cart_id": "4",
   "comment": NegotiableQuoteCommentInput,
-  "is_draft": true,
-  "quote_name": "xyz789"
+  "is_draft": false,
+  "quote_name": "abc123"
 }
 

-                    
-
back to top @@ -73312,12 +68220,8 @@
Fields
Example
- - - 
{"quote": NegotiableQuote}
+                  
{"quote": NegotiableQuote}
 

-                    
-
back to top @@ -73357,12 +68261,8 @@
Fields
Example
- - - 
{"cart_id": "4"}
+                  
{"cart_id": 4}
 

-                    
-
back to top @@ -73420,17 +68320,13 @@
Fields
Example
- - - 
{
-  "comment_text": "xyz789",
+                  
{
+  "comment_text": "abc123",
   "contact_email": "abc123",
   "items": [RequestReturnItemInput],
   "order_uid": 4
 }
 

-                    
-
back to top @@ -73488,9 +68384,7 @@
Fields
Example
- - - 
{
+                  
{
   "entered_custom_attributes": [
     EnteredCustomAttributeInput
   ],
@@ -73501,8 +68395,6 @@ 
Example

   ]
 }
 

-                    
-
back to top @@ -73565,15 +68457,11 @@
currentPage
Example
- - - 
{
+                  
{
   "return": Return,
   "returns": Returns
 }
 

-                    
-
back to top @@ -73656,19 +68544,15 @@
pageSize
Example
- - - 
{
-  "description": "abc123",
+                  
{
+  "description": "xyz789",
   "items": RequistionListItems,
-  "items_count": 123,
-  "name": "xyz789",
-  "uid": 4,
+  "items_count": 987,
+  "name": "abc123",
+  "uid": "4",
   "updated_at": "xyz789"
 }
 

-                    
-
back to top @@ -73714,15 +68598,11 @@
Fields
Example
- - - 
{
+                  
{
   "name": FilterMatchTypeInput,
   "uids": FilterEqualTypeInput
 }
 

-                    
-
back to top @@ -73818,17 +68698,13 @@
Possible Types
Example
- - - 
{
+                  
{
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "uid": "4"
 }
 

-                    
-
back to top @@ -73892,18 +68768,14 @@
Fields
Example
- - - 
{
+                  
{
   "entered_options": [EnteredOptionInput],
   "parent_sku": "xyz789",
   "quantity": 987.65,
-  "selected_options": ["abc123"],
+  "selected_options": ["xyz789"],
   "sku": "abc123"
 }
 

-                    
-
back to top @@ -73952,16 +68824,12 @@
Fields
Example
- - - 
{
+                  
{
   "items": [RequisitionList],
   "page_info": SearchResultPageInfo,
   "total_count": 987
 }
 

-                    
-
back to top @@ -74010,16 +68878,12 @@
Fields
Example
- - - 
{
+                  
{
   "items": [RequisitionListItemInterface],
   "page_info": SearchResultPageInfo,
-  "total_pages": 987
+  "total_pages": 123
 }
 

-                    
-
back to top @@ -74103,23 +68967,19 @@
Fields
Example
- - - 
{
+                  
{
   "available_shipping_carriers": [ReturnShippingCarrier],
   "comments": [ReturnComment],
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "customer": ReturnCustomer,
   "items": [ReturnItem],
   "number": "xyz789",
   "order": CustomerOrder,
   "shipping": ReturnShipping,
   "status": "PENDING",
-  "uid": "4"
+  "uid": 4
 }
 

-                    
-
back to top @@ -74173,17 +69033,13 @@
Fields
Example
- - - 
{
+                  
{
   "author_name": "xyz789",
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "text": "abc123",
   "uid": 4
 }
 

-                    
-
back to top @@ -74232,16 +69088,12 @@
Fields
Example
- - - 
{
+                  
{
   "label": "xyz789",
-  "uid": "4",
+  "uid": 4,
   "value": "xyz789"
 }
 

-                    
-
back to top @@ -74290,16 +69142,12 @@
Fields
Example
- - - 
{
+                  
{
   "email": "abc123",
   "firstname": "abc123",
-  "lastname": "xyz789"
+  "lastname": "abc123"
 }
 

-                    
-
back to top @@ -74369,20 +69217,16 @@
Fields
Example
- - - 
{
+                  
{
   "custom_attributes": [ReturnCustomAttribute],
   "custom_attributesV2": [AttributeValueInterface],
   "order_item": OrderItemInterface,
   "quantity": 123.45,
   "request_quantity": 987.65,
   "status": "PENDING",
-  "uid": 4
+  "uid": "4"
 }
 

-                    
-
back to top @@ -74481,26 +69325,22 @@
Fields
Example
- - - 
{
-  "code": "4",
+                  
{
+  "code": 4,
   "default_value": "abc123",
   "entity_type": "CATALOG_PRODUCT",
-  "frontend_class": "abc123",
+  "frontend_class": "xyz789",
   "frontend_input": "BOOLEAN",
   "input_filter": "NONE",
   "is_required": false,
   "is_unique": true,
-  "label": "abc123",
+  "label": "xyz789",
   "multiline_count": 987,
   "options": [CustomAttributeOptionInterface],
   "sort_order": 987,
   "validate_rules": [ValidationRule]
 }
 

-                    
-
back to top @@ -74572,12 +69412,8 @@
Values
Example
- - - 
"PENDING"
+                  
"PENDING"
 

-                    
-
back to top @@ -74634,15 +69470,11 @@
uid
Example
- - - 
{
+                  
{
   "address": ReturnShippingAddress,
   "tracking": [ReturnShippingTracking]
 }
 

-                    
-
back to top @@ -74711,11 +69543,9 @@
Fields
Example
- - - 
{
+                  
{
   "city": "xyz789",
-  "contact_name": "abc123",
+  "contact_name": "xyz789",
   "country": Country,
   "postcode": "xyz789",
   "region": Region,
@@ -74723,8 +69553,6 @@ 
Example

   "telephone": "xyz789"
 }
 

-                    
-
back to top @@ -74768,12 +69596,8 @@
Fields
Example
- - - 
{"label": "abc123", "uid": 4}
+                  
{"label": "xyz789", "uid": 4}
 

-                    
-
back to top @@ -74827,17 +69651,13 @@
Fields
Example
- - - 
{
+                  
{
   "carrier": ReturnShippingCarrier,
   "status": ReturnShippingTrackingStatus,
   "tracking_number": "abc123",
   "uid": 4
 }
 

-                    
-
back to top @@ -74881,12 +69701,8 @@
Fields
Example
- - - 
{"text": "xyz789", "type": "INFORMATION"}
+                  
{"text": "xyz789", "type": "INFORMATION"}
 

-                    
-
back to top @@ -74930,12 +69746,8 @@
Values
Example
- - - 
"INFORMATION"
+                  
"INFORMATION"
 

-                    
-
back to top @@ -75056,12 +69868,8 @@
Values
Example
- - - 
"PENDING"
+                  
"PENDING"
 

-                    
-
back to top @@ -75110,16 +69918,12 @@
Fields
Example
- - - 
{
+                  
{
   "items": [Return],
   "page_info": SearchResultPageInfo,
   "total_count": 987
 }
 

-                    
-
back to top @@ -75158,12 +69962,8 @@
Fields
Example
- - - 
{"result": false}
+                  
{"result": true}
 

-                    
-
back to top @@ -75217,17 +70017,13 @@
Fields
Example
- - - 
{
+                  
{
   "balance": RewardPointsAmount,
   "balance_history": [RewardPointsBalanceHistoryItem],
   "exchange_rates": RewardPointsExchangeRates,
   "subscription_status": RewardPointsSubscriptionStatus
 }
 

-                    
-
back to top @@ -75267,12 +70063,8 @@
Fields
Example
- - - 
{"money": Money, "points": 123.45}
+                  
{"money": Money, "points": 987.65}
 

-                    
-
back to top @@ -75326,17 +70118,13 @@
Fields
Example
- - - 
{
+                  
{
   "balance": RewardPointsAmount,
   "change_reason": "xyz789",
-  "date": "xyz789",
+  "date": "abc123",
   "points_change": 987.65
 }
 

-                    
-
back to top @@ -75380,15 +70168,11 @@
Fields
Example
- - - 
{
+                  
{
   "earning": RewardPointsRate,
   "redemption": RewardPointsRate
 }
 

-                    
-
back to top @@ -75432,12 +70216,8 @@
Fields
Example
- - - 
{"currency_amount": 123.45, "points": 987.65}
+                  
{"currency_amount": 987.65, "points": 123.45}
 

-                    
-
back to top @@ -75481,15 +70261,11 @@
Fields
Example
- - - 
{
+                  
{
   "balance_updates": "SUBSCRIBED",
   "points_expiration_notifications": "SUBSCRIBED"
 }
 

-                    
-
back to top @@ -75533,12 +70309,8 @@
Values
Example
- - - 
"SUBSCRIBED"
+                  
"SUBSCRIBED"
 

-                    
-
back to top @@ -75649,16 +70421,12 @@
Possible Types
Example
- - - 
{
-  "redirect_code": 123,
-  "relative_url": "xyz789",
+                  
{
+  "redirect_code": 987,
+  "relative_url": "abc123",
   "type": "CMS_PAGE"
 }
 

-                    
-
back to top @@ -75707,16 +70475,12 @@
Fields
Example
- - - 
{
+                  
{
   "redirect_code": 987,
-  "relative_url": "xyz789",
+  "relative_url": "abc123",
   "type": "CMS_PAGE"
 }
 

-                    
-
back to top @@ -75760,15 +70524,11 @@
Fields
Example
- - - 
{
-  "name": "abc123",
+                  
{
+  "name": "xyz789",
   "value": "abc123"
 }
 

-                    
-
back to top @@ -75812,15 +70572,11 @@
Fields
Example
- - - 
{
+                  
{
   "message": "abc123",
-  "timestamp": "abc123"
+  "timestamp": "xyz789"
 }
 

-                    
-
back to top @@ -75875,12 +70631,8 @@
Values
Example
- - - 
"GLOBAL"
+                  
"GLOBAL"
 

-                    
-
back to top @@ -75929,12 +70681,8 @@
Fields
Example
- - - 
{"current_page": 123, "page_size": 123, "total_pages": 123}
+                  
{"current_page": 123, "page_size": 123, "total_pages": 987}
 

-                    
-
back to top @@ -75973,12 +70721,8 @@
Fields
Example
- - - 
{"search": "xyz789"}
+                  
{"search": "abc123"}
 

-                    
-
back to top @@ -76039,18 +70783,14 @@
Fields
Example
- - - 
{
+                  
{
   "id": 987,
-  "label": "abc123",
-  "type": "xyz789",
-  "uid": "4",
+  "label": "xyz789",
+  "type": "abc123",
+  "uid": 4,
   "values": [SelectedBundleOptionValue]
 }
 

-                    
-
back to top @@ -76120,20 +70860,16 @@
Fields
Example
- - - 
{
+                  
{
   "id": 123,
-  "label": "xyz789",
+  "label": "abc123",
   "original_price": Money,
   "price": 987.65,
   "priceV2": Money,
   "quantity": 987.65,
-  "uid": "4"
+  "uid": 4
 }
 

-                    
-
back to top @@ -76201,19 +70937,15 @@
Fields
Example
- - - 
{
-  "configurable_product_option_uid": 4,
-  "configurable_product_option_value_uid": "4",
-  "id": 987,
-  "option_label": "abc123",
-  "value_id": 987,
-  "value_label": "abc123"
+                  
{
+  "configurable_product_option_uid": "4",
+  "configurable_product_option_value_uid": 4,
+  "id": 123,
+  "option_label": "xyz789",
+  "value_id": 123,
+  "value_label": "xyz789"
 }
 

-                    
-
back to top @@ -76259,15 +70991,11 @@
Fields
Example
- - - 
{
+                  
{
   "attribute_code": "abc123",
   "value": "xyz789"
 }
 

-                    
-
back to top @@ -76338,9 +71066,7 @@
Fields
Example
- - - 
{
+                  
{
   "customizable_option_uid": 4,
   "id": 123,
   "is_required": false,
@@ -76350,8 +71076,6 @@ 
Example

   "values": [SelectedCustomizableOptionValue]
 }
 

-                    
-
back to top @@ -76412,18 +71136,14 @@
Fields
Example
- - - 
{
-  "customizable_option_value_uid": 4,
+                  
{
+  "customizable_option_value_uid": "4",
   "id": 987,
-  "label": "abc123",
+  "label": "xyz789",
   "price": CartItemSelectedOptionValuePrice,
   "value": "xyz789"
 }
 

-                    
-
back to top @@ -76472,16 +71192,12 @@
Fields
Example
- - - 
{
-  "code": "xyz789",
+                  
{
+  "code": "abc123",
   "purchase_order_number": "xyz789",
-  "title": "abc123"
+  "title": "xyz789"
 }
 

-                    
-
back to top @@ -76557,21 +71273,17 @@
Fields
Example
- - - 
{
+                  
{
   "amount": Money,
   "base_amount": Money,
-  "carrier_code": "abc123",
-  "carrier_title": "xyz789",
-  "method_code": "abc123",
-  "method_title": "xyz789",
+  "carrier_code": "xyz789",
+  "carrier_title": "abc123",
+  "method_code": "xyz789",
+  "method_title": "abc123",
   "price_excl_tax": Money,
   "price_incl_tax": Money
 }
 

-                    
-
back to top @@ -76623,16 +71335,12 @@
Fields
Example
- - - 
{
+                  
{
   "product_id": 123,
   "recipients": [SendEmailToFriendRecipientInput],
   "sender": SendEmailToFriendSenderInput
 }
 

-                    
-
back to top @@ -76676,15 +71384,11 @@
Fields
Example
- - - 
{
+                  
{
   "recipients": [SendEmailToFriendRecipient],
   "sender": SendEmailToFriendSender
 }
 

-                    
-
back to top @@ -76728,15 +71432,11 @@
Fields
Example
- - - 
{
-  "email": "abc123",
-  "name": "xyz789"
+                  
{
+  "email": "xyz789",
+  "name": "abc123"
 }
 

-                    
-
back to top @@ -76782,15 +71482,11 @@
Fields
Example
- - - 
{
-  "email": "abc123",
+                  
{
+  "email": "xyz789",
   "name": "abc123"
 }
 

-                    
-
back to top @@ -76839,16 +71535,12 @@
Fields
Example
- - - 
{
-  "email": "xyz789",
+                  
{
+  "email": "abc123",
   "message": "xyz789",
-  "name": "abc123"
+  "name": "xyz789"
 }
 

-                    
-
back to top @@ -76900,16 +71592,12 @@
Fields
Example
- - - 
{
-  "email": "xyz789",
+                  
{
+  "email": "abc123",
   "message": "xyz789",
   "name": "xyz789"
 }
 

-                    
-
back to top @@ -76953,12 +71641,8 @@
Fields
Example
- - - 
{"enabled_for_customers": false, "enabled_for_guests": false}
+                  
{"enabled_for_customers": false, "enabled_for_guests": true}
 

-                    
-
back to top @@ -77004,12 +71688,11 @@
Fields
Example
- - - 
{"comment": NegotiableQuoteCommentInput, "quote_uid": 4}
+                  
{
+  "comment": NegotiableQuoteCommentInput,
+  "quote_uid": "4"
+}
 

-                    
-
back to top @@ -77048,12 +71731,8 @@
Fields
Example
- - - 
{"quote": NegotiableQuote}
+                  
{"quote": NegotiableQuote}
 

-                    
-
back to top @@ -77099,15 +71778,11 @@
Fields
Example
- - - 
{
+                  
{
   "billing_address": BillingAddressInput,
   "cart_id": "xyz789"
 }
 

-                    
-
back to top @@ -77146,12 +71821,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -77215,18 +71886,14 @@
Fields
Example
- - - 
{
-  "cart_id": "abc123",
+                  
{
+  "cart_id": "xyz789",
   "gift_message": GiftMessageInput,
   "gift_receipt_included": true,
   "gift_wrapping_id": "4",
-  "printed_card_included": true
+  "printed_card_included": false
 }
 

-                    
-
back to top @@ -77265,12 +71932,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -77316,15 +71979,11 @@
Fields
Example
- - - 
{
+                  
{
   "cart_id": "abc123",
   "email": "abc123"
 }
 

-                    
-
back to top @@ -77363,12 +72022,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -77407,12 +72062,8 @@
Fields
Example
- - - 
{"quote": NegotiableQuote}
+                  
{"quote": NegotiableQuote}
 

-                    
-
back to top @@ -77458,15 +72109,11 @@
Fields
Example
- - - 
{
+                  
{
   "billing_address": NegotiableQuoteBillingAddressInput,
   "quote_uid": "4"
 }
 

-                    
-
back to top @@ -77505,12 +72152,8 @@
Fields
Example
- - - 
{"quote": NegotiableQuote}
+                  
{"quote": NegotiableQuote}
 

-                    
-
back to top @@ -77556,15 +72199,11 @@
Fields
Example
- - - 
{
+                  
{
   "payment_method": NegotiableQuotePaymentMethodInput,
-  "quote_uid": "4"
+  "quote_uid": 4
 }
 

-                    
-
back to top @@ -77603,12 +72242,8 @@
Fields
Example
- - - 
{"quote": NegotiableQuote}
+                  
{"quote": NegotiableQuote}
 

-                    
-
back to top @@ -77660,9 +72295,7 @@
Fields
Example
- - - 
{
+                  
{
   "customer_address_id": "4",
   "quote_uid": 4,
   "shipping_addresses": [
@@ -77670,8 +72303,6 @@ 
Example

   ]
 }
 

-                    
-
back to top @@ -77710,12 +72341,8 @@
Fields
Example
- - - 
{"quote": NegotiableQuote}
+                  
{"quote": NegotiableQuote}
 

-                    
-
back to top @@ -77761,15 +72388,11 @@
Fields
Example
- - - 
{
+                  
{
   "quote_uid": 4,
   "shipping_methods": [ShippingMethodInput]
 }
 

-                    
-
back to top @@ -77808,12 +72431,8 @@
Fields
Example
- - - 
{"quote": NegotiableQuote}
+                  
{"quote": NegotiableQuote}
 

-                    
-
back to top @@ -77859,15 +72478,11 @@
Fields
Example
- - - 
{
+                  
{
   "shipping_address": NegotiableQuoteTemplateShippingAddressInput,
   "template_id": "4"
 }
 

-                    
-
back to top @@ -77913,15 +72528,11 @@
Fields
Example
- - - 
{
+                  
{
   "cart_id": "abc123",
   "payment_method": PaymentMethodInput
 }
 

-                    
-
back to top @@ -77967,15 +72578,11 @@
Fields
Example
- - - 
{
+                  
{
   "cart_id": "abc123",
   "payment_method": PaymentMethodInput
 }
 

-                    
-
back to top @@ -78014,12 +72621,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -78065,15 +72668,11 @@
Fields
Example
- - - 
{
+                  
{
   "cart_id": "xyz789",
   "shipping_addresses": [ShippingAddressInput]
 }
 

-                    
-
back to top @@ -78112,12 +72711,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -78163,15 +72758,11 @@
Fields
Example
- - - 
{
+                  
{
   "cart_id": "xyz789",
   "shipping_methods": [ShippingMethodInput]
 }
 

-                    
-
back to top @@ -78210,12 +72801,8 @@
Fields
Example
- - - 
{"cart": Cart}
+                  
{"cart": Cart}
 

-                    
-
back to top @@ -78261,15 +72848,11 @@
Fields
Example
- - - 
{
+                  
{
   "email": "abc123",
   "name": "xyz789"
 }
 

-                    
-
back to top @@ -78308,12 +72891,8 @@
Fields
Example
- - - 
{"is_shared": false}
+                  
{"is_shared": false}
 

-                    
-
back to top @@ -78359,15 +72938,11 @@
Fields
Example
- - - 
{
+                  
{
   "message": "xyz789",
-  "name": "abc123"
+  "name": "xyz789"
 }
 

-                    
-
back to top @@ -78415,12 +72990,8 @@
Values
Example
- - - 
"TOGETHER"
+                  
"TOGETHER"
 

-                    
-
back to top @@ -78480,19 +73051,15 @@
Fields
Example
- - - 
{
+                  
{
   "id": "4",
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "xyz789",
+  "product_sku": "abc123",
   "quantity_shipped": 987.65
 }
 

-                    
-
back to top @@ -78583,19 +73150,15 @@
Possible Types
Example
- - - 
{
+                  
{
   "id": "4",
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "xyz789",
+  "product_sku": "abc123",
   "quantity_shipped": 123.45
 }
 

-                    
-
back to top @@ -78644,16 +73207,12 @@
Fields
Example
- - - 
{
+                  
{
   "carrier": "abc123",
-  "number": "abc123",
-  "title": "xyz789"
+  "number": "xyz789",
+  "title": "abc123"
 }
 

-                    
-
back to top @@ -78711,17 +73270,13 @@
Fields
Example
- - - 
{
+                  
{
   "address": CartAddressInput,
   "customer_address_id": 123,
   "customer_notes": "xyz789",
   "pickup_location_code": "xyz789"
 }
 

-                    
-
back to top @@ -78885,38 +73440,34 @@
Fields
Example
- - - 
{
+                  
{
   "available_shipping_methods": [AvailableShippingMethod],
   "cart_items": [CartItemQuantity],
   "cart_items_v2": [CartItemInterface],
   "city": "abc123",
-  "company": "abc123",
+  "company": "xyz789",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
-  "customer_notes": "abc123",
-  "fax": "abc123",
+  "customer_notes": "xyz789",
+  "fax": "xyz789",
   "firstname": "xyz789",
   "id": 987,
-  "items_weight": 123.45,
-  "lastname": "abc123",
-  "middlename": "abc123",
+  "items_weight": 987.65,
+  "lastname": "xyz789",
+  "middlename": "xyz789",
   "pickup_location_code": "xyz789",
-  "postcode": "abc123",
+  "postcode": "xyz789",
   "prefix": "abc123",
   "region": CartAddressRegion,
-  "same_as_billing": true,
+  "same_as_billing": false,
   "selected_shipping_method": SelectedShippingMethod,
   "street": ["xyz789"],
-  "suffix": "abc123",
-  "telephone": "abc123",
+  "suffix": "xyz789",
+  "telephone": "xyz789",
   "uid": "xyz789",
-  "vat_id": "xyz789"
+  "vat_id": "abc123"
 }
 

-                    
-
back to top @@ -78955,12 +73506,8 @@
Fields
Example
- - - 
{"amount": Money}
+                  
{"amount": Money}
 

-                    
-
back to top @@ -79019,9 +73566,7 @@
Fields
Example
- - - 
{
+                  
{
   "amount_excluding_tax": Money,
   "amount_including_tax": Money,
   "discounts": [ShippingDiscount],
@@ -79029,8 +73574,6 @@ 
Example

   "total_amount": Money
 }
 

-                    
-
back to top @@ -79076,15 +73619,11 @@
Fields
Example
- - - 
{
+                  
{
   "carrier_code": "abc123",
   "method_code": "xyz789"
 }
 

-                    
-
back to top @@ -79205,30 +73744,26 @@
Fields
Example
- - - 
{
+                  
{
   "available_gift_wrapping": [GiftWrapping],
   "customizable_options": [SelectedCustomizableOption],
   "discount": [Discount],
   "errors": [CartItemError],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": "xyz789",
-  "is_available": true,
-  "max_qty": 987.65,
-  "min_qty": 987.65,
+  "id": "abc123",
+  "is_available": false,
+  "max_qty": 123.45,
+  "min_qty": 123.45,
   "not_available_message": "xyz789",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "uid": 4
 }
 

-                    
-
back to top @@ -79777,49 +74312,47 @@
currentPage
Example
- - - 
{
+                  
{
   "activity": "abc123",
   "attribute_set_id": 987,
-  "canonical_url": "abc123",
+  "canonical_url": "xyz789",
   "categories": [CategoryInterface],
-  "category_gear": "abc123",
+  "category_gear": "xyz789",
   "climate": "xyz789",
   "collar": "abc123",
-  "color": 987,
-  "country_of_manufacture": "abc123",
-  "created_at": "xyz789",
+  "color": 123,
+  "country_of_manufacture": "xyz789",
+  "created_at": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "eco_collection": 987,
-  "erin_recommends": 123,
+  "eco_collection": 123,
+  "erin_recommends": 987,
   "features_bags": "xyz789",
-  "format": 987,
+  "format": 123,
   "gender": "xyz789",
-  "gift_message_available": false,
-  "gift_wrapping_available": false,
+  "gift_message_available": true,
+  "gift_wrapping_available": true,
   "gift_wrapping_price": Money,
   "id": 987,
   "image": ProductImage,
   "is_returnable": "xyz789",
   "manufacturer": 987,
   "material": "xyz789",
-  "max_sale_qty": 123.45,
+  "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
   "meta_description": "xyz789",
-  "meta_keyword": "abc123",
-  "meta_title": "abc123",
+  "meta_keyword": "xyz789",
+  "meta_title": "xyz789",
   "min_sale_qty": 987.65,
   "name": "xyz789",
   "new": 123,
   "new_from_date": "xyz789",
   "new_to_date": "xyz789",
-  "only_x_left_in_stock": 987.65,
+  "only_x_left_in_stock": 123.45,
   "options": [CustomizableOptionInterface],
-  "options_container": "abc123",
+  "options_container": "xyz789",
   "pattern": "xyz789",
   "performance_fabric": 123,
   "price": ProductPrices,
@@ -79827,32 +74360,32 @@ 
Example

   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
   "purpose": 987,
-  "quantity": 987.65,
-  "rating_summary": 123.45,
-  "redirect_code": 123,
+  "quantity": 123.45,
+  "rating_summary": 987.65,
+  "redirect_code": 987,
   "related_products": [ProductInterface],
-  "relative_url": "abc123",
+  "relative_url": "xyz789",
   "review_count": 123,
   "reviews": ProductReviews,
   "rules": [CatalogRule],
   "sale": 987,
   "short_description": ComplexTextValue,
-  "size": 987,
+  "size": 123,
   "sku": "abc123",
-  "sleeve": "xyz789",
+  "sleeve": "abc123",
   "small_image": ProductImage,
-  "special_from_date": "xyz789",
-  "special_price": 123.45,
-  "special_to_date": "abc123",
-  "staged": true,
+  "special_from_date": "abc123",
+  "special_price": 987.65,
+  "special_to_date": "xyz789",
+  "staged": false,
   "stock_status": "IN_STOCK",
-  "strap_bags": "xyz789",
-  "style_bags": "xyz789",
+  "strap_bags": "abc123",
+  "style_bags": "abc123",
   "style_bottom": "xyz789",
   "style_general": "xyz789",
   "swatch_image": "xyz789",
   "thumbnail": ProductImage,
-  "tier_price": 123.45,
+  "tier_price": 987.65,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
   "type_id": "xyz789",
@@ -79867,8 +74400,6 @@ 
Example

   "weight": 987.65
 }
 

-                    
-
back to top @@ -79914,15 +74445,11 @@
Fields
Example
- - - 
{
+                  
{
   "customizable_options": [CustomizableOptionInput],
   "data": CartItemInput
 }
 

-                    
-
back to top @@ -79976,17 +74503,13 @@
Fields
Example
- - - 
{
+                  
{
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
   "quantity": 123.45,
   "uid": 4
 }
 

-                    
-
back to top @@ -80050,19 +74573,15 @@
Fields
Example
- - - 
{
-  "added_at": "xyz789",
+                  
{
+  "added_at": "abc123",
   "customizable_options": [SelectedCustomizableOption],
   "description": "abc123",
-  "id": "4",
+  "id": 4,
   "product": ProductInterface,
   "quantity": 987.65
 }
 

-                    
-
back to top @@ -80114,16 +74633,12 @@
Fields
Example
- - - 
{
+                  
{
   "payment_source": "abc123",
-  "payments_order_id": "abc123",
+  "payments_order_id": "xyz789",
   "paypal_order_id": "abc123"
 }
 

-                    
-
back to top @@ -80203,23 +74718,19 @@
Fields
Example
- - - 
{
+                  
{
   "button_styles": ButtonStyles,
   "code": "xyz789",
   "display_message": true,
   "display_venmo": true,
   "is_visible": false,
   "message_styles": MessageStyles,
-  "payment_intent": "xyz789",
+  "payment_intent": "abc123",
   "sdk_params": [SDKParams],
-  "sort_order": "xyz789",
-  "title": "abc123"
+  "sort_order": "abc123",
+  "title": "xyz789"
 }
 

-                    
-
back to top @@ -80267,12 +74778,8 @@
Values
Example
- - - 
"ASC"
+                  
"ASC"
 

-                    
-
back to top @@ -80316,15 +74823,11 @@
Fields
Example
- - - 
{
-  "label": "abc123",
-  "value": "abc123"
+                  
{
+  "label": "xyz789",
+  "value": "xyz789"
 }
 

-                    
-
back to top @@ -80368,15 +74871,11 @@
Fields
Example
- - - 
{
-  "default": "abc123",
+                  
{
+  "default": "xyz789",
   "options": [SortField]
 }
 

-                    
-
back to top @@ -80641,12 +75140,8 @@
Values
Example
- - - 
"ITEM_ID"
+                  
"ITEM_ID"
 

-                    
-
back to top @@ -81900,217 +76395,215 @@
Fields
Example
- - - 
{
+                  
{
   "absolute_footer": "abc123",
-  "allow_gift_receipt": "abc123",
-  "allow_gift_wrapping_on_order": "abc123",
+  "allow_gift_receipt": "xyz789",
+  "allow_gift_wrapping_on_order": "xyz789",
   "allow_gift_wrapping_on_order_items": "abc123",
-  "allow_guests_to_write_product_reviews": "abc123",
+  "allow_guests_to_write_product_reviews": "xyz789",
   "allow_items": "xyz789",
   "allow_order": "xyz789",
   "allow_printed_card": "abc123",
-  "autocomplete_on_storefront": true,
+  "autocomplete_on_storefront": false,
   "base_currency_code": "abc123",
   "base_link_url": "abc123",
-  "base_media_url": "xyz789",
-  "base_static_url": "xyz789",
+  "base_media_url": "abc123",
+  "base_static_url": "abc123",
   "base_url": "xyz789",
   "braintree_3dsecure_allowspecific": false,
-  "braintree_3dsecure_always_request_3ds": false,
+  "braintree_3dsecure_always_request_3ds": true,
   "braintree_3dsecure_specificcountry": "abc123",
   "braintree_3dsecure_threshold_amount": "xyz789",
-  "braintree_3dsecure_verify_3dsecure": true,
+  "braintree_3dsecure_verify_3dsecure": false,
   "braintree_ach_direct_debit_vault_active": true,
-  "braintree_applepay_merchant_name": "xyz789",
+  "braintree_applepay_merchant_name": "abc123",
   "braintree_applepay_vault_active": true,
   "braintree_cc_vault_active": "xyz789",
-  "braintree_cc_vault_cvv": true,
-  "braintree_environment": "xyz789",
+  "braintree_cc_vault_cvv": false,
+  "braintree_environment": "abc123",
   "braintree_googlepay_btn_color": "xyz789",
-  "braintree_googlepay_cctypes": "xyz789",
+  "braintree_googlepay_cctypes": "abc123",
   "braintree_googlepay_merchant_id": "xyz789",
   "braintree_googlepay_vault_active": false,
-  "braintree_local_payment_allowed_methods": "abc123",
+  "braintree_local_payment_allowed_methods": "xyz789",
   "braintree_local_payment_fallback_button_text": "abc123",
   "braintree_local_payment_redirect_on_fail": "xyz789",
   "braintree_merchant_account_id": "abc123",
   "braintree_paypal_button_location_cart_type_credit_color": "abc123",
-  "braintree_paypal_button_location_cart_type_credit_label": "xyz789",
+  "braintree_paypal_button_location_cart_type_credit_label": "abc123",
   "braintree_paypal_button_location_cart_type_credit_shape": "abc123",
-  "braintree_paypal_button_location_cart_type_credit_show": false,
-  "braintree_paypal_button_location_cart_type_messaging_layout": "abc123",
+  "braintree_paypal_button_location_cart_type_credit_show": true,
+  "braintree_paypal_button_location_cart_type_messaging_layout": "xyz789",
   "braintree_paypal_button_location_cart_type_messaging_logo": "abc123",
-  "braintree_paypal_button_location_cart_type_messaging_logo_position": "xyz789",
-  "braintree_paypal_button_location_cart_type_messaging_show": true,
+  "braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123",
+  "braintree_paypal_button_location_cart_type_messaging_show": false,
   "braintree_paypal_button_location_cart_type_messaging_text_color": "xyz789",
   "braintree_paypal_button_location_cart_type_paylater_color": "abc123",
-  "braintree_paypal_button_location_cart_type_paylater_label": "abc123",
-  "braintree_paypal_button_location_cart_type_paylater_shape": "xyz789",
-  "braintree_paypal_button_location_cart_type_paylater_show": false,
-  "braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
-  "braintree_paypal_button_location_cart_type_paypal_label": "xyz789",
+  "braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
+  "braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
+  "braintree_paypal_button_location_cart_type_paylater_show": true,
+  "braintree_paypal_button_location_cart_type_paypal_color": "abc123",
+  "braintree_paypal_button_location_cart_type_paypal_label": "abc123",
   "braintree_paypal_button_location_cart_type_paypal_shape": "abc123",
-  "braintree_paypal_button_location_cart_type_paypal_show": false,
-  "braintree_paypal_button_location_checkout_type_credit_color": "xyz789",
+  "braintree_paypal_button_location_cart_type_paypal_show": true,
+  "braintree_paypal_button_location_checkout_type_credit_color": "abc123",
   "braintree_paypal_button_location_checkout_type_credit_label": "abc123",
-  "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789",
-  "braintree_paypal_button_location_checkout_type_credit_show": false,
+  "braintree_paypal_button_location_checkout_type_credit_shape": "abc123",
+  "braintree_paypal_button_location_checkout_type_credit_show": true,
   "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789",
   "braintree_paypal_button_location_checkout_type_messaging_logo": "abc123",
   "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789",
-  "braintree_paypal_button_location_checkout_type_messaging_show": true,
+  "braintree_paypal_button_location_checkout_type_messaging_show": false,
   "braintree_paypal_button_location_checkout_type_messaging_text_color": "xyz789",
   "braintree_paypal_button_location_checkout_type_paylater_color": "abc123",
-  "braintree_paypal_button_location_checkout_type_paylater_label": "xyz789",
-  "braintree_paypal_button_location_checkout_type_paylater_shape": "abc123",
+  "braintree_paypal_button_location_checkout_type_paylater_label": "abc123",
+  "braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789",
   "braintree_paypal_button_location_checkout_type_paylater_show": true,
   "braintree_paypal_button_location_checkout_type_paypal_color": "abc123",
   "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789",
-  "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789",
-  "braintree_paypal_button_location_checkout_type_paypal_show": true,
+  "braintree_paypal_button_location_checkout_type_paypal_shape": "abc123",
+  "braintree_paypal_button_location_checkout_type_paypal_show": false,
   "braintree_paypal_button_location_productpage_type_credit_color": "xyz789",
   "braintree_paypal_button_location_productpage_type_credit_label": "xyz789",
   "braintree_paypal_button_location_productpage_type_credit_shape": "abc123",
   "braintree_paypal_button_location_productpage_type_credit_show": false,
   "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789",
-  "braintree_paypal_button_location_productpage_type_messaging_logo": "abc123",
-  "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789",
+  "braintree_paypal_button_location_productpage_type_messaging_logo": "xyz789",
+  "braintree_paypal_button_location_productpage_type_messaging_logo_position": "abc123",
   "braintree_paypal_button_location_productpage_type_messaging_show": false,
   "braintree_paypal_button_location_productpage_type_messaging_text_color": "abc123",
-  "braintree_paypal_button_location_productpage_type_paylater_color": "abc123",
-  "braintree_paypal_button_location_productpage_type_paylater_label": "abc123",
+  "braintree_paypal_button_location_productpage_type_paylater_color": "xyz789",
+  "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789",
   "braintree_paypal_button_location_productpage_type_paylater_shape": "abc123",
-  "braintree_paypal_button_location_productpage_type_paylater_show": true,
+  "braintree_paypal_button_location_productpage_type_paylater_show": false,
   "braintree_paypal_button_location_productpage_type_paypal_color": "xyz789",
   "braintree_paypal_button_location_productpage_type_paypal_label": "xyz789",
-  "braintree_paypal_button_location_productpage_type_paypal_shape": "abc123",
-  "braintree_paypal_button_location_productpage_type_paypal_show": true,
+  "braintree_paypal_button_location_productpage_type_paypal_shape": "xyz789",
+  "braintree_paypal_button_location_productpage_type_paypal_show": false,
   "braintree_paypal_credit_uk_merchant_name": "xyz789",
   "braintree_paypal_display_on_shopping_cart": false,
-  "braintree_paypal_merchant_country": "abc123",
+  "braintree_paypal_merchant_country": "xyz789",
   "braintree_paypal_merchant_name_override": "abc123",
-  "braintree_paypal_require_billing_address": true,
-  "braintree_paypal_send_cart_line_items": true,
+  "braintree_paypal_require_billing_address": false,
+  "braintree_paypal_send_cart_line_items": false,
   "braintree_paypal_vault_active": false,
   "cart_expires_in_days": 987,
   "cart_gift_wrapping": "xyz789",
   "cart_printed_card": "xyz789",
   "cart_summary_display_quantity": 123,
-  "catalog_default_sort_by": "abc123",
+  "catalog_default_sort_by": "xyz789",
   "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
   "category_url_suffix": "xyz789",
   "check_money_order_enable_for_specific_countries": false,
   "check_money_order_enabled": true,
-  "check_money_order_make_check_payable_to": "abc123",
-  "check_money_order_max_order_total": "abc123",
-  "check_money_order_min_order_total": "abc123",
-  "check_money_order_new_order_status": "abc123",
-  "check_money_order_payment_from_specific_countries": "xyz789",
+  "check_money_order_make_check_payable_to": "xyz789",
+  "check_money_order_max_order_total": "xyz789",
+  "check_money_order_min_order_total": "xyz789",
+  "check_money_order_new_order_status": "xyz789",
+  "check_money_order_payment_from_specific_countries": "abc123",
   "check_money_order_send_check_to": "xyz789",
   "check_money_order_sort_order": 123,
-  "check_money_order_title": "xyz789",
-  "cms_home_page": "xyz789",
-  "cms_no_cookies": "xyz789",
+  "check_money_order_title": "abc123",
+  "cms_home_page": "abc123",
+  "cms_no_cookies": "abc123",
   "cms_no_route": "xyz789",
-  "code": "xyz789",
+  "code": "abc123",
   "configurable_product_image": "ITSELF",
   "configurable_thumbnail_source": "xyz789",
-  "contact_enabled": true,
+  "contact_enabled": false,
   "copyright": "abc123",
   "countries_with_required_region": "xyz789",
-  "create_account_confirmation": false,
-  "customer_access_token_lifetime": 987.65,
+  "create_account_confirmation": true,
+  "customer_access_token_lifetime": 123.45,
   "default_country": "abc123",
   "default_description": "xyz789",
   "default_display_currency_code": "abc123",
   "default_keywords": "xyz789",
-  "default_title": "abc123",
+  "default_title": "xyz789",
   "demonotice": 123,
   "display_product_prices_in_catalog": 987,
-  "display_shipping_prices": 987,
-  "display_state_if_optional": true,
-  "enable_multiple_wishlists": "xyz789",
-  "fixed_product_taxes_apply_tax_to_fpt": true,
+  "display_shipping_prices": 123,
+  "display_state_if_optional": false,
+  "enable_multiple_wishlists": "abc123",
+  "fixed_product_taxes_apply_tax_to_fpt": false,
   "fixed_product_taxes_display_prices_in_emails": 987,
-  "fixed_product_taxes_display_prices_in_product_lists": 123,
-  "fixed_product_taxes_display_prices_in_sales_modules": 987,
-  "fixed_product_taxes_display_prices_on_product_view_page": 123,
-  "fixed_product_taxes_enable": true,
+  "fixed_product_taxes_display_prices_in_product_lists": 987,
+  "fixed_product_taxes_display_prices_in_sales_modules": 123,
+  "fixed_product_taxes_display_prices_on_product_view_page": 987,
+  "fixed_product_taxes_enable": false,
   "fixed_product_taxes_include_fpt_in_subtotal": true,
-  "front": "xyz789",
-  "graphql_share_all_customer_groups": true,
+  "front": "abc123",
+  "graphql_share_all_customer_groups": false,
   "graphql_share_customer_group": true,
-  "grid_per_page": 123,
+  "grid_per_page": 987,
   "grid_per_page_values": "xyz789",
   "grouped_product_image": "ITSELF",
-  "head_includes": "abc123",
+  "head_includes": "xyz789",
   "head_shortcut_icon": "xyz789",
-  "header_logo_src": "xyz789",
-  "id": 987,
+  "header_logo_src": "abc123",
+  "id": 123,
   "is_checkout_agreements_enabled": true,
-  "is_default_store": false,
-  "is_default_store_group": true,
+  "is_default_store": true,
+  "is_default_store_group": false,
   "is_guest_checkout_enabled": true,
   "is_negotiable_quote_active": false,
-  "is_one_page_checkout_enabled": true,
+  "is_one_page_checkout_enabled": false,
   "is_requisition_list_active": "abc123",
-  "list_mode": "abc123",
+  "list_mode": "xyz789",
   "list_per_page": 987,
-  "list_per_page_values": "abc123",
+  "list_per_page_values": "xyz789",
   "locale": "abc123",
   "logo_alt": "xyz789",
-  "logo_height": 123,
+  "logo_height": 987,
   "logo_width": 123,
-  "magento_reward_general_is_enabled": "abc123",
-  "magento_reward_general_is_enabled_on_front": "xyz789",
-  "magento_reward_general_min_points_balance": "xyz789",
+  "magento_reward_general_is_enabled": "xyz789",
+  "magento_reward_general_is_enabled_on_front": "abc123",
+  "magento_reward_general_min_points_balance": "abc123",
   "magento_reward_general_publish_history": "xyz789",
-  "magento_reward_points_invitation_customer": "abc123",
+  "magento_reward_points_invitation_customer": "xyz789",
   "magento_reward_points_invitation_customer_limit": "xyz789",
   "magento_reward_points_invitation_order": "abc123",
-  "magento_reward_points_invitation_order_limit": "xyz789",
+  "magento_reward_points_invitation_order_limit": "abc123",
   "magento_reward_points_newsletter": "xyz789",
   "magento_reward_points_order": "xyz789",
-  "magento_reward_points_register": "xyz789",
+  "magento_reward_points_register": "abc123",
   "magento_reward_points_review": "xyz789",
   "magento_reward_points_review_limit": "xyz789",
   "magento_wishlist_general_is_enabled": "xyz789",
-  "max_items_in_order_summary": 123,
+  "max_items_in_order_summary": 987,
   "maximum_number_of_wishlists": "xyz789",
-  "minicart_display": false,
-  "minicart_max_items": 987,
+  "minicart_display": true,
+  "minicart_max_items": 123,
   "minimum_password_length": "xyz789",
   "newsletter_enabled": true,
-  "no_route": "abc123",
+  "no_route": "xyz789",
   "optional_zip_countries": "abc123",
-  "order_cancellation_enabled": true,
+  "order_cancellation_enabled": false,
   "order_cancellation_reasons": [CancellationReason],
   "orders_invoices_credit_memos_display_full_summary": true,
-  "orders_invoices_credit_memos_display_grandtotal": true,
-  "orders_invoices_credit_memos_display_price": 123,
+  "orders_invoices_credit_memos_display_grandtotal": false,
+  "orders_invoices_credit_memos_display_price": 987,
   "orders_invoices_credit_memos_display_shipping_amount": 123,
-  "orders_invoices_credit_memos_display_subtotal": 987,
+  "orders_invoices_credit_memos_display_subtotal": 123,
   "orders_invoices_credit_memos_display_zero_tax": true,
-  "payment_payflowpro_cc_vault_active": "abc123",
-  "printed_card_price": "abc123",
+  "payment_payflowpro_cc_vault_active": "xyz789",
+  "printed_card_price": "xyz789",
   "printed_card_priceV2": Money,
   "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
   "product_reviews_enabled": "xyz789",
   "product_url_suffix": "abc123",
-  "quickorder_active": false,
+  "quickorder_active": true,
   "required_character_classes_number": "abc123",
   "returns_enabled": "xyz789",
   "root_category_id": 123,
   "root_category_uid": 4,
   "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
   "sales_gift_wrapping": "abc123",
-  "sales_printed_card": "xyz789",
-  "secure_base_link_url": "xyz789",
+  "sales_printed_card": "abc123",
+  "secure_base_link_url": "abc123",
   "secure_base_media_url": "xyz789",
   "secure_base_static_url": "xyz789",
-  "secure_base_url": "abc123",
+  "secure_base_url": "xyz789",
   "send_friend": SendFriendConfiguration,
   "share_all_catalog_rules": true,
   "share_all_sales_rule": false,
@@ -82122,34 +76615,32 @@ 
Example

   "shopping_cart_display_shipping": 987,
   "shopping_cart_display_subtotal": 987,
   "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
-  "shopping_cart_display_zero_tax": false,
-  "show_cms_breadcrumbs": 123,
-  "store_code": 4,
-  "store_group_code": "4",
-  "store_group_name": "abc123",
+  "shopping_cart_display_zero_tax": true,
+  "show_cms_breadcrumbs": 987,
+  "store_code": "4",
+  "store_group_code": 4,
+  "store_group_name": "xyz789",
   "store_name": "abc123",
-  "store_sort_order": 123,
+  "store_sort_order": 987,
   "timezone": "xyz789",
-  "title_prefix": "xyz789",
-  "title_separator": "abc123",
-  "title_suffix": "xyz789",
-  "use_store_in_url": true,
+  "title_prefix": "abc123",
+  "title_separator": "xyz789",
+  "title_suffix": "abc123",
+  "use_store_in_url": false,
   "website_code": "4",
   "website_id": 123,
   "website_name": "xyz789",
   "weight_unit": "xyz789",
   "welcome": "abc123",
   "zero_subtotal_enable_for_specific_countries": true,
-  "zero_subtotal_enabled": false,
-  "zero_subtotal_new_order_status": "abc123",
-  "zero_subtotal_payment_action": "abc123",
-  "zero_subtotal_payment_from_specific_countries": "abc123",
-  "zero_subtotal_sort_order": 123,
+  "zero_subtotal_enabled": true,
+  "zero_subtotal_new_order_status": "xyz789",
+  "zero_subtotal_payment_action": "xyz789",
+  "zero_subtotal_payment_from_specific_countries": "xyz789",
+  "zero_subtotal_sort_order": 987,
   "zero_subtotal_title": "xyz789"
 }
 

-                    
-
back to top @@ -82208,18 +76699,14 @@
Fields
Example
- - - 
{
-  "position": 123,
+                  
{
+  "position": 987,
   "use_in_layered_navigation": "NO",
-  "use_in_product_listing": true,
+  "use_in_product_listing": false,
   "use_in_search_results_layered_navigation": true,
   "visible_on_catalog_pages": true
 }
 

-                    
-
back to top @@ -82240,12 +76727,8 @@
Description
Example
- - - 
"abc123"
+                  
"abc123"
 

-                    
-
back to top @@ -82315,21 +76798,17 @@
Fields
Example
- - - 
{
+                  
{
   "comment": "abc123",
   "max_order_commitment": 123,
-  "min_order_commitment": 123,
-  "name": "xyz789",
+  "min_order_commitment": 987,
+  "name": "abc123",
   "reference_document_links": [
     NegotiableQuoteTemplateReferenceDocumentLinkInput
   ],
-  "template_id": 4
+  "template_id": "4"
 }
 

-                    
-
back to top @@ -82368,12 +76847,8 @@
Fields
Example
- - - 
{"status": "NOT_ACTIVE"}
+                  
{"status": "NOT_ACTIVE"}
 

-                    
-
back to top @@ -82435,12 +76910,8 @@
Values
Example
- - - 
"NOT_ACTIVE"
+                  
"NOT_ACTIVE"
 

-                    
-
back to top @@ -82484,15 +76955,11 @@
Fields
Example
- - - 
{
-  "type": "abc123",
+                  
{
+  "type": "xyz789",
   "value": "xyz789"
 }
 

-                    
-
back to top @@ -82554,12 +77021,8 @@
Possible Types
Example
- - - 
{"value": "xyz789"}
+                  
{"value": "abc123"}
 

-                    
-
back to top @@ -82719,12 +77182,8 @@
Values
Example
- - - 
"BOOLEAN"
+                  
"BOOLEAN"
 

-                    
-
back to top @@ -82777,17 +77236,13 @@
Fields
Example
- - - 
{
+                  
{
   "items_count": 987,
   "label": "abc123",
   "swatch_data": SwatchData,
   "value_string": "xyz789"
 }
 

-                    
-
back to top @@ -82839,12 +77294,8 @@
Possible Types
Example
- - - 
{"swatch_data": SwatchData}
+                  
{"swatch_data": SwatchData}
 

-                    
-
back to top @@ -82890,15 +77341,11 @@
Fields
Example
- - - 
{
-  "cartId": "abc123",
+                  
{
+  "cartId": "xyz789",
   "id": "xyz789"
 }
 

-                    
-
back to top @@ -82947,16 +77394,12 @@
Fields
Example
- - - 
{
+                  
{
   "amount": Money,
-  "rate": 987.65,
+  "rate": 123.45,
   "title": "xyz789"
 }
 

-                    
-
back to top @@ -83007,12 +77450,8 @@
Values
Example
- - - 
"DISPLAY_EXCLUDING_TAX"
+                  
"DISPLAY_EXCLUDING_TAX"
 

-                    
-
back to top @@ -83047,12 +77486,8 @@
Fields
Example
- - - 
{"value": "xyz789"}
+                  
{"value": "xyz789"}
 

-                    
-
back to top @@ -83107,12 +77542,8 @@
Values
Example
- - - 
"OFF"
+                  
"OFF"
 

-                    
-
back to top @@ -83161,16 +77592,12 @@
Fields
Example
- - - 
{
+                  
{
   "discount": ProductDiscount,
   "final_price": Money,
-  "quantity": 987.65
+  "quantity": 123.45
 }
 

-                    
-
back to top @@ -83216,15 +77643,11 @@
Fields
Example
- - - 
{
-  "cart_id": "abc123",
+                  
{
+  "cart_id": "xyz789",
   "cart_items": [CartItemUpdateInput]
 }
 

-                    
-
back to top @@ -83268,15 +77691,11 @@
Fields
Example
- - - 
{
+                  
{
   "cart": Cart,
   "errors": [CartUserInputError]
 }
 

-                    
-
back to top @@ -83315,12 +77734,8 @@
Fields
Example
- - - 
{"company": Company}
+                  
{"company": Company}
 

-                    
-
back to top @@ -83359,12 +77774,8 @@
Fields
Example
- - - 
{"role": CompanyRole}
+                  
{"role": CompanyRole}
 

-                    
-
back to top @@ -83403,12 +77814,8 @@
Fields
Example
- - - 
{"company": Company}
+                  
{"company": Company}
 

-                    
-
back to top @@ -83447,12 +77854,8 @@
Fields
Example
- - - 
{"team": CompanyTeam}
+                  
{"team": CompanyTeam}
 

-                    
-
back to top @@ -83491,12 +77894,8 @@
Fields
Example
- - - 
{"user": Customer}
+                  
{"user": Customer}
 

-                    
-
back to top @@ -83566,21 +77965,17 @@
Fields
Example
- - - 
{
+                  
{
   "dynamic_attributes": [
     GiftRegistryDynamicAttributeInput
   ],
   "event_name": "xyz789",
-  "message": "abc123",
+  "message": "xyz789",
   "privacy_settings": "PRIVATE",
   "shipping_address": GiftRegistryShippingAddressInput,
   "status": "ACTIVE"
 }
 

-                    
-
back to top @@ -83632,16 +78027,12 @@
Fields
Example
- - - 
{
-  "gift_registry_item_uid": "4",
+                  
{
+  "gift_registry_item_uid": 4,
   "note": "abc123",
   "quantity": 123.45
 }
 

-                    
-
back to top @@ -83680,12 +78071,8 @@
Fields
Example
- - - 
{"gift_registry": GiftRegistry}
+                  
{"gift_registry": GiftRegistry}
 

-                    
-
back to top @@ -83724,12 +78111,8 @@
Fields
Example
- - - 
{"gift_registry": GiftRegistry}
+                  
{"gift_registry": GiftRegistry}
 

-                    
-
back to top @@ -83793,20 +78176,16 @@
Fields
Example
- - - 
{
+                  
{
   "dynamic_attributes": [
     GiftRegistryDynamicAttributeInput
   ],
-  "email": "xyz789",
+  "email": "abc123",
   "firstname": "xyz789",
   "gift_registry_registrant_uid": "4",
   "lastname": "xyz789"
 }
 

-                    
-
back to top @@ -83845,12 +78224,8 @@
Fields
Example
- - - 
{"gift_registry": GiftRegistry}
+                  
{"gift_registry": GiftRegistry}
 

-                    
-
back to top @@ -83889,12 +78264,8 @@
Fields
Example
- - - 
{"quote": NegotiableQuote}
+                  
{"quote": NegotiableQuote}
 

-                    
-
back to top @@ -83940,15 +78311,11 @@
Fields
Example
- - - 
{
+                  
{
   "items": [NegotiableQuoteItemQuantityInput],
   "quote_uid": "4"
 }
 

-                    
-
back to top @@ -83987,12 +78354,8 @@
Fields
Example
- - - 
{"quote_template": NegotiableQuoteTemplate}
+                  
{"quote_template": NegotiableQuoteTemplate}
 

-                    
-
back to top @@ -84038,15 +78401,11 @@
Fields
Example
- - - 
{
+                  
{
   "items": [NegotiableQuoteTemplateItemQuantityInput],
   "template_id": "4"
 }
 

-                    
-
back to top @@ -84090,15 +78449,11 @@
Fields
Example
- - - 
{
+                  
{
   "user_errors": [WishListUserInputError],
   "wishlist": Wishlist
 }
 

-                    
-
back to top @@ -84174,20 +78529,16 @@
Fields
Example
- - - 
{
-  "applies_to": [4],
+                  
{
+  "applies_to": ["4"],
   "approvers": [4],
   "condition": CreatePurchaseOrderApprovalRuleConditionInput,
-  "description": "abc123",
-  "name": "abc123",
+  "description": "xyz789",
+  "name": "xyz789",
   "status": "ENABLED",
-  "uid": "4"
+  "uid": 4
 }
 

-                    
-
back to top @@ -84233,15 +78584,11 @@
Fields
Example
- - - 
{
+                  
{
   "description": "xyz789",
   "name": "abc123"
 }
 

-                    
-
back to top @@ -84299,17 +78646,13 @@
Fields
Example
- - - 
{
+                  
{
   "entered_options": [EnteredOptionInput],
   "item_id": "4",
-  "quantity": 987.65,
+  "quantity": 123.45,
   "selected_options": ["xyz789"]
 }
 

-                    
-
back to top @@ -84348,12 +78691,8 @@
Fields
Example
- - - 
{"requisition_list": RequisitionList}
+                  
{"requisition_list": RequisitionList}
 

-                    
-
back to top @@ -84392,12 +78731,8 @@
Fields
Example
- - - 
{"requisition_list": RequisitionList}
+                  
{"requisition_list": RequisitionList}
 

-                    
-
back to top @@ -84446,16 +78781,12 @@
Fields
Example
- - - 
{
-  "name": "abc123",
-  "uid": "4",
+                  
{
+  "name": "xyz789",
+  "uid": 4,
   "visibility": "PUBLIC"
 }
 

-                    
-
back to top @@ -84499,15 +78830,11 @@
Fields
Example
- - - 
{
+                  
{
   "parameters": [HttpQueryParameter],
   "url": "abc123"
 }
 

-                    
-
back to top @@ -84562,12 +78889,8 @@
Values
Example
- - - 
"CMS_PAGE"
+                  
"CMS_PAGE"
 

-                    
-
back to top @@ -84622,12 +78945,8 @@
Values
Example
- - - 
"NO"
+                  
"NO"
 

-                    
-
back to top @@ -84679,16 +78998,12 @@
Fields
Example
- - - 
{
-  "currentPage": 123,
+                  
{
+  "currentPage": 987,
   "pageSize": 123,
   "sort": [CompaniesSortInput]
 }
 

-                    
-
back to top @@ -84732,15 +79047,11 @@
Fields
Example
- - - 
{
+                  
{
   "items": [CompanyBasicInfo],
   "page_info": SearchResultPageInfo
 }
 

-                    
-
back to top @@ -84784,12 +79095,8 @@
Fields
Example
- - - 
{"message": "abc123", "type": "NOT_FOUND"}
+                  
{"message": "xyz789", "type": "NOT_FOUND"}
 

-                    
-
back to top @@ -84854,12 +79161,8 @@
Values
Example
- - - 
"NOT_FOUND"
+                  
"NOT_FOUND"
 

-                    
-
back to top @@ -84899,12 +79202,8 @@
Fields
Example
- - - 
{"purchase_order_uids": ["4"]}
+                  
{"purchase_order_uids": [4]}
 

-                    
-
back to top @@ -84948,15 +79247,11 @@
Fields
Example
- - - 
{
+                  
{
   "errors": [ValidatePurchaseOrderError],
   "purchase_orders": [PurchaseOrder]
 }
 

-                    
-
back to top @@ -85000,15 +79295,11 @@
Fields
Example
- - - 
{
+                  
{
   "name": "DATE_RANGE_MAX",
-  "value": "abc123"
+  "value": "xyz789"
 }
 

-                    
-
back to top @@ -85105,12 +79396,8 @@
Values
Example
- - - 
"DATE_RANGE_MAX"
+                  
"DATE_RANGE_MAX"
 

-                    
-
back to top @@ -85149,12 +79436,8 @@
Fields
Example
- - - 
{"credit_card": VaultCreditCardConfig}
+                  
{"credit_card": VaultCreditCardConfig}
 

-                    
-
back to top @@ -85199,16 +79482,12 @@
Fields
Example
- - - 
{
+                  
{
   "is_vault_enabled": true,
   "sdk_params": [SDKParams],
   "three_ds_mode": "OFF"
 }
 

-                    
-
back to top @@ -85266,17 +79545,13 @@
Fields
Example
- - - 
{
+                  
{
   "payment_source": "xyz789",
-  "payments_order_id": "xyz789",
-  "paypal_order_id": "xyz789",
+  "payments_order_id": "abc123",
+  "paypal_order_id": "abc123",
   "public_hash": "xyz789"
 }
 

-                    
-
back to top @@ -85316,12 +79591,8 @@
Fields
Example
- - - 
{"payment_source": PaymentSourceInput}
+                  
{"payment_source": PaymentSourceInput}
 

-                    
-
back to top @@ -85361,12 +79632,8 @@
Fields
Example
- - - 
{"public_hash": "xyz789"}
+                  
{"public_hash": "xyz789"}
 

-                    
-
back to top @@ -85472,17 +79739,15 @@
Fields
Example
- - - 
{
+                  
{
   "customizable_options": [SelectedCustomizableOption],
   "discount": [Discount],
   "errors": [CartItemError],
   "id": "xyz789",
-  "is_available": true,
+  "is_available": false,
   "max_qty": 987.65,
-  "min_qty": 987.65,
-  "not_available_message": "abc123",
+  "min_qty": 123.45,
+  "not_available_message": "xyz789",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
@@ -85491,8 +79756,6 @@ 
Example

   "uid": 4
 }
 

-                    
-
back to top @@ -86036,71 +80299,69 @@
currentPage
Example
- - - 
{
+                  
{
   "activity": "xyz789",
-  "attribute_set_id": 123,
-  "canonical_url": "abc123",
+  "attribute_set_id": 987,
+  "canonical_url": "xyz789",
   "categories": [CategoryInterface],
   "category_gear": "abc123",
   "climate": "xyz789",
-  "collar": "abc123",
-  "color": 123,
+  "collar": "xyz789",
+  "color": 987,
   "country_of_manufacture": "xyz789",
   "created_at": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "eco_collection": 987,
+  "eco_collection": 123,
   "erin_recommends": 123,
-  "features_bags": "xyz789",
-  "format": 123,
-  "gender": "xyz789",
-  "gift_message_available": true,
+  "features_bags": "abc123",
+  "format": 987,
+  "gender": "abc123",
+  "gift_message_available": false,
   "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
-  "id": 123,
+  "id": 987,
   "image": ProductImage,
   "is_returnable": "xyz789",
   "manufacturer": 987,
-  "material": "xyz789",
-  "max_sale_qty": 987.65,
+  "material": "abc123",
+  "max_sale_qty": 123.45,
   "media_gallery": [MediaGalleryInterface],
   "media_gallery_entries": [MediaGalleryEntry],
   "meta_description": "abc123",
   "meta_keyword": "xyz789",
-  "meta_title": "abc123",
+  "meta_title": "xyz789",
   "min_sale_qty": 123.45,
   "name": "abc123",
   "new": 123,
   "new_from_date": "abc123",
-  "new_to_date": "xyz789",
+  "new_to_date": "abc123",
   "only_x_left_in_stock": 123.45,
   "options": [CustomizableOptionInterface],
   "options_container": "abc123",
   "pattern": "abc123",
-  "performance_fabric": 123,
+  "performance_fabric": 987,
   "price": ProductPrices,
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
   "purpose": 987,
-  "quantity": 123.45,
+  "quantity": 987.65,
   "rating_summary": 123.45,
-  "redirect_code": 123,
+  "redirect_code": 987,
   "related_products": [ProductInterface],
   "relative_url": "xyz789",
-  "review_count": 987,
+  "review_count": 123,
   "reviews": ProductReviews,
   "rules": [CatalogRule],
   "sale": 123,
   "short_description": ComplexTextValue,
   "size": 987,
-  "sku": "abc123",
-  "sleeve": "abc123",
+  "sku": "xyz789",
+  "sleeve": "xyz789",
   "small_image": ProductImage,
-  "special_from_date": "abc123",
+  "special_from_date": "xyz789",
   "special_price": 987.65,
   "special_to_date": "abc123",
   "staged": false,
@@ -86111,22 +80372,20 @@ 
Example

   "style_general": "xyz789",
   "swatch_image": "xyz789",
   "thumbnail": ProductImage,
-  "tier_price": 987.65,
+  "tier_price": 123.45,
   "tier_prices": [ProductTierPrices],
   "type": "CMS_PAGE",
   "type_id": "abc123",
-  "uid": 4,
+  "uid": "4",
   "updated_at": "abc123",
   "upsell_products": [ProductInterface],
-  "url_key": "xyz789",
+  "url_key": "abc123",
   "url_path": "xyz789",
   "url_rewrites": [UrlRewrite],
   "url_suffix": "abc123",
   "websites": [Website]
 }
 

-                    
-
back to top @@ -86172,15 +80431,11 @@
Fields
Example
- - - 
{
+                  
{
   "customizable_options": [CustomizableOptionInput],
   "data": CartItemInput
 }
 

-                    
-
back to top @@ -86234,17 +80489,13 @@
Fields
Example
- - - 
{
+                  
{
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
   "quantity": 123.45,
-  "uid": 4
+  "uid": "4"
 }
 

-                    
-
back to top @@ -86308,19 +80559,15 @@
Fields
Example
- - - 
{
-  "added_at": "xyz789",
+                  
{
+  "added_at": "abc123",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "abc123",
-  "id": "4",
+  "description": "xyz789",
+  "id": 4,
   "product": ProductInterface,
   "quantity": 987.65
 }
 

-                    
-
back to top @@ -86390,19 +80637,15 @@
Fields
Example
- - - 
{
-  "code": "abc123",
-  "default_group_id": "xyz789",
+                  
{
+  "code": "xyz789",
+  "default_group_id": "abc123",
   "id": 987,
-  "is_default": true,
+  "is_default": false,
   "name": "xyz789",
-  "sort_order": 123
+  "sort_order": 987
 }
 

-                    
-
back to top @@ -86446,15 +80689,11 @@
Fields
Example
- - - 
{
+                  
{
   "code": "PRODUCT_NOT_FOUND",
-  "message": "xyz789"
+  "message": "abc123"
 }
 

-                    
-
back to top @@ -86502,12 +80741,8 @@
Values
Example
- - - 
"PRODUCT_NOT_FOUND"
+                  
"PRODUCT_NOT_FOUND"
 

-                    
-
back to top @@ -86600,12 +80835,10 @@
pageSize
Example
- - - 
{
+                  
{
   "id": "4",
   "items": [WishlistItem],
-  "items_count": 987,
+  "items_count": 123,
   "items_v2": WishlistItems,
   "name": "xyz789",
   "sharing_code": "abc123",
@@ -86613,8 +80846,6 @@ 
Example

   "visibility": "PUBLIC"
 }
 

-                    
-
back to top @@ -86668,17 +80899,13 @@
Fields
Example
- - - 
{
+                  
{
   "code": "PRODUCT_NOT_FOUND",
   "message": "abc123",
   "wishlistId": "4",
   "wishlistItemId": "4"
 }
 

-                    
-
back to top @@ -86740,12 +80967,8 @@
Values
Example
- - - 
"PRODUCT_NOT_FOUND"
+                  
"PRODUCT_NOT_FOUND"
 

-                    
-
back to top @@ -86804,18 +81027,14 @@
Fields
Example
- - - 
{
+                  
{
   "added_at": "abc123",
-  "description": "xyz789",
-  "id": 123,
+  "description": "abc123",
+  "id": 987,
   "product": ProductInterface,
-  "qty": 987.65
+  "qty": 123.45
 }
 

-                    
-
back to top @@ -86861,15 +81080,11 @@
Fields
Example
- - - 
{
+                  
{
   "quantity": 123.45,
   "wishlist_item_id": "4"
 }
 

-                    
-
back to top @@ -86933,9 +81148,7 @@
Fields
Example
- - - 
{
+                  
{
   "entered_options": [EnteredOptionInput],
   "parent_sku": "abc123",
   "quantity": 123.45,
@@ -86943,8 +81156,6 @@ 
Example

   "sku": "xyz789"
 }
 

-                    
-
back to top @@ -87055,19 +81266,15 @@
Possible Types
Example
- - - 
{
-  "added_at": "abc123",
+                  
{
+  "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "xyz789",
-  "id": "4",
+  "description": "abc123",
+  "id": 4,
   "product": ProductInterface,
   "quantity": 123.45
 }
 

-                    
-
back to top @@ -87113,15 +81320,11 @@
Fields
Example
- - - 
{
-  "quantity": 987.65,
+                  
{
+  "quantity": 123.45,
   "wishlist_item_id": "4"
 }
 

-                    
-
back to top @@ -87185,9 +81388,7 @@
Fields
Example
- - - 
{
+                  
{
   "description": "abc123",
   "entered_options": [EnteredOptionInput],
   "quantity": 987.65,
@@ -87195,8 +81396,6 @@ 
Example

   "wishlist_item_id": 4
 }
 

-                    
-
back to top @@ -87240,15 +81439,11 @@
Fields
Example
- - - 
{
+                  
{
   "items": [WishlistItemInterface],
   "page_info": SearchResultPageInfo
 }
 

-                    
-
back to top @@ -87312,18 +81507,14 @@
Fields
Example
- - - 
{
+                  
{
   "items": [WishlistItem],
   "items_count": 123,
   "name": "abc123",
-  "sharing_code": "abc123",
+  "sharing_code": "xyz789",
   "updated_at": "xyz789"
 }
 

-                    
-
back to top @@ -87371,12 +81562,8 @@
Values
Example
- - - 
"PUBLIC"
+                  
"PUBLIC"
 

-                    
-
back to top @@ -87416,12 +81603,8 @@
Fields
Example
- - - 
{"cart_id": "abc123"}
+                  
{"cart_id": "xyz789"}
 

-                    
-
back to top diff --git a/static/graphql-api/saas/index.html b/static/graphql-api/saas/index.html index ec53d45e6..cb84aaa1a 100644 --- a/static/graphql-api/saas/index.html +++ b/static/graphql-api/saas/index.html @@ -6,7 +6,7 @@ GraphQL API - +
@@ -27,7 +27,6 @@

Introduction

@@ -44,7 +43,9 @@
  • availableStores
  • cart
  • categories
    • +
  • categoryTree
  • checkoutAgreements
    • +
  • commerceOptimizer
  • company
  • compareList
  • countries
    • @@ -74,6 +75,7 @@
  • isCompanyRoleNameAvailable
  • isCompanyUserEmailAvailable
  • isEmailAvailable
    • +
  • navigation
  • negotiableQuote
  • negotiableQuoteTemplate
  • negotiableQuoteTemplates
    • @@ -101,6 +103,7 @@
  • addGiftRegistryRegistrants
  • addProductsToCart
  • addProductsToCompareList
    • +
  • addProductsToNewCart
  • addProductsToRequisitionList
  • addProductsToWishlist
  • addPurchaseOrderComment
    • @@ -124,6 +127,7 @@
  • clearCustomerCart
  • clearWishlist
  • closeNegotiableQuotes
    • +
  • completeOrder
  • confirmCancelOrder
  • confirmEmail
  • confirmReturn
    • @@ -151,6 +155,7 @@
  • deleteCompareList
  • deleteCustomer
  • deleteCustomerAddress
    • +
  • deleteCustomerAddressV2
  • deleteNegotiableQuoteTemplate
  • deleteNegotiableQuotes
  • deletePaymentToken
    • @@ -162,9 +167,12 @@
  • estimateShippingMethods
  • estimateTotals
  • exchangeExternalCustomerToken
    • +
  • exchangeOtpForCustomerToken
    • +
  • finishUpload
  • generateCustomerToken
  • generateCustomerTokenAsAdmin
  • generateNegotiableQuoteFromTemplate
    • +
  • initiateUpload
  • mergeCarts
  • moveCartItemsToGiftRegistry
  • moveItemsBetweenRequisitionLists
    • @@ -172,6 +180,7 @@
  • moveProductsBetweenWishlists
  • openNegotiableQuoteTemplate
  • placeNegotiableQuoteOrder
    • +
  • placeNegotiableQuoteOrderV2
  • placeOrder
  • placeOrderForPurchaseOrder
  • placePurchaseOrder
    • @@ -204,6 +213,7 @@
  • revokeCustomerToken
  • sendNegotiableQuoteForReview
  • setBillingAddressOnCart
    • +
  • setCartAsInactive
  • setCustomAttributesOnCart
  • setCustomAttributesOnCartItem
  • setCustomAttributesOnCompany
    • @@ -221,6 +231,7 @@
  • setNegotiableQuoteShippingMethods
  • setNegotiableQuoteTemplateShippingAddress
  • setPaymentMethodOnCart
    • +
  • setQuoteTemplateExpirationDate
  • setQuoteTemplateLineItemNote
  • setShippingAddressesOnCart
  • setShippingMethodsOnCart
    • @@ -235,6 +246,7 @@
  • updateCompanyTeam
  • updateCompanyUser
  • updateCustomerAddress
    • +
  • updateCustomerAddressV2
  • updateCustomerEmail
  • updateCustomerV2
  • updateGiftRegistry
    • @@ -264,6 +276,7 @@

    Types

  • AddGiftRegistryRegistrantsOutput
  • AddProductsToCartOutput
  • AddProductsToCompareListInput
    • +
  • AddProductsToNewCartOutput
  • AddProductsToRequisitionListOutput
  • AddProductsToWishlistOutput
  • AddPurchaseOrderCommentInput
    • @@ -301,8 +314,10 @@

    Types

  • AssetVideo
  • AssignCompareListToCustomerOutput
  • AttributeEntityTypeEnum
    • +
  • AttributeFile
  • AttributeFilterInput
  • AttributeFrontendInputEnum
    • +
  • AttributeImage
  • AttributeInput
  • AttributeInputSelectedOption
  • AttributeMetadata
    • @@ -374,10 +389,16 @@

    Types

  • CatalogAttributeMetadata
  • CategoryBucket
  • CategoryBucketInterface
    • +
  • CategoryImage
  • CategoryInterface
    • +
  • CategoryMetaTags
    • +
  • CategoryNavigationView
    • +
  • CategoryProductView
  • CategoryTree
    • +
  • CategoryTreeView
  • CategoryView
  • CategoryViewInterface
    • +
  • CategoryViewV2
  • CheckoutAgreement
  • CheckoutAgreementMode
  • CheckoutUserInputError
    • @@ -389,11 +410,13 @@

    Types

  • CloseNegotiableQuotesInput
  • CloseNegotiableQuotesOutput
  • ColorSwatchData
    • +
  • CommerceOptimizerContext
  • CompaniesSortFieldEnum
  • CompaniesSortInput
  • Company
  • CompanyAclResource
  • CompanyAdminInput
    • +
  • CompanyAvailableShippingMethod
  • CompanyBasicInfo
  • CompanyCreateInput
  • CompanyCredit
    • @@ -414,6 +437,7 @@

    Types

  • CompanyRoleUpdateInput
  • CompanyRoles
  • CompanySalesRepresentative
    • +
  • CompanyStatusEnum
  • CompanyStructure
  • CompanyStructureEntity
  • CompanyStructureItem
    • @@ -430,8 +454,10 @@

    Types

  • ComparableAttribute
  • ComparableItem
  • CompareList
    • +
  • CompleteOrderInput
  • ComplexProductView
  • ComplexTextValue
    • +
  • ConditionInput
  • ConfigurableAttributeOption
  • ConfigurableCartItem
  • ConfigurableOptionAvailableForSelection
    • @@ -491,6 +517,8 @@

    Types

  • CustomAttributeMetadataInterface
  • CustomAttributeOptionInterface
  • CustomConfigKeyValue
    • +
  • CustomOperatorInput
    • +
  • CustomOperatorType
  • Customer
  • CustomerAddress
  • CustomerAddressAttribute
    • @@ -580,10 +608,15 @@

    Types

  • ExchangeExternalCustomerTokenInput
  • ExchangeExternalCustomerTokenOutput
  • ExchangeRate
    • +
  • FastlaneConfig
    • +
  • FastlaneMethodInput
    • +
  • Field
  • FilterEqualTypeInput
  • FilterMatchTypeEnum
  • FilterMatchTypeInput
  • FilterRangeTypeInput
    • +
  • FilterRuleInput
    • +
  • FilterRuleType
  • FilterStringTypeInput
  • FilterTypeInput
  • FilterableInSearchAttribute
    • @@ -643,6 +676,7 @@

    Types

  • GuestOrderCancelInput
  • GuestOrderInformationInput
  • Highlight
    • +
  • HistoryItemNoteData
  • HostedFieldsConfig
  • HostedFieldsInput
  • ID
    • @@ -663,6 +697,8 @@

    Types

  • IsCompanyRoleNameAvailableOutput
  • IsCompanyUserEmailAvailableOutput
  • IsEmailAvailableOutput
    • +
  • IsOperatorInput
    • +
  • IsOperatorType
  • ItemNote
  • ItemSelectedBundleOption
  • ItemSelectedBundleOptionValue
    • @@ -670,6 +706,7 @@

    Types

  • KeyValue
  • LineItemNoteInput
  • MediaGalleryInterface
    • +
  • MediaResourceType
  • MessageStyleLogo
  • MessageStyles
  • Money
    • @@ -687,6 +724,8 @@

    Types

  • NegotiableQuoteBillingAddress
  • NegotiableQuoteBillingAddressInput
  • NegotiableQuoteComment
    • +
  • NegotiableQuoteCommentAttachment
    • +
  • NegotiableQuoteCommentAttachmentInput
  • NegotiableQuoteCommentCreatorType
  • NegotiableQuoteCommentInput
  • NegotiableQuoteCustomLogChange
    • @@ -712,6 +751,10 @@

    Types

  • NegotiableQuoteTemplate
  • NegotiableQuoteTemplateFilterInput
  • NegotiableQuoteTemplateGridItem
    • +
  • NegotiableQuoteTemplateHistoryChanges
    • +
  • NegotiableQuoteTemplateHistoryEntry
    • +
  • NegotiableQuoteTemplateHistoryStatusChange
    • +
  • NegotiableQuoteTemplateHistoryStatusesChange
  • NegotiableQuoteTemplateItemQuantityInput
  • NegotiableQuoteTemplateReferenceDocumentLinkInput
  • NegotiableQuoteTemplateShippingAddressInput
    • @@ -723,8 +766,11 @@

    Types

  • NegotiableQuoteUser
  • NegotiableQuotesOutput
  • NoSuchEntityUidError
    • +
  • NumericOperatorInput
    • +
  • NumericOperatorType
  • OopePaymentMethodConfig
  • OpenNegotiableQuoteTemplateInput
    • +
  • OperatorInput
  • Order
  • OrderActionType
  • OrderAddress
    • @@ -757,6 +803,7 @@

    Types

  • PickupLocations
  • PlaceNegotiableQuoteOrderInput
  • PlaceNegotiableQuoteOrderOutput
    • +
  • PlaceNegotiableQuoteOrderOutputV2
  • PlaceOrderError
  • PlaceOrderErrorCodes
  • PlaceOrderForPurchaseOrderInput
    • @@ -787,6 +834,7 @@

    Types

  • ProductSearchItem
  • ProductSearchResponse
  • ProductSearchSortInput
    • +
  • ProductSearchWarning
  • ProductStockStatus
  • ProductVideo
  • ProductView
    • @@ -805,6 +853,10 @@

    Types

  • ProductViewOptionValueSwatch
  • ProductViewPrice
  • ProductViewPriceRange
    • +
  • ProductViewTierCondition
    • +
  • ProductViewTierExactMatchCondition
    • +
  • ProductViewTierPrice
    • +
  • ProductViewTierRangeCondition
  • ProductViewVariant
  • ProductViewVariantResults
  • ProductViewVideo
    • @@ -835,9 +887,13 @@

    Types

  • PurchaseOrdersFilterInput
  • QueryContextInput
  • QuoteItemsSortInput
    • +
  • QuoteTemplateExpirationDateInput
  • QuoteTemplateLineItemNoteInput
  • QuoteTemplateNotificationMessage
  • RangeBucket
    • +
  • RangeOperatorInput
    • +
  • RangeType
    • +
  • RangeValueInput
  • ReCaptchaConfigOutput
  • ReCaptchaConfiguration
  • ReCaptchaConfigurationV3
    • @@ -880,6 +936,8 @@

    Types

  • RequisitionListFilterInput
  • RequisitionListItemInterface
  • RequisitionListItemsInput
    • +
  • RequisitionListSortInput
    • +
  • RequisitionListSortableField
  • RequisitionLists
  • RequistionListItems
  • Return
    • @@ -923,6 +981,7 @@

    Types

  • SendNegotiableQuoteForReviewOutput
  • SetBillingAddressOnCartInput
  • SetBillingAddressOnCartOutput
    • +
  • SetCartAsInactiveOutput
  • SetCustomAttributesOnCompanyInput
  • SetCustomAttributesOnCompanyOutput
  • SetCustomAttributesOnNegotiableQuoteInput
    • @@ -975,6 +1034,8 @@

    Types

  • StatsBucket
  • StoreConfig
  • String
    • +
  • StringOperatorInput
    • +
  • StringOperatorType
  • SubmitNegotiableQuoteTemplateForReviewInput
  • SubscribeEmailToNewsletterOutput
  • SubscriptionStatusesEnum
    • @@ -988,6 +1049,7 @@

    Types

  • TextSwatchData
  • ThreeDSMode
  • TierPrice
    • +
  • UnitConfigInput
  • UpdateCartItemsInput
  • UpdateCartItemsOutput
  • UpdateCompanyOutput
    • @@ -1042,6 +1104,10 @@

    Types

  • WishlistItemUpdateInput
  • WishlistItems
  • WishlistVisibilityEnum
    • +
  • finishUploadInput
    • +
  • finishUploadOutput
    • +
  • initiateUploadInput
    • +
  • initiateUploadOutput
    • @@ -1058,13 +1124,17 @@

    Adobe Commerce as a Cloud Service GraphQL API

    -

    The Adobe Commerce as a Cloud Service GraphQL API allows you to quickly and efficiently transfer information between your Commerce store and your storefront. The schema documented here is autogenerated from a production instance of Adobe Commerce as a Cloud Service. This schema removes all deprecated queries, mutations, and fields from the core schema. It also replaces the core products and categories queries with identically-named queries defined in Catalog Service. If you are migrating to Adobe Commerce as a Cloud Service, you must update your applications to use these queries.

    +

    The Adobe Commerce as a Cloud Service GraphQL API allows you to quickly and efficiently transfer information between your Commerce store and your storefront. The schema documented here is autogenerated from a production instance of Adobe Commerce as a Cloud Service. This schema removes all deprecated queries, mutations, and fields from the core schema. It also replaces the core products and categories queries with identically-named queries defined in Catalog Service. If you are migrating to Adobe Commerce as a Cloud Service, you must update your applications to use these queries. For more information, refer to the GraphQL documentation.

    -
    API Endpoints
    +
    API Endpoint
    https://<location>.api.commerce.adobe.com/<tenant-id>/graphql
    +
    +
    Headers
    +
    For header information, refer to GraphQL headers.
    +
    Version

    SaaS

    @@ -1097,9 +1167,7 @@
    Response

    Example

    Query
    - - - 
    query attributeMetadata {
+                  
    query attributeMetadata {
   attributeMetadata {
     filterableInSearch {
       ...FilterableInSearchAttributeFragment
@@ -1110,14 +1178,10 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "attributeMetadata": {
       "filterableInSearch": [FilterableInSearchAttribute],
@@ -1126,8 +1190,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -1179,9 +1241,7 @@
    Arguments

    Example

    Query
    - - - 
    query attributesForm($formCode: String!) {
+                  
    query attributesForm($formCode: String!) {
   attributesForm(formCode: $formCode) {
     errors {
       ...AttributeMetadataErrorFragment
@@ -1192,23 +1252,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"formCode": "abc123"}
+                  
    {"formCode": "xyz789"}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "attributesForm": {
       "errors": [AttributeMetadataError],
@@ -1217,8 +1269,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -1276,9 +1326,7 @@
    Arguments

    Example

    Query
    - - - 
    query attributesList(
+                  
    query attributesList(
   $entityType: AttributeEntityTypeEnum!,
   $filters: AttributeFilterInput
 ) {
@@ -1295,26 +1343,18 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
+                  
    {
   "entityType": "CATALOG_PRODUCT",
   "filters": AttributeFilterInput
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "attributesList": {
       "errors": [AttributeMetadataError],
@@ -1323,8 +1363,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -1376,10 +1414,9 @@
    Arguments

    Example

    Query
    - - - 
    query availableStores($useCurrentGroup: Boolean) {
+                  
    query availableStores($useCurrentGroup: Boolean) {
   availableStores(useCurrentGroup: $useCurrentGroup) {
+    allow_company_registration
     allow_gift_receipt
     allow_gift_wrapping_on_order
     allow_gift_wrapping_on_order_items
@@ -1394,6 +1431,7 @@ 
    Query
    
     base_url
     cart_expires_in_days
     cart_gift_wrapping
+    cart_merge_preference
     cart_printed_card
     cart_summary_display_quantity
     catalog_default_sort_by
@@ -1409,6 +1447,8 @@ 
    Query
    
     check_money_order_send_check_to
     check_money_order_sort_order
     check_money_order_title
+    company_credit_enabled
+    company_enabled
     configurable_product_image
     configurable_thumbnail_source
     contact_enabled
@@ -1480,6 +1520,8 @@ 
    Query
    
     product_fixed_product_tax_display_setting
     product_url_suffix
     quickorder_active
+    quote_minimum_amount
+    quote_minimum_amount_message
     required_character_classes_number
     returns_enabled
     root_category_uid
@@ -1520,168 +1562,164 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"useCurrentGroup": true}
+                  
    {"useCurrentGroup": true}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "availableStores": [
       {
-        "allow_gift_receipt": "xyz789",
-        "allow_gift_wrapping_on_order": "xyz789",
-        "allow_gift_wrapping_on_order_items": "xyz789",
-        "allow_items": "xyz789",
+        "allow_company_registration": false,
+        "allow_gift_receipt": "abc123",
+        "allow_gift_wrapping_on_order": "abc123",
+        "allow_gift_wrapping_on_order_items": "abc123",
+        "allow_items": "abc123",
         "allow_order": "xyz789",
-        "allow_printed_card": "xyz789",
+        "allow_printed_card": "abc123",
         "autocomplete_on_storefront": true,
-        "base_currency_code": "abc123",
+        "base_currency_code": "xyz789",
         "base_link_url": "abc123",
         "base_media_url": "abc123",
-        "base_static_url": "abc123",
+        "base_static_url": "xyz789",
         "base_url": "xyz789",
         "cart_expires_in_days": 123,
         "cart_gift_wrapping": "abc123",
+        "cart_merge_preference": "xyz789",
         "cart_printed_card": "abc123",
         "cart_summary_display_quantity": 123,
-        "catalog_default_sort_by": "xyz789",
+        "catalog_default_sort_by": "abc123",
         "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-        "category_url_suffix": "abc123",
+        "category_url_suffix": "xyz789",
         "check_money_order_enable_for_specific_countries": false,
         "check_money_order_enabled": false,
-        "check_money_order_make_check_payable_to": "xyz789",
+        "check_money_order_make_check_payable_to": "abc123",
         "check_money_order_max_order_total": "xyz789",
         "check_money_order_min_order_total": "xyz789",
         "check_money_order_new_order_status": "abc123",
-        "check_money_order_payment_from_specific_countries": "abc123",
+        "check_money_order_payment_from_specific_countries": "xyz789",
         "check_money_order_send_check_to": "xyz789",
         "check_money_order_sort_order": 123,
         "check_money_order_title": "xyz789",
+        "company_credit_enabled": true,
+        "company_enabled": true,
         "configurable_product_image": "ITSELF",
-        "configurable_thumbnail_source": "xyz789",
-        "contact_enabled": true,
-        "countries_with_required_region": "xyz789",
-        "create_account_confirmation": true,
+        "configurable_thumbnail_source": "abc123",
+        "contact_enabled": false,
+        "countries_with_required_region": "abc123",
+        "create_account_confirmation": false,
         "customer_access_token_lifetime": 987.65,
-        "default_country": "abc123",
-        "default_display_currency_code": "abc123",
+        "default_country": "xyz789",
+        "default_display_currency_code": "xyz789",
         "display_product_prices_in_catalog": 123,
-        "display_shipping_prices": 987,
+        "display_shipping_prices": 123,
         "display_state_if_optional": true,
-        "enable_multiple_wishlists": "abc123",
+        "enable_multiple_wishlists": "xyz789",
         "fixed_product_taxes_apply_tax_to_fpt": true,
-        "fixed_product_taxes_display_prices_in_emails": 123,
+        "fixed_product_taxes_display_prices_in_emails": 987,
         "fixed_product_taxes_display_prices_in_product_lists": 987,
-        "fixed_product_taxes_display_prices_in_sales_modules": 987,
+        "fixed_product_taxes_display_prices_in_sales_modules": 123,
         "fixed_product_taxes_display_prices_on_product_view_page": 987,
-        "fixed_product_taxes_enable": false,
-        "fixed_product_taxes_include_fpt_in_subtotal": false,
-        "graphql_share_customer_group": false,
+        "fixed_product_taxes_enable": true,
+        "fixed_product_taxes_include_fpt_in_subtotal": true,
+        "graphql_share_customer_group": true,
         "grid_per_page": 123,
         "grid_per_page_values": "abc123",
         "grouped_product_image": "ITSELF",
-        "is_checkout_agreements_enabled": true,
+        "is_checkout_agreements_enabled": false,
         "is_default_store": true,
-        "is_default_store_group": false,
+        "is_default_store_group": true,
         "is_guest_checkout_enabled": false,
-        "is_negotiable_quote_active": false,
+        "is_negotiable_quote_active": true,
         "is_one_page_checkout_enabled": false,
-        "is_requisition_list_active": "xyz789",
-        "list_mode": "xyz789",
-        "list_per_page": 123,
-        "list_per_page_values": "abc123",
-        "locale": "abc123",
-        "magento_reward_general_is_enabled": "abc123",
+        "is_requisition_list_active": "abc123",
+        "list_mode": "abc123",
+        "list_per_page": 987,
+        "list_per_page_values": "xyz789",
+        "locale": "xyz789",
+        "magento_reward_general_is_enabled": "xyz789",
         "magento_reward_general_is_enabled_on_front": "abc123",
         "magento_reward_general_min_points_balance": "xyz789",
         "magento_reward_general_publish_history": "xyz789",
         "magento_reward_points_invitation_customer": "xyz789",
         "magento_reward_points_invitation_customer_limit": "xyz789",
-        "magento_reward_points_invitation_order": "xyz789",
+        "magento_reward_points_invitation_order": "abc123",
         "magento_reward_points_invitation_order_limit": "abc123",
         "magento_reward_points_newsletter": "abc123",
-        "magento_reward_points_order": "abc123",
-        "magento_reward_points_register": "xyz789",
+        "magento_reward_points_order": "xyz789",
+        "magento_reward_points_register": "abc123",
         "magento_reward_points_review": "xyz789",
-        "magento_reward_points_review_limit": "abc123",
+        "magento_reward_points_review_limit": "xyz789",
         "magento_wishlist_general_is_enabled": "abc123",
-        "max_items_in_order_summary": 123,
-        "maximum_number_of_wishlists": "xyz789",
-        "minicart_display": false,
-        "minicart_max_items": 123,
+        "max_items_in_order_summary": 987,
+        "maximum_number_of_wishlists": "abc123",
+        "minicart_display": true,
+        "minicart_max_items": 987,
         "minimum_password_length": "xyz789",
         "newsletter_enabled": true,
         "optional_zip_countries": "abc123",
-        "order_cancellation_enabled": false,
+        "order_cancellation_enabled": true,
         "order_cancellation_reasons": [
           CancellationReason
         ],
-        "orders_invoices_credit_memos_display_full_summary": true,
-        "orders_invoices_credit_memos_display_grandtotal": false,
+        "orders_invoices_credit_memos_display_full_summary": false,
+        "orders_invoices_credit_memos_display_grandtotal": true,
         "orders_invoices_credit_memos_display_price": 123,
-        "orders_invoices_credit_memos_display_shipping_amount": 987,
-        "orders_invoices_credit_memos_display_subtotal": 123,
+        "orders_invoices_credit_memos_display_shipping_amount": 123,
+        "orders_invoices_credit_memos_display_subtotal": 987,
         "orders_invoices_credit_memos_display_zero_tax": false,
         "printed_card_priceV2": Money,
         "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
         "product_url_suffix": "abc123",
-        "quickorder_active": true,
+        "quickorder_active": false,
+        "quote_minimum_amount": 987.65,
+        "quote_minimum_amount_message": "abc123",
         "required_character_classes_number": "abc123",
-        "returns_enabled": "abc123",
-        "root_category_uid": 4,
+        "returns_enabled": "xyz789",
+        "root_category_uid": "4",
         "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
         "sales_gift_wrapping": "xyz789",
-        "sales_printed_card": "abc123",
+        "sales_printed_card": "xyz789",
         "secure_base_link_url": "xyz789",
         "secure_base_media_url": "xyz789",
-        "secure_base_static_url": "abc123",
+        "secure_base_static_url": "xyz789",
         "secure_base_url": "abc123",
         "share_active_segments": true,
         "share_applied_cart_rule": false,
-        "shopping_cart_display_full_summary": true,
-        "shopping_cart_display_grand_total": true,
+        "shopping_cart_display_full_summary": false,
+        "shopping_cart_display_grand_total": false,
         "shopping_cart_display_price": 123,
         "shopping_cart_display_shipping": 987,
-        "shopping_cart_display_subtotal": 987,
+        "shopping_cart_display_subtotal": 123,
         "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
         "shopping_cart_display_zero_tax": true,
-        "store_code": 4,
+        "store_code": "4",
         "store_group_code": "4",
-        "store_group_name": "xyz789",
+        "store_group_name": "abc123",
         "store_name": "xyz789",
         "store_sort_order": 123,
-        "timezone": "abc123",
+        "timezone": "xyz789",
         "title_separator": "xyz789",
         "use_store_in_url": true,
-        "website_code": 4,
+        "website_code": "4",
         "website_name": "abc123",
-        "weight_unit": "xyz789",
-        "zero_subtotal_enable_for_specific_countries": false,
-        "zero_subtotal_enabled": true,
+        "weight_unit": "abc123",
+        "zero_subtotal_enable_for_specific_countries": true,
+        "zero_subtotal_enabled": false,
         "zero_subtotal_new_order_status": "xyz789",
         "zero_subtotal_payment_action": "xyz789",
-        "zero_subtotal_payment_from_specific_countries": "abc123",
-        "zero_subtotal_sort_order": 123,
-        "zero_subtotal_title": "abc123"
+        "zero_subtotal_payment_from_specific_countries": "xyz789",
+        "zero_subtotal_sort_order": 987,
+        "zero_subtotal_title": "xyz789"
       }
     ]
   }
 }
 
    
-                    
-
    back to top @@ -1733,9 +1771,7 @@
    Arguments

    Example

    Query
    - - - 
    query cart($cart_id: String!) {
+                  
    query cart($cart_id: String!) {
   cart(cart_id: $cart_id) {
     applied_coupons {
       ...AppliedCouponFragment
@@ -1791,23 +1827,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"cart_id": "xyz789"}
+                  
    {"cart_id": "xyz789"}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "cart": {
       "applied_coupons": [AppliedCoupon],
@@ -1822,23 +1850,21 @@ 
    Response
    
       "custom_attributes": [CustomAttribute],
       "email": "xyz789",
       "gift_message": GiftMessage,
-      "gift_receipt_included": false,
+      "gift_receipt_included": true,
       "gift_wrapping": GiftWrapping,
-      "id": 4,
+      "id": "4",
       "is_virtual": true,
       "itemsV2": CartItems,
       "prices": CartPrices,
-      "printed_card_included": false,
+      "printed_card_included": true,
       "rules": [CartRuleStorefront],
       "selected_payment_method": SelectedPaymentMethod,
       "shipping_addresses": [ShippingCartAddress],
-      "total_quantity": 987.65
+      "total_quantity": 123.45
     }
   }
 }
 
    
-                    
-
    back to top @@ -1904,9 +1930,7 @@
    Arguments

    Example

    Query
    - - - 
    query categories(
+                  
    query categories(
   $ids: [String!],
   $roles: [String!],
   $subtree: Subtree
@@ -1932,50 +1956,160 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {
+                  
    {
   "ids": ["xyz789"],
   "roles": ["xyz789"],
   "subtree": Subtree
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "categories": [
       {
-        "availableSortBy": ["abc123"],
-        "children": ["xyz789"],
+        "availableSortBy": ["xyz789"],
+        "children": ["abc123"],
         "defaultSortBy": "abc123",
-        "id": 4,
+        "id": "4",
         "level": 987,
         "name": "abc123",
-        "parentId": "xyz789",
-        "path": "xyz789",
-        "roles": ["abc123"],
+        "parentId": "abc123",
+        "path": "abc123",
+        "roles": ["xyz789"],
         "urlKey": "abc123",
-        "urlPath": "xyz789",
-        "count": 123,
-        "title": "abc123"
+        "urlPath": "abc123",
+        "count": 987,
+        "title": "xyz789"
+      }
+    ]
+  }
+}
+
    
+
    + + back to top + + +
    +
    + Queries +
    +

    + categoryTree +

    +
    +
    +
    +
    Description
    +

    Retrieves category tree nodes, optionally filtered by slugs and limited by depth.

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns [CategoryTreeView] +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + + + + + + + + + +
    NameDescription
    + family - String! + +
    + slugs - [String!] + +
    + depth - Int + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    + 
    query categoryTree(
+  $family: String!,
+  $slugs: [String!],
+  $depth: Int
+) {
+  categoryTree(
+    family: $family,
+    slugs: $slugs,
+    depth: $depth
+  ) {
+    slug
+    name
+    description
+    metaTags {
+      ...CategoryMetaTagsFragment
+    }
+    images {
+      ...CategoryImageFragment
+    }
+    level
+    parentSlug
+    childrenSlugs
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {
+  "family": "abc123",
+  "slugs": ["abc123"],
+  "depth": 987
+}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "categoryTree": [
+      {
+        "slug": "xyz789",
+        "name": "abc123",
+        "description": "abc123",
+        "metaTags": CategoryMetaTags,
+        "images": [CategoryImage],
+        "level": 987,
+        "parentSlug": "xyz789",
+        "childrenSlugs": ["xyz789"]
       }
     ]
   }
 }
    - -
    back to top @@ -2008,9 +2142,7 @@
    Response

    Example

    Query
    - - - 
    query checkoutAgreements {
+                  
    query checkoutAgreements {
   checkoutAgreements {
     agreement_id
     checkbox_text
@@ -2022,31 +2154,68 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "checkoutAgreements": [
       {
-        "agreement_id": 987,
+        "agreement_id": 123,
         "checkbox_text": "abc123",
-        "content": "xyz789",
+        "content": "abc123",
         "content_height": "abc123",
-        "is_html": false,
+        "is_html": true,
         "mode": "AUTO",
-        "name": "xyz789"
+        "name": "abc123"
       }
     ]
   }
 }
 
    
-                    
-                  
+
    +
    + back to top + +
    +
    +
    + Queries +
    +

    + commerceOptimizer +

    +
    +
    +
    +
    Description
    +

    Provide necessary information to build headless storefront when Adobe Commerce is connected to Commerce Optimizer.

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a CommerceOptimizerContext! +

    +
    +
    +
    +

    Example

    +
    +
    Query
    + 
    query commerceOptimizer {
+  commerceOptimizer {
+    priceBookId
+  }
+}
+
    +
    +
    +
    Response
    + 
    {"data": {"commerceOptimizer": {"priceBookId": 4}}}
+
    back to top @@ -2079,13 +2248,17 @@
    Response

    Example

    Query
    - - - 
    query company {
+                  
    query company {
   company {
     acl_resources {
       ...CompanyAclResourceFragment
     }
+    available_payment_methods {
+      ...AvailablePaymentMethodFragment
+    }
+    available_shipping_methods {
+      ...CompanyAvailableShippingMethodFragment
+    }
     company_admin {
       ...CustomerFragment
     }
@@ -2116,6 +2289,7 @@ 
    Query
    
     sales_representative {
       ...CompanySalesRepresentativeFragment
     }
+    status
     structure {
       ...CompanyStructureFragment
     }
@@ -2132,42 +2306,43 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "company": {
       "acl_resources": [CompanyAclResource],
+      "available_payment_methods": [
+        AvailablePaymentMethod
+      ],
+      "available_shipping_methods": [
+        CompanyAvailableShippingMethod
+      ],
       "company_admin": Customer,
       "credit": CompanyCredit,
       "credit_history": CompanyCreditHistory,
       "custom_attributes": [CustomAttribute],
-      "email": "abc123",
+      "email": "xyz789",
       "id": 4,
       "legal_address": CompanyLegalAddress,
       "legal_name": "abc123",
-      "name": "xyz789",
-      "payment_methods": ["abc123"],
-      "reseller_id": "abc123",
+      "name": "abc123",
+      "payment_methods": ["xyz789"],
+      "reseller_id": "xyz789",
       "role": CompanyRole,
       "roles": CompanyRoles,
       "sales_representative": CompanySalesRepresentative,
+      "status": "PENDING",
       "structure": CompanyStructure,
       "team": CompanyTeam,
       "user": Customer,
       "users": CompanyUsers,
-      "vat_tax_id": "abc123"
+      "vat_tax_id": "xyz789"
     }
   }
 }
 
    
-                    
-
    back to top @@ -2219,9 +2394,7 @@
    Arguments

    Example

    Query
    - - - 
    query compareList($uid: ID!) {
+                  
    query compareList($uid: ID!) {
   compareList(uid: $uid) {
     attributes {
       ...ComparableAttributeFragment
@@ -2234,35 +2407,25 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"uid": 4}
+                  
    {"uid": "4"}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "compareList": {
       "attributes": [ComparableAttribute],
-      "item_count": 123,
+      "item_count": 987,
       "items": [ComparableItem],
-      "uid": 4
+      "uid": "4"
     }
   }
 }
 
    
-                    
-
    back to top @@ -2295,9 +2458,7 @@
    Response

    Example

    Query
    - - - 
    query countries {
+                  
    query countries {
   countries {
     available_regions {
       ...RegionFragment
@@ -2310,30 +2471,24 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "countries": [
       {
         "available_regions": [Region],
-        "full_name_english": "xyz789",
-        "full_name_locale": "xyz789",
-        "id": "xyz789",
-        "three_letter_abbreviation": "xyz789",
+        "full_name_english": "abc123",
+        "full_name_locale": "abc123",
+        "id": "abc123",
+        "three_letter_abbreviation": "abc123",
         "two_letter_abbreviation": "abc123"
       }
     ]
   }
 }
 
    
-                    
-
    back to top @@ -2386,9 +2541,7 @@
    Arguments

    Example

    Query
    - - - 
    query country($id: String) {
+                  
    query country($id: String) {
   country(id: $id) {
     available_regions {
       ...RegionFragment
@@ -2401,37 +2554,27 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"id": "xyz789"}
+                  
    {"id": "xyz789"}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "country": {
       "available_regions": [Region],
       "full_name_english": "xyz789",
       "full_name_locale": "xyz789",
-      "id": "xyz789",
-      "three_letter_abbreviation": "abc123",
+      "id": "abc123",
+      "three_letter_abbreviation": "xyz789",
       "two_letter_abbreviation": "xyz789"
     }
   }
 }
 
    
-                    
-
    back to top @@ -2464,9 +2607,7 @@
    Response

    Example

    Query
    - - - 
    query currency {
+                  
    query currency {
   currency {
     available_currency_codes
     base_currency_code
@@ -2479,20 +2620,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "currency": {
       "available_currency_codes": [
-        "abc123"
+        "xyz789"
       ],
-      "base_currency_code": "abc123",
+      "base_currency_code": "xyz789",
       "base_currency_symbol": "xyz789",
       "default_display_currency_code": "xyz789",
       "default_display_currency_symbol": "abc123",
@@ -2501,8 +2638,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -2555,9 +2690,7 @@
    Arguments

    Example

    Query
    - - - 
    query customAttributeMetadataV2($attributes: [AttributeInput!]) {
+                  
    query customAttributeMetadataV2($attributes: [AttributeInput!]) {
   customAttributeMetadataV2(attributes: $attributes) {
     errors {
       ...AttributeMetadataErrorFragment
@@ -2568,23 +2701,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"attributes": [AttributeInput]}
+                  
    {"attributes": [AttributeInput]}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "customAttributeMetadataV2": {
       "errors": [AttributeMetadataError],
@@ -2593,8 +2718,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -2627,9 +2750,7 @@
    Response

    Example

    Query
    - - - 
    query customer {
+                  
    query customer {
   customer {
     addresses {
       ...CustomerAddressFragment
@@ -2664,6 +2785,7 @@ 
    Query
    
     group {
       ...CustomerGroupStorefrontFragment
     }
+    id
     is_subscribed
     job_title
     lastname
@@ -2688,6 +2810,7 @@ 
    Query
    
       ...PurchaseOrdersFragment
     }    
     purchase_orders_enabled
+    quote_enabled
     requisition_lists {
       ...RequisitionListsFragment
     }
@@ -2726,45 +2849,43 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "customer": {
       "addresses": [CustomerAddress],
       "addressesV2": CustomerAddresses,
-      "allow_remote_shopping_assistance": false,
+      "allow_remote_shopping_assistance": true,
       "companies": UserCompaniesOutput,
       "compare_list": CompareList,
       "confirmation_status": "ACCOUNT_CONFIRMED",
-      "created_at": "abc123",
+      "created_at": "xyz789",
       "custom_attributes": [AttributeValueInterface],
       "date_of_birth": "xyz789",
-      "default_billing": "abc123",
+      "default_billing": "xyz789",
       "default_shipping": "abc123",
-      "email": "xyz789",
+      "email": "abc123",
       "firstname": "abc123",
-      "gender": 987,
+      "gender": 123,
       "gift_registries": [GiftRegistry],
       "gift_registry": GiftRegistry,
       "group": CustomerGroupStorefront,
+      "id": 4,
       "is_subscribed": false,
-      "job_title": "abc123",
+      "job_title": "xyz789",
       "lastname": "xyz789",
       "middlename": "abc123",
       "orders": CustomerOrders,
-      "prefix": "xyz789",
+      "prefix": "abc123",
       "purchase_order": PurchaseOrder,
       "purchase_order_approval_rule": PurchaseOrderApprovalRule,
       "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
       "purchase_order_approval_rules": PurchaseOrderApprovalRules,
       "purchase_orders": PurchaseOrders,
       "purchase_orders_enabled": false,
+      "quote_enabled": false,
       "requisition_lists": RequisitionLists,
       "return": Return,
       "returns": Returns,
@@ -2774,18 +2895,16 @@ 
    Response
    
       "status": "ACTIVE",
       "store_credit": CustomerStoreCredit,
       "structure_id": 4,
-      "suffix": "abc123",
+      "suffix": "xyz789",
       "taxvat": "abc123",
       "team": CompanyTeam,
-      "telephone": "xyz789",
+      "telephone": "abc123",
       "wishlist_v2": Wishlist,
       "wishlists": [Wishlist]
     }
   }
 }
 
    
-                    
-
    back to top @@ -2818,9 +2937,7 @@
    Response

    Example

    Query
    - - - 
    query customerCart {
+                  
    query customerCart {
   customerCart {
     applied_coupons {
       ...AppliedCouponFragment
@@ -2876,14 +2993,10 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "customerCart": {
       "applied_coupons": [AppliedCoupon],
@@ -2898,23 +3011,21 @@ 
    Response
    
       "custom_attributes": [CustomAttribute],
       "email": "xyz789",
       "gift_message": GiftMessage,
-      "gift_receipt_included": false,
+      "gift_receipt_included": true,
       "gift_wrapping": GiftWrapping,
       "id": 4,
-      "is_virtual": true,
+      "is_virtual": false,
       "itemsV2": CartItems,
       "prices": CartPrices,
-      "printed_card_included": false,
+      "printed_card_included": true,
       "rules": [CartRuleStorefront],
       "selected_payment_method": SelectedPaymentMethod,
       "shipping_addresses": [ShippingCartAddress],
-      "total_quantity": 987.65
+      "total_quantity": 123.45
     }
   }
 }
 
    
-                    
-
    back to top @@ -2947,9 +3058,7 @@
    Response

    Example

    Query
    - - - 
    query customerDownloadableProducts {
+                  
    query customerDownloadableProducts {
   customerDownloadableProducts {
     items {
       ...CustomerDownloadableProductFragment
@@ -2957,14 +3066,10 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "customerDownloadableProducts": {
       "items": [CustomerDownloadableProduct]
@@ -2972,8 +3077,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -3006,25 +3109,17 @@
    Response

    Example

    Query
    - - - 
    query customerGroup {
+                  
    query customerGroup {
   customerGroup {
     uid
   }
 }
 
    
-                    
-
    Response
    - - - 
    {"data": {"customerGroup": {"uid": 4}}}
+                  
    {"data": {"customerGroup": {"uid": 4}}}
 
    
-                    
-
    back to top @@ -3057,9 +3152,7 @@
    Response

    Example

    Query
    - - - 
    query customerPaymentTokens {
+                  
    query customerPaymentTokens {
   customerPaymentTokens {
     items {
       ...PaymentTokenFragment
@@ -3067,21 +3160,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "customerPaymentTokens": {"items": [PaymentToken]}
   }
 }
 
    
-                    
-
    back to top @@ -3133,38 +3220,26 @@
    Arguments

    Example

    Query
    - - - 
    query customerSegments($cartId: String!) {
+                  
    query customerSegments($cartId: String!) {
   customerSegments(cartId: $cartId) {
     uid
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"cartId": "xyz789"}
+                  
    {"cartId": "abc123"}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "customerSegments": [{"uid": "4"}]
   }
 }
 
    
-                    
-
    back to top @@ -3216,13 +3291,14 @@
    Arguments

    Example

    Query
    - - - 
    query getPaymentConfig($location: PaymentLocation!) {
+                  
    query getPaymentConfig($location: PaymentLocation!) {
   getPaymentConfig(location: $location) {
     apple_pay {
       ...ApplePayConfigFragment
     }
+    fastlane {
+      ...FastlaneConfigFragment
+    }
     google_pay {
       ...GooglePayConfigFragment
     }
@@ -3235,26 +3311,19 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"location": "PRODUCT_DETAIL"}
+                  
    {"location": "PRODUCT_DETAIL"}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "getPaymentConfig": {
       "apple_pay": ApplePayConfig,
+      "fastlane": FastlaneConfig,
       "google_pay": GooglePayConfig,
       "hosted_fields": HostedFieldsConfig,
       "smart_buttons": SmartButtonsConfig
@@ -3262,8 +3331,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -3321,9 +3388,7 @@
    Arguments

    Example

    Query
    - - - 
    query getPaymentOrder(
+                  
    query getPaymentOrder(
   $cartId: String!,
   $id: String!
 ) {
@@ -3340,26 +3405,18 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
-  "cartId": "xyz789",
+                  
    {
+  "cartId": "abc123",
   "id": "abc123"
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "getPaymentOrder": {
       "id": "abc123",
@@ -3370,8 +3427,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -3423,9 +3478,7 @@
    Arguments

    Example

    Query
    - - - 
    query getPaymentSDK($location: PaymentLocation!) {
+                  
    query getPaymentSDK($location: PaymentLocation!) {
   getPaymentSDK(location: $location) {
     sdkParams {
       ...PaymentSDKParamsItemFragment
@@ -3433,30 +3486,20 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"location": "PRODUCT_DETAIL"}
+                  
    {"location": "PRODUCT_DETAIL"}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "getPaymentSDK": {"sdkParams": [PaymentSDKParamsItem]}
   }
 }
 
    
-                    
-
    back to top @@ -3489,9 +3532,7 @@
    Response

    Example

    Query
    - - - 
    query getVaultConfig {
+                  
    query getVaultConfig {
   getVaultConfig {
     credit_card {
       ...VaultCreditCardConfigFragment
@@ -3499,14 +3540,10 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "getVaultConfig": {
       "credit_card": VaultCreditCardConfig
@@ -3514,8 +3551,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -3567,9 +3602,7 @@
    Arguments

    Example

    Query
    - - - 
    query giftCardAccount($input: GiftCardAccountInput!) {
+                  
    query giftCardAccount($input: GiftCardAccountInput!) {
   giftCardAccount(input: $input) {
     balance {
       ...MoneyFragment
@@ -3579,23 +3612,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": GiftCardAccountInput}
+                  
    {"input": GiftCardAccountInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "giftCardAccount": {
       "balance": Money,
@@ -3605,8 +3630,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -3658,9 +3681,7 @@
    Arguments

    Example

    Query
    - - - 
    query giftRegistry($giftRegistryUid: ID!) {
+                  
    query giftRegistry($giftRegistryUid: ID!) {
   giftRegistry(giftRegistryUid: $giftRegistryUid) {
     created_at
     dynamic_attributes {
@@ -3687,23 +3708,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"giftRegistryUid": "4"}
+                  
    {"giftRegistryUid": 4}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "giftRegistry": {
       "created_at": "xyz789",
@@ -3713,19 +3726,17 @@ 
    Response
    
       "event_name": "xyz789",
       "items": [GiftRegistryItemInterface],
       "message": "abc123",
-      "owner_name": "abc123",
+      "owner_name": "xyz789",
       "privacy_settings": "PRIVATE",
       "registrants": [GiftRegistryRegistrant],
       "shipping_address": CustomerAddress,
       "status": "ACTIVE",
       "type": GiftRegistryType,
-      "uid": 4
+      "uid": "4"
     }
   }
 }
 
    
-                    
-
    back to top @@ -3777,9 +3788,7 @@
    Arguments

    Example

    Query
    - - - 
    query giftRegistryEmailSearch($email: String!) {
+                  
    query giftRegistryEmailSearch($email: String!) {
   giftRegistryEmailSearch(email: $email) {
     event_date
     event_title
@@ -3790,39 +3799,29 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"email": "xyz789"}
+                  
    {"email": "abc123"}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "giftRegistryEmailSearch": [
       {
         "event_date": "xyz789",
-        "event_title": "xyz789",
-        "gift_registry_uid": "4",
+        "event_title": "abc123",
+        "gift_registry_uid": 4,
         "location": "abc123",
-        "name": "xyz789",
-        "type": "abc123"
+        "name": "abc123",
+        "type": "xyz789"
       }
     ]
   }
 }
 
    
-                    
-
    back to top @@ -3874,9 +3873,7 @@
    Arguments

    Example

    Query
    - - - 
    query giftRegistryIdSearch($giftRegistryUid: ID!) {
+                  
    query giftRegistryIdSearch($giftRegistryUid: ID!) {
   giftRegistryIdSearch(giftRegistryUid: $giftRegistryUid) {
     event_date
     event_title
@@ -3887,29 +3884,21 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"giftRegistryUid": "4"}
+                  
    {"giftRegistryUid": "4"}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "giftRegistryIdSearch": [
       {
         "event_date": "xyz789",
-        "event_title": "abc123",
-        "gift_registry_uid": 4,
+        "event_title": "xyz789",
+        "gift_registry_uid": "4",
         "location": "abc123",
         "name": "xyz789",
         "type": "xyz789"
@@ -3918,8 +3907,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -3983,9 +3970,7 @@
    Arguments

    Example

    Query
    - - - 
    query giftRegistryTypeSearch(
+                  
    query giftRegistryTypeSearch(
   $firstName: String!,
   $lastName: String!,
   $giftRegistryTypeUid: ID
@@ -4004,43 +3989,33 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
+                  
    {
   "firstName": "abc123",
   "lastName": "abc123",
-  "giftRegistryTypeUid": "4"
+  "giftRegistryTypeUid": 4
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "giftRegistryTypeSearch": [
       {
         "event_date": "xyz789",
         "event_title": "xyz789",
-        "gift_registry_uid": 4,
+        "gift_registry_uid": "4",
         "location": "abc123",
         "name": "xyz789",
-        "type": "xyz789"
+        "type": "abc123"
       }
     ]
   }
 }
 
    
-                    
-
    back to top @@ -4073,9 +4048,7 @@
    Response

    Example

    Query
    - - - 
    query giftRegistryTypes {
+                  
    query giftRegistryTypes {
   giftRegistryTypes {
     dynamic_attributes_metadata {
       ...GiftRegistryDynamicAttributeMetadataInterfaceFragment
@@ -4085,29 +4058,23 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "giftRegistryTypes": [
       {
         "dynamic_attributes_metadata": [
           GiftRegistryDynamicAttributeMetadataInterface
         ],
-        "label": "xyz789",
-        "uid": "4"
+        "label": "abc123",
+        "uid": 4
       }
     ]
   }
 }
 
    
-                    
-
    back to top @@ -4160,9 +4127,7 @@
    Arguments

    Example

    Query
    - - - 
    query guestOrder($input: GuestOrderInformationInput!) {
+                  
    query guestOrder($input: GuestOrderInformationInput!) {
   guestOrder(input: $input) {
     applied_coupons {
       ...AppliedCouponFragment
@@ -4206,6 +4171,9 @@ 
    Query
    
     items_eligible_for_return {
       ...OrderItemInterfaceFragment
     }
+    negotiable_quote {
+      ...NegotiableQuoteFragment
+    }
     number
     order_date
     order_status_change_date
@@ -4231,23 +4199,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": GuestOrderInformationInput}
+                  
    {"input": GuestOrderInformationInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "guestOrder": {
       "applied_coupons": [AppliedCoupon],
@@ -4263,14 +4223,15 @@ 
    Response
    
       "gift_message": GiftMessage,
       "gift_receipt_included": false,
       "gift_wrapping": GiftWrapping,
-      "id": 4,
+      "id": "4",
       "invoices": [Invoice],
       "is_virtual": true,
       "items": [OrderItemInterface],
       "items_eligible_for_return": [OrderItemInterface],
+      "negotiable_quote": NegotiableQuote,
       "number": "abc123",
-      "order_date": "abc123",
-      "order_status_change_date": "xyz789",
+      "order_date": "xyz789",
+      "order_status_change_date": "abc123",
       "payment_methods": [OrderPaymentMethod],
       "printed_card_included": true,
       "returns": Returns,
@@ -4284,8 +4245,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -4338,9 +4297,7 @@
    Arguments

    Example

    Query
    - - - 
    query guestOrderByToken($input: OrderTokenInput!) {
+                  
    query guestOrderByToken($input: OrderTokenInput!) {
   guestOrderByToken(input: $input) {
     applied_coupons {
       ...AppliedCouponFragment
@@ -4384,6 +4341,9 @@ 
    Query
    
     items_eligible_for_return {
       ...OrderItemInterfaceFragment
     }
+    negotiable_quote {
+      ...NegotiableQuoteFragment
+    }
     number
     order_date
     order_status_change_date
@@ -4409,23 +4369,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": OrderTokenInput}
+                  
    {"input": OrderTokenInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "guestOrderByToken": {
       "applied_coupons": [AppliedCoupon],
@@ -4439,31 +4391,30 @@ 
    Response
    
       "customer_info": OrderCustomerInfo,
       "email": "xyz789",
       "gift_message": GiftMessage,
-      "gift_receipt_included": false,
+      "gift_receipt_included": true,
       "gift_wrapping": GiftWrapping,
-      "id": "4",
+      "id": 4,
       "invoices": [Invoice],
-      "is_virtual": true,
+      "is_virtual": false,
       "items": [OrderItemInterface],
       "items_eligible_for_return": [OrderItemInterface],
+      "negotiable_quote": NegotiableQuote,
       "number": "xyz789",
-      "order_date": "abc123",
+      "order_date": "xyz789",
       "order_status_change_date": "abc123",
       "payment_methods": [OrderPaymentMethod],
-      "printed_card_included": false,
+      "printed_card_included": true,
       "returns": Returns,
       "shipments": [OrderShipment],
       "shipping_address": OrderAddress,
       "shipping_method": "xyz789",
-      "status": "xyz789",
+      "status": "abc123",
       "token": "abc123",
       "total": OrderTotal
     }
   }
 }
 
    
-                    
-
    back to top @@ -4516,34 +4467,22 @@
    Arguments

    Example

    Query
    - - - 
    query isCompanyAdminEmailAvailable($email: String!) {
+                  
    query isCompanyAdminEmailAvailable($email: String!) {
   isCompanyAdminEmailAvailable(email: $email) {
     is_email_available
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"email": "xyz789"}
+                  
    {"email": "abc123"}
 
    
-                    
-
    Response
    - - - 
    {"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}}
+                  
    {"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}}
 
    
-                    
-
    back to top @@ -4596,34 +4535,22 @@
    Arguments

    Example

    Query
    - - - 
    query isCompanyEmailAvailable($email: String!) {
+                  
    query isCompanyEmailAvailable($email: String!) {
   isCompanyEmailAvailable(email: $email) {
     is_email_available
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"email": "xyz789"}
+                  
    {"email": "abc123"}
 
    
-                    
-
    Response
    - - - 
    {"data": {"isCompanyEmailAvailable": {"is_email_available": false}}}
+                  
    {"data": {"isCompanyEmailAvailable": {"is_email_available": true}}}
 
    
-                    
-
    back to top @@ -4676,34 +4603,22 @@
    Arguments

    Example

    Query
    - - - 
    query isCompanyRoleNameAvailable($name: String!) {
+                  
    query isCompanyRoleNameAvailable($name: String!) {
   isCompanyRoleNameAvailable(name: $name) {
     is_role_name_available
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"name": "abc123"}
+                  
    {"name": "abc123"}
 
    
-                    
-
    Response
    - - - 
    {"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}}
+                  
    {"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}}
 
    
-                    
-
    back to top @@ -4756,34 +4671,22 @@
    Arguments

    Example

    Query
    - - - 
    query isCompanyUserEmailAvailable($email: String!) {
+                  
    query isCompanyUserEmailAvailable($email: String!) {
   isCompanyUserEmailAvailable(email: $email) {
     is_email_available
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"email": "xyz789"}
+                  
    {"email": "abc123"}
 
    
-                    
-
    Response
    - - - 
    {"data": {"isCompanyUserEmailAvailable": {"is_email_available": false}}}
+                  
    {"data": {"isCompanyUserEmailAvailable": {"is_email_available": true}}}
 
    
-                    
-
    back to top @@ -4835,34 +4738,104 @@
    Arguments

    Example

    Query
    - - - 
    query isEmailAvailable($email: String!) {
+                  
    query isEmailAvailable($email: String!) {
   isEmailAvailable(email: $email) {
     is_email_available
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"email": "abc123"}
+                  
    {"email": "abc123"}
+
    
+
    +
    +
    Response
    + 
    {"data": {"isEmailAvailable": {"is_email_available": false}}}
+
    +
    + + back to top + +
    +
    +
    + Queries +
    +

    + navigation +

    +
    +
    +
    +
    Description
    +

    Retrieves the navigation tree for a given product family.

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns [CategoryNavigationView] +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + family - String! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    + 
    query navigation($family: String!) {
+  navigation(family: $family) {
+    slug
+    name
+    children {
+      ...CategoryNavigationViewFragment
+    }
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {"family": "abc123"}
    - -
    Response
    - - - 
    {"data": {"isEmailAvailable": {"is_email_available": true}}}
+                  
    {
+  "data": {
+    "navigation": [
+      {
+        "slug": "abc123",
+        "name": "xyz789",
+        "children": [CategoryNavigationView]
+      }
+    ]
+  }
+}
 
    
-                    
-
    back to top @@ -4915,9 +4888,7 @@
    Arguments

    Example

    Query
    - - - 
    query negotiableQuote($uid: ID!) {
+                  
    query negotiableQuote($uid: ID!) {
   negotiableQuote(uid: $uid) {
     available_payment_methods {
       ...AvailablePaymentMethodFragment
@@ -4936,6 +4907,7 @@ 
    Query
    
       ...CustomAttributeFragment
     }    
     email
+    expiration_date
     history {
       ...NegotiableQuoteHistoryEntryFragment
     }
@@ -4944,9 +4916,13 @@ 
    Query
    
       ...CartItemInterfaceFragment
     }    
     name
+    order {
+      ...CustomerOrderFragment
+    }
     prices {
       ...CartPricesFragment
     }
+    sales_rep_name
     selected_payment_method {
       ...SelectedPaymentMethodFragment
     }
@@ -4954,29 +4930,23 @@ 
    Query
    
       ...NegotiableQuoteShippingAddressFragment
     }    
     status
+    template_id
+    template_name
     total_quantity
     uid
     updated_at
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"uid": 4}
+                  
    {"uid": 4}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "negotiableQuote": {
       "available_payment_methods": [
@@ -4987,26 +4957,29 @@ 
    Response
    
       "comments": [NegotiableQuoteComment],
       "created_at": "xyz789",
       "custom_attributes": [CustomAttribute],
-      "email": "xyz789",
+      "email": "abc123",
+      "expiration_date": "xyz789",
       "history": [NegotiableQuoteHistoryEntry],
-      "is_virtual": true,
+      "is_virtual": false,
       "items": [CartItemInterface],
-      "name": "xyz789",
+      "name": "abc123",
+      "order": CustomerOrder,
       "prices": CartPrices,
+      "sales_rep_name": "abc123",
       "selected_payment_method": SelectedPaymentMethod,
       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
       "status": "SUBMITTED",
-      "total_quantity": 123.45,
+      "template_id": 4,
+      "template_name": "abc123",
+      "total_quantity": 987.65,
       "uid": "4",
-      "updated_at": "xyz789"
+      "updated_at": "abc123"
     }
   }
 }
 
    
-                    
-
    back to top @@ -5059,9 +5032,7 @@
    Arguments

    Example

    Query
    - - - 
    query negotiableQuoteTemplate($templateId: ID!) {
+                  
    query negotiableQuoteTemplate($templateId: ID!) {
   negotiableQuoteTemplate(templateId: $templateId) {
     buyer {
       ...NegotiableQuoteUserFragment
@@ -5069,10 +5040,14 @@ 
    Query
    
     comments {
       ...NegotiableQuoteCommentFragment
     }
+    created_at
     expiration_date
     history {
       ...NegotiableQuoteHistoryEntryFragment
     }
+    historyV2 {
+      ...NegotiableQuoteTemplateHistoryEntryFragment
+    }
     is_min_max_qty_used
     is_virtual
     items {
@@ -5090,61 +5065,59 @@ 
    Query
    
     reference_document_links {
       ...NegotiableQuoteReferenceDocumentLinkFragment
     }
+    sales_rep_name
     shipping_addresses {
       ...NegotiableQuoteShippingAddressFragment
     }
     status
     template_id
     total_quantity
+    uid
+    updated_at
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"templateId": 4}
+                  
    {"templateId": "4"}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "negotiableQuoteTemplate": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
-      "expiration_date": "xyz789",
+      "created_at": "xyz789",
+      "expiration_date": "abc123",
       "history": [NegotiableQuoteHistoryEntry],
+      "historyV2": [NegotiableQuoteTemplateHistoryEntry],
       "is_min_max_qty_used": false,
       "is_virtual": false,
       "items": [CartItemInterface],
       "max_order_commitment": 987,
       "min_order_commitment": 123,
-      "name": "abc123",
+      "name": "xyz789",
       "notifications": [QuoteTemplateNotificationMessage],
       "prices": CartPrices,
       "reference_document_links": [
         NegotiableQuoteReferenceDocumentLink
       ],
+      "sales_rep_name": "abc123",
       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
       "status": "abc123",
       "template_id": "4",
-      "total_quantity": 987.65
+      "total_quantity": 987.65,
+      "uid": 4,
+      "updated_at": "xyz789"
     }
   }
 }
 
    
-                    
-
    back to top @@ -5214,9 +5187,7 @@
    Arguments

    Example

    Query
    - - - 
    query negotiableQuoteTemplates(
+                  
    query negotiableQuoteTemplates(
   $filter: NegotiableQuoteTemplateFilterInput,
   $pageSize: Int,
   $currentPage: Int,
@@ -5241,28 +5212,20 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
+                  
    {
   "filter": NegotiableQuoteTemplateFilterInput,
   "pageSize": 20,
   "currentPage": 1,
   "sort": NegotiableQuoteTemplateSortInput
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "negotiableQuoteTemplates": {
       "items": [NegotiableQuoteTemplateGridItem],
@@ -5273,8 +5236,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -5344,9 +5305,7 @@
    Arguments

    Example

    Query
    - - - 
    query negotiableQuotes(
+                  
    query negotiableQuotes(
   $filter: NegotiableQuoteFilterInput,
   $pageSize: Int,
   $currentPage: Int,
@@ -5371,40 +5330,30 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
+                  
    {
   "filter": NegotiableQuoteFilterInput,
   "pageSize": 20,
   "currentPage": 1,
   "sort": NegotiableQuoteSortInput
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "negotiableQuotes": {
       "items": [NegotiableQuote],
       "page_info": SearchResultPageInfo,
       "sort_fields": SortFields,
-      "total_count": 123
+      "total_count": 987
     }
   }
 }
 
    
-                    
-
    back to top @@ -5486,9 +5435,7 @@
    Arguments

    Example

    Query
    - - - 
    query pickupLocations(
+                  
    query pickupLocations(
   $area: AreaInput,
   $filters: PickupLocationFilterInput,
   $sort: PickupLocationSortInput,
@@ -5514,14 +5461,10 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
+                  
    {
   "area": AreaInput,
   "filters": PickupLocationFilterInput,
   "sort": PickupLocationSortInput,
@@ -5530,25 +5473,19 @@ 
    Variables
    
   "productsInfo": [ProductInfoInput]
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "pickupLocations": {
       "items": [PickupLocation],
       "page_info": SearchResultPageInfo,
-      "total_count": 987
+      "total_count": 123
     }
   }
 }
 
    
-                    
-
    back to top @@ -5630,9 +5567,7 @@
    Arguments

    Example

    Query
    - - - 
    query productSearch(
+                  
    query productSearch(
   $context: QueryContextInput,
   $current_page: Int,
   $filter: [SearchClauseInput!],
@@ -5660,17 +5595,16 @@ 
    Query
    
     related_terms
     suggestions
     total_count
+    warnings {
+      ...ProductSearchWarningFragment
+    }
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
+                  
    {
   "context": QueryContextInput,
   "current_page": 1,
   "filter": [SearchClauseInput],
@@ -5679,14 +5613,10 @@ 
    Variables
    
   "sort": [ProductSearchSortInput]
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "productSearch": {
       "facets": [Aggregation],
@@ -5694,13 +5624,12 @@ 
    Response
    
       "page_info": SearchResultPageInfo,
       "related_terms": ["abc123"],
       "suggestions": ["abc123"],
-      "total_count": 987
+      "total_count": 123,
+      "warnings": [ProductSearchWarning]
     }
   }
 }
 
    
-                    
-
    back to top @@ -5753,9 +5682,7 @@
    Arguments

    Example

    Query
    - - - 
    query products($skus: [String]) {
+                  
    query products($skus: [String]) {
   products(skus: $skus) {
     addToCartAllowed
     inStock
@@ -5787,51 +5714,47 @@ 
    Query
    
     links {
       ...ProductViewLinkFragment
     }
+    categories {
+      ...CategoryProductViewFragment
+    }
     queryType
     visibility
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"skus": ["xyz789"]}
+                  
    {"skus": ["xyz789"]}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "products": [
       {
-        "addToCartAllowed": false,
-        "inStock": true,
+        "addToCartAllowed": true,
+        "inStock": false,
         "lowStock": false,
         "attributes": [ProductViewAttribute],
-        "description": "abc123",
-        "id": "4",
+        "description": "xyz789",
+        "id": 4,
         "images": [ProductViewImage],
         "videos": [ProductViewVideo],
         "lastModifiedAt": "2007-12-03T10:15:30Z",
         "metaDescription": "xyz789",
-        "metaKeyword": "xyz789",
+        "metaKeyword": "abc123",
         "metaTitle": "abc123",
         "name": "xyz789",
         "shortDescription": "abc123",
         "inputOptions": [ProductViewInputOption],
-        "sku": "abc123",
-        "externalId": "abc123",
-        "url": "abc123",
-        "urlKey": "xyz789",
+        "sku": "xyz789",
+        "externalId": "xyz789",
+        "url": "xyz789",
+        "urlKey": "abc123",
         "links": [ProductViewLink],
+        "categories": [CategoryProductView],
         "queryType": "abc123",
         "visibility": "abc123"
       }
@@ -5839,8 +5762,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -5885,9 +5806,7 @@
    Arguments

    Example

    Query
    - - - 
    query recaptchaFormConfig($formType: ReCaptchaFormEnum!) {
+                  
    query recaptchaFormConfig($formType: ReCaptchaFormEnum!) {
   recaptchaFormConfig(formType: $formType) {
     configurations {
       ...ReCaptchaConfigurationFragment
@@ -5896,33 +5815,23 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"formType": "PLACE_ORDER"}
+                  
    {"formType": "PLACE_ORDER"}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "recaptchaFormConfig": {
       "configurations": ReCaptchaConfiguration,
-      "is_enabled": false
+      "is_enabled": true
     }
   }
 }
 
    
-                    
-
    back to top @@ -5955,9 +5864,7 @@
    Response

    Example

    Query
    - - - 
    query recaptchaV3Config {
+                  
    query recaptchaV3Config {
   recaptchaV3Config {
     badge_position
     failure_message
@@ -5970,30 +5877,24 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "recaptchaV3Config": {
       "badge_position": "abc123",
-      "failure_message": "xyz789",
+      "failure_message": "abc123",
       "forms": ["PLACE_ORDER"],
       "is_enabled": false,
       "language_code": "abc123",
       "minimum_score": 987.65,
-      "theme": "xyz789",
-      "website_key": "xyz789"
+      "theme": "abc123",
+      "website_key": "abc123"
     }
   }
 }
 
    
-                    
-
    back to top @@ -6067,6 +5968,12 @@
    Arguments
    User view history with timestamp + + + config - UnitConfigInput + + Optional unit configuration + @@ -6075,23 +5982,23 @@
    Arguments

    Example

    Query
    - - - 
    query recommendations(
+                  
    query recommendations(
   $cartSkus: [String],
   $category: String,
   $currentSku: String,
   $pageType: PageType,
   $userPurchaseHistory: [PurchaseHistory],
-  $userViewHistory: [ViewHistory]
-) {
+  $userViewHistory: [ViewHistory],
+  $config: UnitConfigInput
+) {
   recommendations(
     cartSkus: $cartSkus,
     category: $category,
     currentSku: $currentSku,
     pageType: $pageType,
     userPurchaseHistory: $userPurchaseHistory,
-    userViewHistory: $userViewHistory
+    userViewHistory: $userViewHistory,
+    config: $config
   ) {
     results {
       ...RecommendationUnitFragment
@@ -6100,30 +6007,23 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {
-  "cartSkus": ["abc123"],
-  "category": "abc123",
-  "currentSku": "abc123",
+                  
    {
+  "cartSkus": ["xyz789"],
+  "category": "xyz789",
+  "currentSku": "xyz789",
   "pageType": "CMS",
   "userPurchaseHistory": [PurchaseHistory],
-  "userViewHistory": [ViewHistory]
+  "userViewHistory": [ViewHistory],
+  "config": UnitConfigInput
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "recommendations": {
       "results": [RecommendationUnit],
@@ -6132,8 +6032,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -6146,14 +6044,6 @@
    Response

    recommendationsByUnitIds

    -
    -
    -
    -
    Description
    -

    Get Recommendations by Unit IDs

    -
    -
    -
    @@ -6175,7 +6065,7 @@
    Arguments
    unitIds - [String!]! - List unit IDs of the preconfigured units + List unit IDs of preconfigured units @@ -6209,9 +6099,7 @@
    Arguments

    Example

    Query
    - - - 
    query recommendationsByUnitIds(
+                  
    query recommendationsByUnitIds(
   $unitIds: [String!]!,
   $currentSku: String,
   $userPurchaseHistory: [PurchaseHistory],
@@ -6232,39 +6120,29 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
-  "unitIds": ["abc123"],
+                  
    {
+  "unitIds": ["xyz789"],
   "currentSku": "abc123",
   "userPurchaseHistory": [PurchaseHistory],
   "userViewHistory": [ViewHistory],
-  "cartSkus": ["abc123"]
+  "cartSkus": ["xyz789"]
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "recommendationsByUnitIds": {
       "results": [RecommendationUnit],
-      "totalResults": 987
+      "totalResults": 123
     }
   }
 }
 
    
-                    
-
    back to top @@ -6316,9 +6194,7 @@
    Arguments

    Example

    Query
    - - - 
    query refineProduct(
+                  
    query refineProduct(
   $optionIds: [String!]!,
   $sku: String!
 ) {
@@ -6356,61 +6232,55 @@ 
    Query
    
     links {
       ...ProductViewLinkFragment
     }
+    categories {
+      ...CategoryProductViewFragment
+    }
     queryType
     visibility
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
+                  
    {
   "optionIds": ["xyz789"],
-  "sku": "abc123"
+  "sku": "xyz789"
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "refineProduct": {
       "addToCartAllowed": false,
-      "inStock": false,
+      "inStock": true,
       "lowStock": true,
       "attributes": [ProductViewAttribute],
       "description": "xyz789",
-      "id": "4",
+      "id": 4,
       "images": [ProductViewImage],
       "videos": [ProductViewVideo],
       "lastModifiedAt": "2007-12-03T10:15:30Z",
-      "metaDescription": "abc123",
-      "metaKeyword": "xyz789",
-      "metaTitle": "xyz789",
+      "metaDescription": "xyz789",
+      "metaKeyword": "abc123",
+      "metaTitle": "abc123",
       "name": "xyz789",
-      "shortDescription": "abc123",
+      "shortDescription": "xyz789",
       "inputOptions": [ProductViewInputOption],
       "sku": "abc123",
       "externalId": "xyz789",
       "url": "abc123",
-      "urlKey": "xyz789",
+      "urlKey": "abc123",
       "links": [ProductViewLink],
+      "categories": [CategoryProductView],
       "queryType": "abc123",
-      "visibility": "abc123"
+      "visibility": "xyz789"
     }
   }
 }
 
    
-                    
-
    back to top @@ -6443,10 +6313,9 @@
    Response

    Example

    Query
    - - - 
    query storeConfig {
+                  
    query storeConfig {
   storeConfig {
+    allow_company_registration
     allow_gift_receipt
     allow_gift_wrapping_on_order
     allow_gift_wrapping_on_order_items
@@ -6461,6 +6330,7 @@ 
    Query
    
     base_url
     cart_expires_in_days
     cart_gift_wrapping
+    cart_merge_preference
     cart_printed_card
     cart_summary_display_quantity
     catalog_default_sort_by
@@ -6476,6 +6346,8 @@ 
    Query
    
     check_money_order_send_check_to
     check_money_order_sort_order
     check_money_order_title
+    company_credit_enabled
+    company_enabled
     configurable_product_image
     configurable_thumbnail_source
     contact_enabled
@@ -6547,6 +6419,8 @@ 
    Query
    
     product_fixed_product_tax_display_setting
     product_url_suffix
     quickorder_active
+    quote_minimum_amount
+    quote_minimum_amount_message
     required_character_classes_number
     returns_enabled
     root_category_uid
@@ -6587,155 +6461,155 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "storeConfig": {
-      "allow_gift_receipt": "xyz789",
+      "allow_company_registration": false,
+      "allow_gift_receipt": "abc123",
       "allow_gift_wrapping_on_order": "xyz789",
       "allow_gift_wrapping_on_order_items": "xyz789",
-      "allow_items": "abc123",
+      "allow_items": "xyz789",
       "allow_order": "abc123",
-      "allow_printed_card": "xyz789",
-      "autocomplete_on_storefront": true,
-      "base_currency_code": "xyz789",
+      "allow_printed_card": "abc123",
+      "autocomplete_on_storefront": false,
+      "base_currency_code": "abc123",
       "base_link_url": "abc123",
-      "base_media_url": "xyz789",
-      "base_static_url": "xyz789",
-      "base_url": "xyz789",
-      "cart_expires_in_days": 123,
+      "base_media_url": "abc123",
+      "base_static_url": "abc123",
+      "base_url": "abc123",
+      "cart_expires_in_days": 987,
       "cart_gift_wrapping": "abc123",
-      "cart_printed_card": "xyz789",
+      "cart_merge_preference": "abc123",
+      "cart_printed_card": "abc123",
       "cart_summary_display_quantity": 987,
-      "catalog_default_sort_by": "abc123",
+      "catalog_default_sort_by": "xyz789",
       "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-      "category_url_suffix": "xyz789",
+      "category_url_suffix": "abc123",
       "check_money_order_enable_for_specific_countries": true,
       "check_money_order_enabled": false,
       "check_money_order_make_check_payable_to": "xyz789",
-      "check_money_order_max_order_total": "xyz789",
+      "check_money_order_max_order_total": "abc123",
       "check_money_order_min_order_total": "xyz789",
       "check_money_order_new_order_status": "xyz789",
       "check_money_order_payment_from_specific_countries": "abc123",
-      "check_money_order_send_check_to": "xyz789",
+      "check_money_order_send_check_to": "abc123",
       "check_money_order_sort_order": 123,
-      "check_money_order_title": "xyz789",
+      "check_money_order_title": "abc123",
+      "company_credit_enabled": false,
+      "company_enabled": false,
       "configurable_product_image": "ITSELF",
-      "configurable_thumbnail_source": "xyz789",
+      "configurable_thumbnail_source": "abc123",
       "contact_enabled": false,
       "countries_with_required_region": "abc123",
       "create_account_confirmation": false,
-      "customer_access_token_lifetime": 987.65,
+      "customer_access_token_lifetime": 123.45,
       "default_country": "abc123",
       "default_display_currency_code": "abc123",
-      "display_product_prices_in_catalog": 123,
+      "display_product_prices_in_catalog": 987,
       "display_shipping_prices": 123,
       "display_state_if_optional": true,
-      "enable_multiple_wishlists": "abc123",
+      "enable_multiple_wishlists": "xyz789",
       "fixed_product_taxes_apply_tax_to_fpt": true,
       "fixed_product_taxes_display_prices_in_emails": 123,
-      "fixed_product_taxes_display_prices_in_product_lists": 123,
+      "fixed_product_taxes_display_prices_in_product_lists": 987,
       "fixed_product_taxes_display_prices_in_sales_modules": 123,
-      "fixed_product_taxes_display_prices_on_product_view_page": 123,
+      "fixed_product_taxes_display_prices_on_product_view_page": 987,
       "fixed_product_taxes_enable": true,
       "fixed_product_taxes_include_fpt_in_subtotal": false,
-      "graphql_share_customer_group": false,
-      "grid_per_page": 987,
-      "grid_per_page_values": "xyz789",
+      "graphql_share_customer_group": true,
+      "grid_per_page": 123,
+      "grid_per_page_values": "abc123",
       "grouped_product_image": "ITSELF",
-      "is_checkout_agreements_enabled": false,
+      "is_checkout_agreements_enabled": true,
       "is_default_store": true,
-      "is_default_store_group": true,
-      "is_guest_checkout_enabled": false,
+      "is_default_store_group": false,
+      "is_guest_checkout_enabled": true,
       "is_negotiable_quote_active": true,
-      "is_one_page_checkout_enabled": true,
+      "is_one_page_checkout_enabled": false,
       "is_requisition_list_active": "xyz789",
       "list_mode": "abc123",
-      "list_per_page": 123,
-      "list_per_page_values": "xyz789",
-      "locale": "xyz789",
-      "magento_reward_general_is_enabled": "xyz789",
-      "magento_reward_general_is_enabled_on_front": "xyz789",
+      "list_per_page": 987,
+      "list_per_page_values": "abc123",
+      "locale": "abc123",
+      "magento_reward_general_is_enabled": "abc123",
+      "magento_reward_general_is_enabled_on_front": "abc123",
       "magento_reward_general_min_points_balance": "abc123",
       "magento_reward_general_publish_history": "abc123",
       "magento_reward_points_invitation_customer": "abc123",
-      "magento_reward_points_invitation_customer_limit": "xyz789",
-      "magento_reward_points_invitation_order": "xyz789",
+      "magento_reward_points_invitation_customer_limit": "abc123",
+      "magento_reward_points_invitation_order": "abc123",
       "magento_reward_points_invitation_order_limit": "xyz789",
       "magento_reward_points_newsletter": "abc123",
-      "magento_reward_points_order": "xyz789",
+      "magento_reward_points_order": "abc123",
       "magento_reward_points_register": "xyz789",
-      "magento_reward_points_review": "xyz789",
-      "magento_reward_points_review_limit": "abc123",
-      "magento_wishlist_general_is_enabled": "xyz789",
+      "magento_reward_points_review": "abc123",
+      "magento_reward_points_review_limit": "xyz789",
+      "magento_wishlist_general_is_enabled": "abc123",
       "max_items_in_order_summary": 987,
-      "maximum_number_of_wishlists": "abc123",
-      "minicart_display": false,
-      "minicart_max_items": 987,
+      "maximum_number_of_wishlists": "xyz789",
+      "minicart_display": true,
+      "minicart_max_items": 123,
       "minimum_password_length": "abc123",
       "newsletter_enabled": false,
       "optional_zip_countries": "abc123",
-      "order_cancellation_enabled": false,
+      "order_cancellation_enabled": true,
       "order_cancellation_reasons": [CancellationReason],
       "orders_invoices_credit_memos_display_full_summary": false,
       "orders_invoices_credit_memos_display_grandtotal": false,
-      "orders_invoices_credit_memos_display_price": 123,
+      "orders_invoices_credit_memos_display_price": 987,
       "orders_invoices_credit_memos_display_shipping_amount": 123,
       "orders_invoices_credit_memos_display_subtotal": 123,
-      "orders_invoices_credit_memos_display_zero_tax": false,
+      "orders_invoices_credit_memos_display_zero_tax": true,
       "printed_card_priceV2": Money,
       "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
       "product_url_suffix": "abc123",
-      "quickorder_active": true,
+      "quickorder_active": false,
+      "quote_minimum_amount": 123.45,
+      "quote_minimum_amount_message": "xyz789",
       "required_character_classes_number": "abc123",
-      "returns_enabled": "abc123",
+      "returns_enabled": "xyz789",
       "root_category_uid": "4",
       "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
-      "sales_gift_wrapping": "abc123",
+      "sales_gift_wrapping": "xyz789",
       "sales_printed_card": "xyz789",
       "secure_base_link_url": "xyz789",
       "secure_base_media_url": "xyz789",
-      "secure_base_static_url": "xyz789",
+      "secure_base_static_url": "abc123",
       "secure_base_url": "abc123",
       "share_active_segments": false,
       "share_applied_cart_rule": false,
       "shopping_cart_display_full_summary": false,
       "shopping_cart_display_grand_total": false,
-      "shopping_cart_display_price": 123,
+      "shopping_cart_display_price": 987,
       "shopping_cart_display_shipping": 123,
-      "shopping_cart_display_subtotal": 987,
+      "shopping_cart_display_subtotal": 123,
       "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
       "shopping_cart_display_zero_tax": true,
-      "store_code": "4",
-      "store_group_code": 4,
+      "store_code": 4,
+      "store_group_code": "4",
       "store_group_name": "xyz789",
       "store_name": "xyz789",
       "store_sort_order": 123,
       "timezone": "xyz789",
       "title_separator": "xyz789",
-      "use_store_in_url": true,
-      "website_code": "4",
-      "website_name": "xyz789",
-      "weight_unit": "abc123",
-      "zero_subtotal_enable_for_specific_countries": false,
+      "use_store_in_url": false,
+      "website_code": 4,
+      "website_name": "abc123",
+      "weight_unit": "xyz789",
+      "zero_subtotal_enable_for_specific_countries": true,
       "zero_subtotal_enabled": false,
       "zero_subtotal_new_order_status": "abc123",
-      "zero_subtotal_payment_action": "abc123",
+      "zero_subtotal_payment_action": "xyz789",
       "zero_subtotal_payment_from_specific_countries": "xyz789",
       "zero_subtotal_sort_order": 987,
-      "zero_subtotal_title": "xyz789"
+      "zero_subtotal_title": "abc123"
     }
   }
 }
 
    
-                    
-
    back to top @@ -6801,9 +6675,7 @@
    Arguments

    Example

    Query
    - - - 
    query variants(
+                  
    query variants(
   $sku: String!,
   $optionIds: [String!],
   $pageSize: Int,
@@ -6822,38 +6694,28 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
-  "sku": "xyz789",
+                  
    {
+  "sku": "abc123",
   "optionIds": ["abc123"],
-  "pageSize": 123,
+  "pageSize": 987,
   "cursor": "abc123"
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "variants": {
       "variants": [ProductViewVariant],
-      "cursor": "abc123"
+      "cursor": "xyz789"
     }
   }
 }
 
    
-                    
-
    back to top @@ -6904,34 +6766,22 @@
    Arguments

    Example

    Query
    - - - 
    mutation acceptCompanyInvitation($input: CompanyInvitationInput!) {
+                  
    mutation acceptCompanyInvitation($input: CompanyInvitationInput!) {
   acceptCompanyInvitation(input: $input) {
     success
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": CompanyInvitationInput}
+                  
    {"input": CompanyInvitationInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"acceptCompanyInvitation": {"success": false}}}
+                  
    {"data": {"acceptCompanyInvitation": {"success": false}}}
 
    
-                    
-
    back to top @@ -6983,9 +6833,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInput!) {
+                  
    mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInput!) {
   acceptNegotiableQuoteTemplate(input: $input) {
     buyer {
       ...NegotiableQuoteUserFragment
@@ -6993,10 +6841,14 @@ 
    Query
    
     comments {
       ...NegotiableQuoteCommentFragment
     }
+    created_at
     expiration_date
     history {
       ...NegotiableQuoteHistoryEntryFragment
     }
+    historyV2 {
+      ...NegotiableQuoteTemplateHistoryEntryFragment
+    }
     is_min_max_qty_used
     is_virtual
     items {
@@ -7014,40 +6866,37 @@ 
    Query
    
     reference_document_links {
       ...NegotiableQuoteReferenceDocumentLinkFragment
     }
+    sales_rep_name
     shipping_addresses {
       ...NegotiableQuoteShippingAddressFragment
     }
     status
     template_id
     total_quantity
+    uid
+    updated_at
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": AcceptNegotiableQuoteTemplateInput}
+                  
    {"input": AcceptNegotiableQuoteTemplateInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "acceptNegotiableQuoteTemplate": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
-      "expiration_date": "abc123",
+      "created_at": "abc123",
+      "expiration_date": "xyz789",
       "history": [NegotiableQuoteHistoryEntry],
-      "is_min_max_qty_used": false,
-      "is_virtual": false,
+      "historyV2": [NegotiableQuoteTemplateHistoryEntry],
+      "is_min_max_qty_used": true,
+      "is_virtual": true,
       "items": [CartItemInterface],
       "max_order_commitment": 123,
       "min_order_commitment": 987,
@@ -7057,18 +6906,19 @@ 
    Response
    
       "reference_document_links": [
         NegotiableQuoteReferenceDocumentLink
       ],
+      "sales_rep_name": "xyz789",
       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
       "status": "abc123",
-      "template_id": "4",
-      "total_quantity": 987.65
+      "template_id": 4,
+      "total_quantity": 987.65,
+      "uid": 4,
+      "updated_at": "abc123"
     }
   }
 }
 
    
-                    
-
    back to top @@ -7120,9 +6970,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInput) {
+                  
    mutation addDownloadableProductsToCart($input: AddDownloadableProductsToCartInput) {
   addDownloadableProductsToCart(input: $input) {
     cart {
       ...CartFragment
@@ -7130,30 +6978,20 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": AddDownloadableProductsToCartInput}
+                  
    {"input": AddDownloadableProductsToCartInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "addDownloadableProductsToCart": {"cart": Cart}
   }
 }
 
    
-                    
-
    back to top @@ -7211,9 +7049,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation addGiftRegistryRegistrants(
+                  
    mutation addGiftRegistryRegistrants(
   $giftRegistryUid: ID!,
   $registrants: [AddGiftRegistryRegistrantInput!]!
 ) {
@@ -7227,26 +7063,18 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
-  "giftRegistryUid": 4,
+                  
    {
+  "giftRegistryUid": "4",
   "registrants": [AddGiftRegistryRegistrantInput]
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "addGiftRegistryRegistrants": {
       "gift_registry": GiftRegistry
@@ -7254,8 +7082,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -7313,9 +7139,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation addProductsToCart(
+                  
    mutation addProductsToCart(
   $cartId: String!,
   $cartItems: [CartItemInput!]!
 ) {
@@ -7332,26 +7156,18 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
+                  
    {
   "cartId": "xyz789",
   "cartItems": [CartItemInput]
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "addProductsToCart": {
       "cart": Cart,
@@ -7360,8 +7176,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -7413,9 +7227,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation addProductsToCompareList($input: AddProductsToCompareListInput) {
+                  
    mutation addProductsToCompareList($input: AddProductsToCompareListInput) {
   addProductsToCompareList(input: $input) {
     attributes {
       ...ComparableAttributeFragment
@@ -7428,23 +7240,15 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": AddProductsToCompareListInput}
+                  
    {"input": AddProductsToCompareListInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "addProductsToCompareList": {
       "attributes": [ComparableAttribute],
@@ -7455,8 +7259,85 @@ 
    Response
    
   }
 }
 
    
-                    
-                  
+
    + + back to top + +
    +
    +
    + Mutations +
    +

    + addProductsToNewCart +

    +
    +
    +
    +
    Description
    +

    Creates a new cart and add any type of product to it

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns an AddProductsToNewCartOutput +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + cartItems - [CartItemInput!]! + An array that defines the products to add to the new cart
    +
    +
    +
    +

    Example

    +
    +
    Query
    + 
    mutation addProductsToNewCart($cartItems: [CartItemInput!]!) {
+  addProductsToNewCart(cartItems: $cartItems) {
+    cart {
+      ...CartFragment
+    }
+    user_errors {
+      ...CartUserInputErrorFragment
+    }
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {"cartItems": [CartItemInput]}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "addProductsToNewCart": {
+      "cart": Cart,
+      "user_errors": [CartUserInputError]
+    }
+  }
+}
+
    back to top @@ -7514,9 +7395,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation addProductsToRequisitionList(
+                  
    mutation addProductsToRequisitionList(
   $requisitionListUid: ID!,
   $requisitionListItems: [RequisitionListItemsInput!]!
 ) {
@@ -7530,26 +7409,18 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
+                  
    {
   "requisitionListUid": "4",
   "requisitionListItems": [RequisitionListItemsInput]
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "addProductsToRequisitionList": {
       "requisition_list": RequisitionList
@@ -7557,8 +7428,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -7616,9 +7485,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation addProductsToWishlist(
+                  
    mutation addProductsToWishlist(
   $wishlistId: ID!,
   $wishlistItems: [WishlistItemInput!]!
 ) {
@@ -7635,23 +7502,15 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"wishlistId": 4, "wishlistItems": [WishlistItemInput]}
+                  
    {"wishlistId": 4, "wishlistItems": [WishlistItemInput]}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "addProductsToWishlist": {
       "user_errors": [WishListUserInputError],
@@ -7660,8 +7519,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -7714,9 +7571,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) {
+                  
    mutation addPurchaseOrderComment($input: AddPurchaseOrderCommentInput!) {
   addPurchaseOrderComment(input: $input) {
     comment {
       ...PurchaseOrderCommentFragment
@@ -7724,23 +7579,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": AddPurchaseOrderCommentInput}
+                  
    {"input": AddPurchaseOrderCommentInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "addPurchaseOrderComment": {
       "comment": PurchaseOrderComment
@@ -7748,8 +7595,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -7802,9 +7647,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) {
+                  
    mutation addPurchaseOrderItemsToCart($input: AddPurchaseOrderItemsToCartInput!) {
   addPurchaseOrderItemsToCart(input: $input) {
     cart {
       ...CartFragment
@@ -7815,23 +7658,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": AddPurchaseOrderItemsToCartInput}
+                  
    {"input": AddPurchaseOrderItemsToCartInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "addPurchaseOrderItemsToCart": {
       "cart": Cart,
@@ -7840,8 +7675,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -7899,9 +7732,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation addRequisitionListItemsToCart(
+                  
    mutation addRequisitionListItemsToCart(
   $requisitionListUid: ID!,
   $requisitionListItemUids: [ID!]
 ) {
@@ -7919,26 +7750,18 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
-  "requisitionListUid": "4",
-  "requisitionListItemUids": [4]
+                  
    {
+  "requisitionListUid": 4,
+  "requisitionListItemUids": ["4"]
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "addRequisitionListItemsToCart": {
       "add_requisition_list_items_to_cart_user_errors": [
@@ -7950,8 +7773,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -8003,9 +7824,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation addReturnComment($input: AddReturnCommentInput!) {
+                  
    mutation addReturnComment($input: AddReturnCommentInput!) {
   addReturnComment(input: $input) {
     return {
       ...ReturnFragment
@@ -8013,26 +7832,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": AddReturnCommentInput}
+                  
    {"input": AddReturnCommentInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"addReturnComment": {"return": Return}}}
+                  
    {"data": {"addReturnComment": {"return": Return}}}
 
    
-                    
-
    back to top @@ -8084,9 +7893,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation addReturnTracking($input: AddReturnTrackingInput!) {
+                  
    mutation addReturnTracking($input: AddReturnTrackingInput!) {
   addReturnTracking(input: $input) {
     return {
       ...ReturnFragment
@@ -8097,23 +7904,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": AddReturnTrackingInput}
+                  
    {"input": AddReturnTrackingInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "addReturnTracking": {
       "return": Return,
@@ -8122,8 +7921,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -8181,9 +7978,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation addWishlistItemsToCart(
+                  
    mutation addWishlistItemsToCart(
   $wishlistId: ID!,
   $wishlistItemIds: [ID!]
 ) {
@@ -8201,36 +7996,29 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"wishlistId": "4", "wishlistItemIds": [4]}
+                  
    {
+  "wishlistId": "4",
+  "wishlistItemIds": ["4"]
+}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "addWishlistItemsToCart": {
       "add_wishlist_items_to_cart_user_errors": [
         WishlistCartUserInputError
       ],
-      "status": false,
+      "status": true,
       "wishlist": Wishlist
     }
   }
 }
 
    
-                    
-
    back to top @@ -8282,9 +8070,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation applyCouponToCart($input: ApplyCouponToCartInput) {
+                  
    mutation applyCouponToCart($input: ApplyCouponToCartInput) {
   applyCouponToCart(input: $input) {
     cart {
       ...CartFragment
@@ -8292,26 +8078,16 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": ApplyCouponToCartInput}
+                  
    {"input": ApplyCouponToCartInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"applyCouponToCart": {"cart": Cart}}}
+                  
    {"data": {"applyCouponToCart": {"cart": Cart}}}
 
    
-                    
-
    back to top @@ -8363,9 +8139,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation applyCouponsToCart($input: ApplyCouponsToCartInput) {
+                  
    mutation applyCouponsToCart($input: ApplyCouponsToCartInput) {
   applyCouponsToCart(input: $input) {
     cart {
       ...CartFragment
@@ -8373,26 +8147,16 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": ApplyCouponsToCartInput}
+                  
    {"input": ApplyCouponsToCartInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"applyCouponsToCart": {"cart": Cart}}}
+                  
    {"data": {"applyCouponsToCart": {"cart": Cart}}}
 
    
-                    
-
    back to top @@ -8444,9 +8208,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) {
+                  
    mutation applyGiftCardToCart($input: ApplyGiftCardToCartInput) {
   applyGiftCardToCart(input: $input) {
     cart {
       ...CartFragment
@@ -8454,26 +8216,16 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": ApplyGiftCardToCartInput}
+                  
    {"input": ApplyGiftCardToCartInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"applyGiftCardToCart": {"cart": Cart}}}
+                  
    {"data": {"applyGiftCardToCart": {"cart": Cart}}}
 
    
-                    
-
    back to top @@ -8526,9 +8278,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation applyRewardPointsToCart($cartId: ID!) {
+                  
    mutation applyRewardPointsToCart($cartId: ID!) {
   applyRewardPointsToCart(cartId: $cartId) {
     cart {
       ...CartFragment
@@ -8536,26 +8286,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"cartId": 4}
+                  
    {"cartId": "4"}
 
    
-                    
-
    Response
    - - - 
    {"data": {"applyRewardPointsToCart": {"cart": Cart}}}
+                  
    {"data": {"applyRewardPointsToCart": {"cart": Cart}}}
 
    
-                    
-
    back to top @@ -8607,9 +8347,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) {
+                  
    mutation applyStoreCreditToCart($input: ApplyStoreCreditToCartInput!) {
   applyStoreCreditToCart(input: $input) {
     cart {
       ...CartFragment
@@ -8617,26 +8355,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": ApplyStoreCreditToCartInput}
+                  
    {"input": ApplyStoreCreditToCartInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"applyStoreCreditToCart": {"cart": Cart}}}
+                  
    {"data": {"applyStoreCreditToCart": {"cart": Cart}}}
 
    
-                    
-
    back to top @@ -8689,9 +8417,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation approvePurchaseOrders($input: PurchaseOrdersActionInput!) {
+                  
    mutation approvePurchaseOrders($input: PurchaseOrdersActionInput!) {
   approvePurchaseOrders(input: $input) {
     errors {
       ...PurchaseOrderActionErrorFragment
@@ -8702,23 +8428,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": PurchaseOrdersActionInput}
+                  
    {"input": PurchaseOrdersActionInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "approvePurchaseOrders": {
       "errors": [PurchaseOrderActionError],
@@ -8727,8 +8445,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -8780,9 +8496,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation assignCompareListToCustomer($uid: ID!) {
+                  
    mutation assignCompareListToCustomer($uid: ID!) {
   assignCompareListToCustomer(uid: $uid) {
     compare_list {
       ...CompareListFragment
@@ -8791,33 +8505,23 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"uid": 4}
+                  
    {"uid": 4}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "assignCompareListToCustomer": {
       "compare_list": CompareList,
-      "result": true
+      "result": false
     }
   }
 }
 
    
-                    
-
    back to top @@ -8870,9 +8574,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation assignCustomerToGuestCart($cart_id: String!) {
+                  
    mutation assignCustomerToGuestCart($cart_id: String!) {
   assignCustomerToGuestCart(cart_id: $cart_id) {
     applied_coupons {
       ...AppliedCouponFragment
@@ -8928,23 +8630,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"cart_id": "abc123"}
+                  
    {"cart_id": "abc123"}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "assignCustomerToGuestCart": {
       "applied_coupons": [AppliedCoupon],
@@ -8959,13 +8653,13 @@ 
    Response
    
       "custom_attributes": [CustomAttribute],
       "email": "abc123",
       "gift_message": GiftMessage,
-      "gift_receipt_included": true,
+      "gift_receipt_included": false,
       "gift_wrapping": GiftWrapping,
       "id": 4,
       "is_virtual": true,
       "itemsV2": CartItems,
       "prices": CartPrices,
-      "printed_card_included": true,
+      "printed_card_included": false,
       "rules": [CartRuleStorefront],
       "selected_payment_method": SelectedPaymentMethod,
       "shipping_addresses": [ShippingCartAddress],
@@ -8974,8 +8668,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -9027,9 +8719,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInput!) {
+                  
    mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInput!) {
   cancelNegotiableQuoteTemplate(input: $input) {
     buyer {
       ...NegotiableQuoteUserFragment
@@ -9037,10 +8727,14 @@ 
    Query
    
     comments {
       ...NegotiableQuoteCommentFragment
     }
+    created_at
     expiration_date
     history {
       ...NegotiableQuoteHistoryEntryFragment
     }
+    historyV2 {
+      ...NegotiableQuoteTemplateHistoryEntryFragment
+    }
     is_min_max_qty_used
     is_virtual
     items {
@@ -9058,42 +8752,39 @@ 
    Query
    
     reference_document_links {
       ...NegotiableQuoteReferenceDocumentLinkFragment
     }
+    sales_rep_name
     shipping_addresses {
       ...NegotiableQuoteShippingAddressFragment
     }
     status
     template_id
     total_quantity
+    uid
+    updated_at
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": CancelNegotiableQuoteTemplateInput}
+                  
    {"input": CancelNegotiableQuoteTemplateInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "cancelNegotiableQuoteTemplate": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
-      "expiration_date": "xyz789",
+      "created_at": "abc123",
+      "expiration_date": "abc123",
       "history": [NegotiableQuoteHistoryEntry],
+      "historyV2": [NegotiableQuoteTemplateHistoryEntry],
       "is_min_max_qty_used": false,
-      "is_virtual": true,
+      "is_virtual": false,
       "items": [CartItemInterface],
-      "max_order_commitment": 987,
+      "max_order_commitment": 123,
       "min_order_commitment": 987,
       "name": "abc123",
       "notifications": [QuoteTemplateNotificationMessage],
@@ -9101,18 +8792,19 @@ 
    Response
    
       "reference_document_links": [
         NegotiableQuoteReferenceDocumentLink
       ],
+      "sales_rep_name": "xyz789",
       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
-      "status": "abc123",
-      "template_id": 4,
-      "total_quantity": 123.45
+      "status": "xyz789",
+      "template_id": "4",
+      "total_quantity": 123.45,
+      "uid": 4,
+      "updated_at": "abc123"
     }
   }
 }
 
    
-                    
-
    back to top @@ -9165,9 +8857,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation cancelOrder($input: CancelOrderInput!) {
+                  
    mutation cancelOrder($input: CancelOrderInput!) {
   cancelOrder(input: $input) {
     error
     errorV2 {
@@ -9179,23 +8869,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": CancelOrderInput}
+                  
    {"input": CancelOrderInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "cancelOrder": {
       "error": "abc123",
@@ -9205,8 +8887,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -9259,9 +8939,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation cancelPurchaseOrders($input: PurchaseOrdersActionInput!) {
+                  
    mutation cancelPurchaseOrders($input: PurchaseOrdersActionInput!) {
   cancelPurchaseOrders(input: $input) {
     errors {
       ...PurchaseOrderActionErrorFragment
@@ -9272,23 +8950,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": PurchaseOrdersActionInput}
+                  
    {"input": PurchaseOrdersActionInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "cancelPurchaseOrders": {
       "errors": [PurchaseOrderActionError],
@@ -9297,8 +8967,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -9356,9 +9024,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation changeCustomerPassword(
+                  
    mutation changeCustomerPassword(
   $currentPassword: String!,
   $newPassword: String!
 ) {
@@ -9399,6 +9065,7 @@ 
    Query
    
     group {
       ...CustomerGroupStorefrontFragment
     }
+    id
     is_subscribed
     job_title
     lastname
@@ -9423,6 +9090,7 @@ 
    Query
    
       ...PurchaseOrdersFragment
     }    
     purchase_orders_enabled
+    quote_enabled
     requisition_lists {
       ...RequisitionListsFragment
     }
@@ -9461,26 +9129,18 @@ 
    Query
    
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {
+                  
    {
   "currentPassword": "xyz789",
   "newPassword": "abc123"
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "changeCustomerPassword": {
       "addresses": [CustomerAddress],
@@ -9489,29 +9149,31 @@ 
    Response
    
       "companies": UserCompaniesOutput,
       "compare_list": CompareList,
       "confirmation_status": "ACCOUNT_CONFIRMED",
-      "created_at": "abc123",
+      "created_at": "xyz789",
       "custom_attributes": [AttributeValueInterface],
-      "date_of_birth": "xyz789",
-      "default_billing": "abc123",
-      "default_shipping": "xyz789",
+      "date_of_birth": "abc123",
+      "default_billing": "xyz789",
+      "default_shipping": "abc123",
       "email": "abc123",
       "firstname": "xyz789",
-      "gender": 123,
+      "gender": 987,
       "gift_registries": [GiftRegistry],
       "gift_registry": GiftRegistry,
       "group": CustomerGroupStorefront,
-      "is_subscribed": false,
+      "id": 4,
+      "is_subscribed": true,
       "job_title": "xyz789",
-      "lastname": "abc123",
-      "middlename": "xyz789",
+      "lastname": "xyz789",
+      "middlename": "abc123",
       "orders": CustomerOrders,
-      "prefix": "abc123",
+      "prefix": "xyz789",
       "purchase_order": PurchaseOrder,
       "purchase_order_approval_rule": PurchaseOrderApprovalRule,
       "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
       "purchase_order_approval_rules": PurchaseOrderApprovalRules,
       "purchase_orders": PurchaseOrders,
-      "purchase_orders_enabled": false,
+      "purchase_orders_enabled": true,
+      "quote_enabled": true,
       "requisition_lists": RequisitionLists,
       "return": Return,
       "returns": Returns,
@@ -9520,9 +9182,9 @@ 
    Response
    
       "segments": [CustomerSegmentStorefront],
       "status": "ACTIVE",
       "store_credit": CustomerStoreCredit,
-      "structure_id": 4,
-      "suffix": "abc123",
-      "taxvat": "xyz789",
+      "structure_id": "4",
+      "suffix": "xyz789",
+      "taxvat": "abc123",
       "team": CompanyTeam,
       "telephone": "xyz789",
       "wishlist_v2": Wishlist,
@@ -9531,8 +9193,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -9584,9 +9244,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation clearCustomerCart($cartUid: String!) {
+                  
    mutation clearCustomerCart($cartUid: String!) {
   clearCustomerCart(cartUid: $cartUid) {
     cart {
       ...CartFragment
@@ -9595,30 +9253,20 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"cartUid": "abc123"}
+                  
    {"cartUid": "abc123"}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "clearCustomerCart": {"cart": Cart, "status": false}
   }
 }
 
    
-                    
-
    back to top @@ -9670,9 +9318,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation clearWishlist($wishlistId: ID!) {
+                  
    mutation clearWishlist($wishlistId: ID!) {
   clearWishlist(wishlistId: $wishlistId) {
     user_errors {
       ...WishListUserInputErrorFragment
@@ -9683,23 +9329,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"wishlistId": "4"}
+                  
    {"wishlistId": 4}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "clearWishlist": {
       "user_errors": [WishListUserInputError],
@@ -9708,8 +9346,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -9761,9 +9397,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation closeNegotiableQuotes($input: CloseNegotiableQuotesInput!) {
+                  
    mutation closeNegotiableQuotes($input: CloseNegotiableQuotesInput!) {
   closeNegotiableQuotes(input: $input) {
     negotiable_quotes {
       ...NegotiableQuotesOutputFragment
@@ -9780,23 +9414,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": CloseNegotiableQuotesInput}
+                  
    {"input": CloseNegotiableQuotesInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "closeNegotiableQuotes": {
       "negotiable_quotes": NegotiableQuotesOutput,
@@ -9808,8 +9434,85 @@ 
    Response
    
   }
 }
 
    
-                    
-                  
+
    + + back to top + +
    +
    +
    + Mutations +
    +

    + completeOrder +

    +
    +
    +
    +
    Description
    +

    Synchronizes order details and place the order

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a PlaceOrderOutput +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - CompleteOrderInput + Describes the variables needed to complete or place the order
    +
    +
    +
    +

    Example

    +
    +
    Query
    + 
    mutation completeOrder($input: CompleteOrderInput) {
+  completeOrder(input: $input) {
+    errors {
+      ...PlaceOrderErrorFragment
+    }
+    orderV2 {
+      ...CustomerOrderFragment
+    }
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {"input": CompleteOrderInput}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "completeOrder": {
+      "errors": [PlaceOrderError],
+      "orderV2": CustomerOrder
+    }
+  }
+}
+
    back to top @@ -9862,9 +9565,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) {
+                  
    mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) {
   confirmCancelOrder(input: $input) {
     error
     errorV2 {
@@ -9876,34 +9577,24 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": ConfirmCancelOrderInput}
+                  
    {"input": ConfirmCancelOrderInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "confirmCancelOrder": {
-      "error": "xyz789",
+      "error": "abc123",
       "errorV2": CancelOrderError,
       "order": CustomerOrder
     }
   }
 }
 
    
-                    
-
    back to top @@ -9955,9 +9646,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation confirmEmail($input: ConfirmEmailInput!) {
+                  
    mutation confirmEmail($input: ConfirmEmailInput!) {
   confirmEmail(input: $input) {
     customer {
       ...CustomerFragment
@@ -9965,26 +9654,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": ConfirmEmailInput}
+                  
    {"input": ConfirmEmailInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"confirmEmail": {"customer": Customer}}}
+                  
    {"data": {"confirmEmail": {"customer": Customer}}}
 
    
-                    
-
    back to top @@ -10037,9 +9716,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation confirmReturn($input: ConfirmReturnInput!) {
+                  
    mutation confirmReturn($input: ConfirmReturnInput!) {
   confirmReturn(input: $input) {
     return {
       ...ReturnFragment
@@ -10050,23 +9727,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": ConfirmReturnInput}
+                  
    {"input": ConfirmReturnInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "confirmReturn": {
       "return": Return,
@@ -10075,8 +9744,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -10128,34 +9795,22 @@
    Arguments

    Example

    Query
    - - - 
    mutation contactUs($input: ContactUsInput!) {
+                  
    mutation contactUs($input: ContactUsInput!) {
   contactUs(input: $input) {
     status
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": ContactUsInput}
+                  
    {"input": ContactUsInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"contactUs": {"status": true}}}
+                  
    {"data": {"contactUs": {"status": false}}}
 
    
-                    
-
    back to top @@ -10219,9 +9874,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation copyItemsBetweenRequisitionLists(
+                  
    mutation copyItemsBetweenRequisitionLists(
   $sourceRequisitionListUid: ID!,
   $destinationRequisitionListUid: ID,
   $requisitionListItem: CopyItemsBetweenRequisitionListsInput
@@ -10237,27 +9890,19 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {
-  "sourceRequisitionListUid": "4",
+                  
    {
+  "sourceRequisitionListUid": 4,
   "destinationRequisitionListUid": 4,
   "requisitionListItem": CopyItemsBetweenRequisitionListsInput
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "copyItemsBetweenRequisitionLists": {
       "requisition_list": RequisitionList
@@ -10265,8 +9910,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -10330,9 +9973,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation copyProductsBetweenWishlists(
+                  
    mutation copyProductsBetweenWishlists(
   $sourceWishlistUid: ID!,
   $destinationWishlistUid: ID!,
   $wishlistItems: [WishlistItemCopyInput!]!
@@ -10354,27 +9995,19 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
-  "sourceWishlistUid": "4",
-  "destinationWishlistUid": 4,
+                  
    {
+  "sourceWishlistUid": 4,
+  "destinationWishlistUid": "4",
   "wishlistItems": [WishlistItemCopyInput]
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "copyProductsBetweenWishlists": {
       "destination_wishlist": Wishlist,
@@ -10384,8 +10017,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -10438,9 +10069,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation createCompany($input: CompanyCreateInput!) {
+                  
    mutation createCompany($input: CompanyCreateInput!) {
   createCompany(input: $input) {
     company {
       ...CompanyFragment
@@ -10448,26 +10077,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": CompanyCreateInput}
+                  
    {"input": CompanyCreateInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"createCompany": {"company": Company}}}
+                  
    {"data": {"createCompany": {"company": Company}}}
 
    
-                    
-
    back to top @@ -10520,9 +10139,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation createCompanyRole($input: CompanyRoleCreateInput!) {
+                  
    mutation createCompanyRole($input: CompanyRoleCreateInput!) {
   createCompanyRole(input: $input) {
     role {
       ...CompanyRoleFragment
@@ -10530,26 +10147,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": CompanyRoleCreateInput}
+                  
    {"input": CompanyRoleCreateInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"createCompanyRole": {"role": CompanyRole}}}
+                  
    {"data": {"createCompanyRole": {"role": CompanyRole}}}
 
    
-                    
-
    back to top @@ -10602,9 +10209,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation createCompanyTeam($input: CompanyTeamCreateInput!) {
+                  
    mutation createCompanyTeam($input: CompanyTeamCreateInput!) {
   createCompanyTeam(input: $input) {
     team {
       ...CompanyTeamFragment
@@ -10612,26 +10217,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": CompanyTeamCreateInput}
+                  
    {"input": CompanyTeamCreateInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"createCompanyTeam": {"team": CompanyTeam}}}
+                  
    {"data": {"createCompanyTeam": {"team": CompanyTeam}}}
 
    
-                    
-
    back to top @@ -10684,9 +10279,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation createCompanyUser($input: CompanyUserCreateInput!) {
+                  
    mutation createCompanyUser($input: CompanyUserCreateInput!) {
   createCompanyUser(input: $input) {
     user {
       ...CustomerFragment
@@ -10694,26 +10287,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": CompanyUserCreateInput}
+                  
    {"input": CompanyUserCreateInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"createCompanyUser": {"user": Customer}}}
+                  
    {"data": {"createCompanyUser": {"user": Customer}}}
 
    
-                    
-
    back to top @@ -10766,9 +10349,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation createCompareList($input: CreateCompareListInput) {
+                  
    mutation createCompareList($input: CreateCompareListInput) {
   createCompareList(input: $input) {
     attributes {
       ...ComparableAttributeFragment
@@ -10781,35 +10362,25 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": CreateCompareListInput}
+                  
    {"input": CreateCompareListInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "createCompareList": {
       "attributes": [ComparableAttribute],
-      "item_count": 123,
+      "item_count": 987,
       "items": [ComparableItem],
       "uid": 4
     }
   }
 }
 
    
-                    
-
    back to top @@ -10862,9 +10433,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation createCustomerAddress($input: CustomerAddressInput!) {
+                  
    mutation createCustomerAddress($input: CustomerAddressInput!) {
   createCustomerAddress(input: $input) {
     city
     company
@@ -10891,55 +10460,47 @@ 
    Query
    
     street
     suffix
     telephone
+    uid
     vat_id
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": CustomerAddressInput}
+                  
    {"input": CustomerAddressInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "createCustomerAddress": {
       "city": "xyz789",
-      "company": "abc123",
+      "company": "xyz789",
       "country_code": "AF",
       "custom_attributesV2": [AttributeValueInterface],
-      "default_billing": false,
-      "default_shipping": true,
+      "default_billing": true,
+      "default_shipping": false,
       "extension_attributes": [CustomerAddressAttribute],
       "fax": "xyz789",
-      "firstname": "abc123",
-      "id": 987,
-      "lastname": "xyz789",
+      "firstname": "xyz789",
+      "id": 123,
+      "lastname": "abc123",
       "middlename": "abc123",
-      "postcode": "xyz789",
-      "prefix": "abc123",
+      "postcode": "abc123",
+      "prefix": "xyz789",
       "region": CustomerAddressRegion,
-      "region_id": 123,
+      "region_id": 987,
       "street": ["xyz789"],
       "suffix": "xyz789",
-      "telephone": "abc123",
-      "vat_id": "xyz789"
+      "telephone": "xyz789",
+      "uid": "4",
+      "vat_id": "abc123"
     }
   }
 }
 
    
-                    
-
    back to top @@ -10991,9 +10552,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation createCustomerV2($input: CustomerCreateInput!) {
+                  
    mutation createCustomerV2($input: CustomerCreateInput!) {
   createCustomerV2(input: $input) {
     customer {
       ...CustomerFragment
@@ -11001,26 +10560,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": CustomerCreateInput}
+                  
    {"input": CustomerCreateInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"createCustomerV2": {"customer": Customer}}}
+                  
    {"data": {"createCustomerV2": {"customer": Customer}}}
 
    
-                    
-
    back to top @@ -11072,9 +10621,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) {
+                  
    mutation createGiftRegistry($giftRegistry: CreateGiftRegistryInput!) {
   createGiftRegistry(giftRegistry: $giftRegistry) {
     gift_registry {
       ...GiftRegistryFragment
@@ -11082,30 +10629,20 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"giftRegistry": CreateGiftRegistryInput}
+                  
    {"giftRegistry": CreateGiftRegistryInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "createGiftRegistry": {"gift_registry": GiftRegistry}
   }
 }
 
    
-                    
-
    back to top @@ -11158,9 +10695,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation createGuestCart($input: CreateGuestCartInput) {
+                  
    mutation createGuestCart($input: CreateGuestCartInput) {
   createGuestCart(input: $input) {
     cart {
       ...CartFragment
@@ -11168,26 +10703,16 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": CreateGuestCartInput}
+                  
    {"input": CreateGuestCartInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"createGuestCart": {"cart": Cart}}}
+                  
    {"data": {"createGuestCart": {"cart": Cart}}}
 
    
-                    
-
    back to top @@ -11239,9 +10764,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation createPaymentOrder($input: CreatePaymentOrderInput!) {
+                  
    mutation createPaymentOrder($input: CreatePaymentOrderInput!) {
   createPaymentOrder(input: $input) {
     amount
     currency_code
@@ -11251,36 +10774,26 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": CreatePaymentOrderInput}
+                  
    {"input": CreatePaymentOrderInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "createPaymentOrder": {
       "amount": 987.65,
-      "currency_code": "abc123",
-      "id": "xyz789",
-      "mp_order_id": "xyz789",
+      "currency_code": "xyz789",
+      "id": "abc123",
+      "mp_order_id": "abc123",
       "status": "xyz789"
     }
   }
 }
 
    
-                    
-
    back to top @@ -11333,9 +10846,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput!) {
+                  
    mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput!) {
   createPurchaseOrderApprovalRule(input: $input) {
     applies_to_roles {
       ...CompanyRoleFragment
@@ -11356,41 +10867,31 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": PurchaseOrderApprovalRuleInput}
+                  
    {"input": PurchaseOrderApprovalRuleInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "createPurchaseOrderApprovalRule": {
       "applies_to_roles": [CompanyRole],
       "approver_roles": [CompanyRole],
       "condition": PurchaseOrderApprovalRuleConditionInterface,
-      "created_at": "xyz789",
+      "created_at": "abc123",
       "created_by": "xyz789",
       "description": "xyz789",
-      "name": "abc123",
+      "name": "xyz789",
       "status": "ENABLED",
       "uid": "4",
-      "updated_at": "xyz789"
+      "updated_at": "abc123"
     }
   }
 }
 
    
-                    
-
    back to top @@ -11443,9 +10944,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation createRequisitionList($input: CreateRequisitionListInput) {
+                  
    mutation createRequisitionList($input: CreateRequisitionListInput) {
   createRequisitionList(input: $input) {
     requisition_list {
       ...RequisitionListFragment
@@ -11453,23 +10952,15 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": CreateRequisitionListInput}
+                  
    {"input": CreateRequisitionListInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "createRequisitionList": {
       "requisition_list": RequisitionList
@@ -11477,8 +10968,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -11530,9 +11019,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) {
+                  
    mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) {
   createVaultCardPaymentToken(input: $input) {
     payment_source {
       ...PaymentSourceOutputFragment
@@ -11541,33 +11028,23 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": CreateVaultCardPaymentTokenInput}
+                  
    {"input": CreateVaultCardPaymentTokenInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "createVaultCardPaymentToken": {
       "payment_source": PaymentSourceOutput,
-      "vault_token_id": "xyz789"
+      "vault_token_id": "abc123"
     }
   }
 }
 
    
-                    
-
    back to top @@ -11619,40 +11096,28 @@
    Arguments

    Example

    Query
    - - - 
    mutation createVaultCardSetupToken($input: CreateVaultCardSetupTokenInput!) {
+                  
    mutation createVaultCardSetupToken($input: CreateVaultCardSetupTokenInput!) {
   createVaultCardSetupToken(input: $input) {
     setup_token
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": CreateVaultCardSetupTokenInput}
+                  
    {"input": CreateVaultCardSetupTokenInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "createVaultCardSetupToken": {
-      "setup_token": "abc123"
+      "setup_token": "xyz789"
     }
   }
 }
 
    
-                    
-
    back to top @@ -11704,9 +11169,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation createWishlist($input: CreateWishlistInput!) {
+                  
    mutation createWishlist($input: CreateWishlistInput!) {
   createWishlist(input: $input) {
     wishlist {
       ...WishlistFragment
@@ -11714,26 +11177,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": CreateWishlistInput}
+                  
    {"input": CreateWishlistInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"createWishlist": {"wishlist": Wishlist}}}
+                  
    {"data": {"createWishlist": {"wishlist": Wishlist}}}
 
    
-                    
-
    back to top @@ -11786,34 +11239,22 @@
    Arguments

    Example

    Query
    - - - 
    mutation deleteCompanyRole($id: ID!) {
+                  
    mutation deleteCompanyRole($id: ID!) {
   deleteCompanyRole(id: $id) {
     success
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"id": 4}
+                  
    {"id": 4}
 
    
-                    
-
    Response
    - - - 
    {"data": {"deleteCompanyRole": {"success": false}}}
+                  
    {"data": {"deleteCompanyRole": {"success": true}}}
 
    
-                    
-
    back to top @@ -11866,34 +11307,22 @@
    Arguments

    Example

    Query
    - - - 
    mutation deleteCompanyTeam($id: ID!) {
+                  
    mutation deleteCompanyTeam($id: ID!) {
   deleteCompanyTeam(id: $id) {
     success
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"id": 4}
+                  
    {"id": 4}
 
    
-                    
-
    Response
    - - - 
    {"data": {"deleteCompanyTeam": {"success": true}}}
+                  
    {"data": {"deleteCompanyTeam": {"success": false}}}
 
    
-                    
-
    back to top @@ -11946,34 +11375,22 @@
    Arguments

    Example

    Query
    - - - 
    mutation deleteCompanyUserV2($id: ID!) {
+                  
    mutation deleteCompanyUserV2($id: ID!) {
   deleteCompanyUserV2(id: $id) {
     success
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"id": 4}
+                  
    {"id": "4"}
 
    
-                    
-
    Response
    - - - 
    {"data": {"deleteCompanyUserV2": {"success": true}}}
+                  
    {"data": {"deleteCompanyUserV2": {"success": true}}}
 
    
-                    
-
    back to top @@ -12025,34 +11442,22 @@
    Arguments

    Example

    Query
    - - - 
    mutation deleteCompareList($uid: ID!) {
+                  
    mutation deleteCompareList($uid: ID!) {
   deleteCompareList(uid: $uid) {
     result
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"uid": 4}
+                  
    {"uid": "4"}
 
    
-                    
-
    Response
    - - - 
    {"data": {"deleteCompareList": {"result": false}}}
+                  
    {"data": {"deleteCompareList": {"result": false}}}
 
    
-                    
-
    back to top @@ -12085,23 +11490,15 @@
    Response

    Example

    Query
    - - - 
    mutation deleteCustomer {
+                  
    mutation deleteCustomer {
   deleteCustomer
 }
 
    
-                    
-
    Response
    - - - 
    {"data": {"deleteCustomer": false}}
+                  
    {"data": {"deleteCustomer": true}}
 
    
-                    
-
    back to top @@ -12111,9 +11508,16 @@
    Response
    Mutations
    -

    +

    deleteCustomerAddress

    +
    +
    +
    +
    Use deleteCustomerAddressV2 instead.
    +
    +
    +
    @@ -12153,32 +11557,85 @@
    Arguments

    Example

    Query
    - - - 
    mutation deleteCustomerAddress($id: Int!) {
+                  
    mutation deleteCustomerAddress($id: Int!) {
   deleteCustomerAddress(id: $id)
 }
 
    
-                    
-
    Variables
    - - - 
    {"id": 987}
+                  
    {"id": 123}
+
    
+
    +
    +
    Response
    + 
    {"data": {"deleteCustomerAddress": true}}
+
    +
    +
    + back to top +
    +
    +
    +
    + Mutations +
    +

    + deleteCustomerAddressV2 +

    +
    +
    +
    +
    Description
    +

    Delete the billing or shipping address of a customer.

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a Boolean +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + uid - ID! + The unique ID of the customer address to be deleted.
    +
    +
    +
    +

    Example

    +
    +
    Query
    + 
    mutation deleteCustomerAddressV2($uid: ID!) {
+  deleteCustomerAddressV2(uid: $uid)
+}
+
    +
    +
    +
    Variables
    + 
    {"uid": 4}
    - -
    Response
    - - - 
    {"data": {"deleteCustomerAddress": false}}
+                  
    {"data": {"deleteCustomerAddressV2": true}}
 
    
-                    
-
    back to top @@ -12230,32 +11687,20 @@
    Arguments

    Example

    Query
    - - - 
    mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInput!) {
+                  
    mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInput!) {
   deleteNegotiableQuoteTemplate(input: $input)
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": DeleteNegotiableQuoteTemplateInput}
+                  
    {"input": DeleteNegotiableQuoteTemplateInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"deleteNegotiableQuoteTemplate": false}}
+                  
    {"data": {"deleteNegotiableQuoteTemplate": true}}
 
    
-                    
-
    back to top @@ -12307,9 +11752,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation deleteNegotiableQuotes($input: DeleteNegotiableQuotesInput!) {
+                  
    mutation deleteNegotiableQuotes($input: DeleteNegotiableQuotesInput!) {
   deleteNegotiableQuotes(input: $input) {
     negotiable_quotes {
       ...NegotiableQuotesOutputFragment
@@ -12326,23 +11769,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": DeleteNegotiableQuotesInput}
+                  
    {"input": DeleteNegotiableQuotesInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "deleteNegotiableQuotes": {
       "negotiable_quotes": NegotiableQuotesOutput,
@@ -12354,8 +11789,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -12407,9 +11840,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation deletePaymentToken($public_hash: String!) {
+                  
    mutation deletePaymentToken($public_hash: String!) {
   deletePaymentToken(public_hash: $public_hash) {
     customerPaymentTokens {
       ...CustomerPaymentTokensFragment
@@ -12418,33 +11849,23 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"public_hash": "xyz789"}
+                  
    {"public_hash": "abc123"}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "deletePaymentToken": {
       "customerPaymentTokens": CustomerPaymentTokens,
-      "result": false
+      "result": true
     }
   }
 }
 
    
-                    
-
    back to top @@ -12497,9 +11918,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRuleInput!) {
+                  
    mutation deletePurchaseOrderApprovalRule($input: DeletePurchaseOrderApprovalRuleInput!) {
   deletePurchaseOrderApprovalRule(input: $input) {
     errors {
       ...DeletePurchaseOrderApprovalRuleErrorFragment
@@ -12507,23 +11926,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": DeletePurchaseOrderApprovalRuleInput}
+                  
    {"input": DeletePurchaseOrderApprovalRuleInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "deletePurchaseOrderApprovalRule": {
       "errors": [DeletePurchaseOrderApprovalRuleError]
@@ -12531,8 +11942,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -12584,9 +11993,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation deleteRequisitionList($requisitionListUid: ID!) {
+                  
    mutation deleteRequisitionList($requisitionListUid: ID!) {
   deleteRequisitionList(requisitionListUid: $requisitionListUid) {
     requisition_lists {
       ...RequisitionListsFragment
@@ -12595,23 +12002,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"requisitionListUid": "4"}
+                  
    {"requisitionListUid": "4"}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "deleteRequisitionList": {
       "requisition_lists": RequisitionLists,
@@ -12620,8 +12019,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -12679,9 +12076,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation deleteRequisitionListItems(
+                  
    mutation deleteRequisitionListItems(
   $requisitionListUid: ID!,
   $requisitionListItemUids: [ID!]!
 ) {
@@ -12695,26 +12090,18 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
+                  
    {
   "requisitionListUid": "4",
   "requisitionListItemUids": ["4"]
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "deleteRequisitionListItems": {
       "requisition_list": RequisitionList
@@ -12722,8 +12109,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -12775,9 +12160,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation deleteWishlist($wishlistId: ID!) {
+                  
    mutation deleteWishlist($wishlistId: ID!) {
   deleteWishlist(wishlistId: $wishlistId) {
     status
     wishlists {
@@ -12786,23 +12169,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"wishlistId": 4}
+                  
    {"wishlistId": 4}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "deleteWishlist": {
       "status": true,
@@ -12811,8 +12186,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -12864,9 +12237,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation duplicateNegotiableQuote($input: DuplicateNegotiableQuoteInput!) {
+                  
    mutation duplicateNegotiableQuote($input: DuplicateNegotiableQuoteInput!) {
   duplicateNegotiableQuote(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -12874,30 +12245,20 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": DuplicateNegotiableQuoteInput}
+                  
    {"input": DuplicateNegotiableQuoteInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "duplicateNegotiableQuote": {"quote": NegotiableQuote}
   }
 }
 
    
-                    
-
    back to top @@ -12949,9 +12310,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation estimateShippingMethods($input: EstimateTotalsInput!) {
+                  
    mutation estimateShippingMethods($input: EstimateTotalsInput!) {
   estimateShippingMethods(input: $input) {
     additional_data {
       ...ShippingAdditionalDataFragment
@@ -12974,32 +12333,24 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": EstimateTotalsInput}
+                  
    {"input": EstimateTotalsInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "estimateShippingMethods": [
       {
         "additional_data": [ShippingAdditionalData],
         "amount": Money,
-        "available": false,
+        "available": true,
         "carrier_code": "abc123",
         "carrier_title": "xyz789",
-        "error_message": "xyz789",
+        "error_message": "abc123",
         "method_code": "abc123",
         "method_title": "xyz789",
         "price_excl_tax": Money,
@@ -13009,8 +12360,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -13062,9 +12411,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation estimateTotals($input: EstimateTotalsInput!) {
+                  
    mutation estimateTotals($input: EstimateTotalsInput!) {
   estimateTotals(input: $input) {
     cart {
       ...CartFragment
@@ -13072,26 +12419,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": EstimateTotalsInput}
+                  
    {"input": EstimateTotalsInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"estimateTotals": {"cart": Cart}}}
+                  
    {"data": {"estimateTotals": {"cart": Cart}}}
 
    
-                    
-
    back to top @@ -13143,9 +12480,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation exchangeExternalCustomerToken($input: ExchangeExternalCustomerTokenInput) {
+                  
    mutation exchangeExternalCustomerToken($input: ExchangeExternalCustomerTokenInput) {
   exchangeExternalCustomerToken(input: $input) {
     customer {
       ...CustomerFragment
@@ -13154,23 +12489,15 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": ExchangeExternalCustomerTokenInput}
+                  
    {"input": ExchangeExternalCustomerTokenInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "exchangeExternalCustomerToken": {
       "customer": Customer,
@@ -13179,8 +12506,164 @@ 
    Response
    
   }
 }
 
    
-                    
-                  
+
    + + back to top + +
    +
    +
    + Mutations +
    +

    + exchangeOtpForCustomerToken +

    +
    +
    +
    +
    Description
    +

    Exchange a customer's one time password for a customer token.

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a CustomerToken +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + + + + + +
    NameDescription
    + email - String! + The customer's email address.
    + otp - String! + The customer's OTP.
    +
    +
    +
    +

    Example

    +
    +
    Query
    + 
    mutation exchangeOtpForCustomerToken(
+  $email: String!,
+  $otp: String!
+) {
+  exchangeOtpForCustomerToken(
+    email: $email,
+    otp: $otp
+  ) {
+    token
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {
+  "email": "abc123",
+  "otp": "xyz789"
+}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "exchangeOtpForCustomerToken": {
+      "token": "xyz789"
+    }
+  }
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Mutations +
    +

    + finishUpload +

    +
    +
    +
    +
    Response
    +

    Returns a finishUploadOutput +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - finishUploadInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    + 
    mutation finishUpload($input: finishUploadInput!) {
+  finishUpload(input: $input) {
+    key
+    message
+    success
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {"input": finishUploadInput}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "finishUpload": {
+      "key": "abc123",
+      "message": "xyz789",
+      "success": false
+    }
+  }
+}
+
    back to top @@ -13238,9 +12721,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation generateCustomerToken(
+                  
    mutation generateCustomerToken(
   $email: String!,
   $password: String!
 ) {
@@ -13252,26 +12733,18 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
+                  
    {
   "email": "xyz789",
-  "password": "abc123"
+  "password": "xyz789"
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "generateCustomerToken": {
       "token": "abc123"
@@ -13279,8 +12752,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -13332,40 +12803,28 @@
    Arguments

    Example

    Query
    - - - 
    mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput!) {
+                  
    mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput!) {
   generateCustomerTokenAsAdmin(input: $input) {
     customer_token
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": GenerateCustomerTokenAsAdminInput}
+                  
    {"input": GenerateCustomerTokenAsAdminInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "generateCustomerTokenAsAdmin": {
-      "customer_token": "xyz789"
+      "customer_token": "abc123"
     }
   }
 }
 
    
-                    
-
    back to top @@ -13417,34 +12876,92 @@
    Arguments

    Example

    Query
    - - - 
    mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFromTemplateInput!) {
+                  
    mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFromTemplateInput!) {
   generateNegotiableQuoteFromTemplate(input: $input) {
     negotiable_quote_uid
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": GenerateNegotiableQuoteFromTemplateInput}
+                  
    {"input": GenerateNegotiableQuoteFromTemplateInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"generateNegotiableQuoteFromTemplate": {"negotiable_quote_uid": 4}}}
+                  
    {"data": {"generateNegotiableQuoteFromTemplate": {"negotiable_quote_uid": 4}}}
+
    
+
    + + back to top + +
    +
    +
    + Mutations +
    +

    + initiateUpload +

    +
    +
    +
    +
    Response
    +

    Returns an initiateUploadOutput +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - initiateUploadInput! + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    + 
    mutation initiateUpload($input: initiateUploadInput!) {
+  initiateUpload(input: $input) {
+    expires_at
+    key
+    upload_url
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {"input": initiateUploadInput}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "initiateUpload": {
+      "expires_at": "xyz789",
+      "key": "xyz789",
+      "upload_url": "abc123"
+    }
+  }
+}
    - -
    back to top @@ -13502,9 +13019,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation mergeCarts(
+                  
    mutation mergeCarts(
   $source_cart_id: String!,
   $destination_cart_id: String
 ) {
@@ -13566,26 +13081,18 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
-  "source_cart_id": "xyz789",
+                  
    {
+  "source_cart_id": "abc123",
   "destination_cart_id": "abc123"
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "mergeCarts": {
       "applied_coupons": [AppliedCoupon],
@@ -13600,13 +13107,13 @@ 
    Response
    
       "custom_attributes": [CustomAttribute],
       "email": "xyz789",
       "gift_message": GiftMessage,
-      "gift_receipt_included": true,
+      "gift_receipt_included": false,
       "gift_wrapping": GiftWrapping,
       "id": "4",
       "is_virtual": true,
       "itemsV2": CartItems,
       "prices": CartPrices,
-      "printed_card_included": false,
+      "printed_card_included": true,
       "rules": [CartRuleStorefront],
       "selected_payment_method": SelectedPaymentMethod,
       "shipping_addresses": [ShippingCartAddress],
@@ -13615,8 +13122,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -13674,9 +13179,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation moveCartItemsToGiftRegistry(
+                  
    mutation moveCartItemsToGiftRegistry(
   $cartUid: ID!,
   $giftRegistryUid: ID!
 ) {
@@ -13694,34 +13197,24 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"cartUid": 4, "giftRegistryUid": 4}
+                  
    {"cartUid": "4", "giftRegistryUid": 4}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "moveCartItemsToGiftRegistry": {
       "gift_registry": GiftRegistry,
-      "status": true,
+      "status": false,
       "user_errors": [GiftRegistryItemsUserError]
     }
   }
 }
 
    
-                    
-
    back to top @@ -13785,9 +13278,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation moveItemsBetweenRequisitionLists(
+                  
    mutation moveItemsBetweenRequisitionLists(
   $sourceRequisitionListUid: ID!,
   $destinationRequisitionListUid: ID,
   $requisitionListItem: MoveItemsBetweenRequisitionListsInput
@@ -13806,27 +13297,19 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {
+                  
    {
   "sourceRequisitionListUid": "4",
   "destinationRequisitionListUid": 4,
   "requisitionListItem": MoveItemsBetweenRequisitionListsInput
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "moveItemsBetweenRequisitionLists": {
       "destination_requisition_list": RequisitionList,
@@ -13835,8 +13318,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -13888,9 +13369,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation moveLineItemToRequisitionList($input: MoveLineItemToRequisitionListInput!) {
+                  
    mutation moveLineItemToRequisitionList($input: MoveLineItemToRequisitionListInput!) {
   moveLineItemToRequisitionList(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -13898,23 +13377,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": MoveLineItemToRequisitionListInput}
+                  
    {"input": MoveLineItemToRequisitionListInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "moveLineItemToRequisitionList": {
       "quote": NegotiableQuote
@@ -13922,8 +13393,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -13987,9 +13456,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation moveProductsBetweenWishlists(
+                  
    mutation moveProductsBetweenWishlists(
   $sourceWishlistUid: ID!,
   $destinationWishlistUid: ID!,
   $wishlistItems: [WishlistItemMoveInput!]!
@@ -14011,27 +13478,19 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
-  "sourceWishlistUid": "4",
-  "destinationWishlistUid": 4,
+                  
    {
+  "sourceWishlistUid": 4,
+  "destinationWishlistUid": "4",
   "wishlistItems": [WishlistItemMoveInput]
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "moveProductsBetweenWishlists": {
       "destination_wishlist": Wishlist,
@@ -14041,8 +13500,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -14094,9 +13551,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) {
+                  
    mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) {
   openNegotiableQuoteTemplate(input: $input) {
     buyer {
       ...NegotiableQuoteUserFragment
@@ -14104,10 +13559,14 @@ 
    Query
    
     comments {
       ...NegotiableQuoteCommentFragment
     }
+    created_at
     expiration_date
     history {
       ...NegotiableQuoteHistoryEntryFragment
     }
+    historyV2 {
+      ...NegotiableQuoteTemplateHistoryEntryFragment
+    }
     is_min_max_qty_used
     is_virtual
     items {
@@ -14125,61 +13584,59 @@ 
    Query
    
     reference_document_links {
       ...NegotiableQuoteReferenceDocumentLinkFragment
     }
+    sales_rep_name
     shipping_addresses {
       ...NegotiableQuoteShippingAddressFragment
     }
     status
     template_id
     total_quantity
+    uid
+    updated_at
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": OpenNegotiableQuoteTemplateInput}
+                  
    {"input": OpenNegotiableQuoteTemplateInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "openNegotiableQuoteTemplate": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
-      "expiration_date": "xyz789",
+      "created_at": "xyz789",
+      "expiration_date": "abc123",
       "history": [NegotiableQuoteHistoryEntry],
+      "historyV2": [NegotiableQuoteTemplateHistoryEntry],
       "is_min_max_qty_used": true,
       "is_virtual": true,
       "items": [CartItemInterface],
-      "max_order_commitment": 987,
+      "max_order_commitment": 123,
       "min_order_commitment": 123,
-      "name": "xyz789",
+      "name": "abc123",
       "notifications": [QuoteTemplateNotificationMessage],
       "prices": CartPrices,
       "reference_document_links": [
         NegotiableQuoteReferenceDocumentLink
       ],
+      "sales_rep_name": "abc123",
       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
-      "status": "xyz789",
-      "template_id": "4",
-      "total_quantity": 987.65
+      "status": "abc123",
+      "template_id": 4,
+      "total_quantity": 123.45,
+      "uid": 4,
+      "updated_at": "xyz789"
     }
   }
 }
 
    
-                    
-
    back to top @@ -14189,9 +13646,16 @@
    Response
    Mutations
    -

    +

    placeNegotiableQuoteOrder

    +
    +
    +
    +
    Use placeNegotiableQuoteOrderV2 instead.
    +
    +
    +
    @@ -14231,9 +13695,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) {
+                  
    mutation placeNegotiableQuoteOrder($input: PlaceNegotiableQuoteOrderInput!) {
   placeNegotiableQuoteOrder(input: $input) {
     order {
       ...OrderFragment
@@ -14241,26 +13703,95 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": PlaceNegotiableQuoteOrderInput}
+                  
    {"input": PlaceNegotiableQuoteOrderInput}
+
    
+
    +
    +
    Response
    + 
    {"data": {"placeNegotiableQuoteOrder": {"order": Order}}}
+
    +
    +
    + back to top +
    +
    +
    +
    + Mutations +
    +

    + placeNegotiableQuoteOrderV2 +

    +
    +
    +
    +
    Description
    +

    Convert a negotiable quote into an order.

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a PlaceNegotiableQuoteOrderOutputV2 +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - PlaceNegotiableQuoteOrderInput! + An input object that specifies the negotiable quote.
    +
    +
    +
    +

    Example

    +
    +
    Query
    + 
    mutation placeNegotiableQuoteOrderV2($input: PlaceNegotiableQuoteOrderInput!) {
+  placeNegotiableQuoteOrderV2(input: $input) {
+    errors {
+      ...PlaceOrderErrorFragment
+    }
+    order {
+      ...CustomerOrderFragment
+    }
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {"input": PlaceNegotiableQuoteOrderInput}
    - -
    Response
    - - - 
    {"data": {"placeNegotiableQuoteOrder": {"order": Order}}}
+                  
    {
+  "data": {
+    "placeNegotiableQuoteOrderV2": {
+      "errors": [PlaceOrderError],
+      "order": CustomerOrder
+    }
+  }
+}
 
    
-                    
-
    back to top @@ -14312,9 +13843,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation placeOrder($input: PlaceOrderInput) {
+                  
    mutation placeOrder($input: PlaceOrderInput) {
   placeOrder(input: $input) {
     errors {
       ...PlaceOrderErrorFragment
@@ -14325,23 +13854,15 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": PlaceOrderInput}
+                  
    {"input": PlaceOrderInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "placeOrder": {
       "errors": [PlaceOrderError],
@@ -14350,8 +13871,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -14404,9 +13923,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) {
+                  
    mutation placeOrderForPurchaseOrder($input: PlaceOrderForPurchaseOrderInput!) {
   placeOrderForPurchaseOrder(input: $input) {
     order {
       ...CustomerOrderFragment
@@ -14414,30 +13931,20 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": PlaceOrderForPurchaseOrderInput}
+                  
    {"input": PlaceOrderForPurchaseOrderInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "placeOrderForPurchaseOrder": {"order": CustomerOrder}
   }
 }
 
    
-                    
-
    back to top @@ -14490,9 +13997,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) {
+                  
    mutation placePurchaseOrder($input: PlacePurchaseOrderInput!) {
   placePurchaseOrder(input: $input) {
     purchase_order {
       ...PurchaseOrderFragment
@@ -14500,23 +14005,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": PlacePurchaseOrderInput}
+                  
    {"input": PlacePurchaseOrderInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "placePurchaseOrder": {
       "purchase_order": PurchaseOrder
@@ -14524,8 +14021,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -14577,9 +14072,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) {
+                  
    mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) {
   redeemGiftCardBalanceAsStoreCredit(input: $input) {
     balance {
       ...MoneyFragment
@@ -14589,34 +14082,24 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": GiftCardAccountInput}
+                  
    {"input": GiftCardAccountInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "redeemGiftCardBalanceAsStoreCredit": {
       "balance": Money,
-      "code": "xyz789",
-      "expiration_date": "xyz789"
+      "code": "abc123",
+      "expiration_date": "abc123"
     }
   }
 }
 
    
-                    
-
    back to top @@ -14669,9 +14152,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation rejectPurchaseOrders($input: PurchaseOrdersActionInput!) {
+                  
    mutation rejectPurchaseOrders($input: PurchaseOrdersActionInput!) {
   rejectPurchaseOrders(input: $input) {
     errors {
       ...PurchaseOrderActionErrorFragment
@@ -14682,23 +14163,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": PurchaseOrdersActionInput}
+                  
    {"input": PurchaseOrdersActionInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "rejectPurchaseOrders": {
       "errors": [PurchaseOrderActionError],
@@ -14707,8 +14180,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -14760,9 +14231,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation removeCouponFromCart($input: RemoveCouponFromCartInput) {
+                  
    mutation removeCouponFromCart($input: RemoveCouponFromCartInput) {
   removeCouponFromCart(input: $input) {
     cart {
       ...CartFragment
@@ -14770,26 +14239,16 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": RemoveCouponFromCartInput}
+                  
    {"input": RemoveCouponFromCartInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"removeCouponFromCart": {"cart": Cart}}}
+                  
    {"data": {"removeCouponFromCart": {"cart": Cart}}}
 
    
-                    
-
    back to top @@ -14841,9 +14300,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation removeCouponsFromCart($input: RemoveCouponsFromCartInput) {
+                  
    mutation removeCouponsFromCart($input: RemoveCouponsFromCartInput) {
   removeCouponsFromCart(input: $input) {
     cart {
       ...CartFragment
@@ -14851,26 +14308,16 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": RemoveCouponsFromCartInput}
+                  
    {"input": RemoveCouponsFromCartInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"removeCouponsFromCart": {"cart": Cart}}}
+                  
    {"data": {"removeCouponsFromCart": {"cart": Cart}}}
 
    
-                    
-
    back to top @@ -14922,9 +14369,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) {
+                  
    mutation removeGiftCardFromCart($input: RemoveGiftCardFromCartInput) {
   removeGiftCardFromCart(input: $input) {
     cart {
       ...CartFragment
@@ -14932,26 +14377,16 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": RemoveGiftCardFromCartInput}
+                  
    {"input": RemoveGiftCardFromCartInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"removeGiftCardFromCart": {"cart": Cart}}}
+                  
    {"data": {"removeGiftCardFromCart": {"cart": Cart}}}
 
    
-                    
-
    back to top @@ -15003,34 +14438,22 @@
    Arguments

    Example

    Query
    - - - 
    mutation removeGiftRegistry($giftRegistryUid: ID!) {
+                  
    mutation removeGiftRegistry($giftRegistryUid: ID!) {
   removeGiftRegistry(giftRegistryUid: $giftRegistryUid) {
     success
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"giftRegistryUid": "4"}
+                  
    {"giftRegistryUid": "4"}
 
    
-                    
-
    Response
    - - - 
    {"data": {"removeGiftRegistry": {"success": true}}}
+                  
    {"data": {"removeGiftRegistry": {"success": true}}}
 
    
-                    
-
    back to top @@ -15088,9 +14511,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation removeGiftRegistryItems(
+                  
    mutation removeGiftRegistryItems(
   $giftRegistryUid: ID!,
   $itemsUid: [ID!]!
 ) {
@@ -15104,23 +14525,15 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"giftRegistryUid": 4, "itemsUid": [4]}
+                  
    {"giftRegistryUid": 4, "itemsUid": [4]}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "removeGiftRegistryItems": {
       "gift_registry": GiftRegistry
@@ -15128,8 +14541,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -15187,9 +14598,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation removeGiftRegistryRegistrants(
+                  
    mutation removeGiftRegistryRegistrants(
   $giftRegistryUid: ID!,
   $registrantsUid: [ID!]!
 ) {
@@ -15203,26 +14612,18 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
+                  
    {
   "giftRegistryUid": "4",
   "registrantsUid": ["4"]
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "removeGiftRegistryRegistrants": {
       "gift_registry": GiftRegistry
@@ -15230,8 +14631,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -15283,9 +14682,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation removeItemFromCart($input: RemoveItemFromCartInput) {
+                  
    mutation removeItemFromCart($input: RemoveItemFromCartInput) {
   removeItemFromCart(input: $input) {
     cart {
       ...CartFragment
@@ -15293,26 +14690,16 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": RemoveItemFromCartInput}
+                  
    {"input": RemoveItemFromCartInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"removeItemFromCart": {"cart": Cart}}}
+                  
    {"data": {"removeItemFromCart": {"cart": Cart}}}
 
    
-                    
-
    back to top @@ -15364,9 +14751,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) {
+                  
    mutation removeNegotiableQuoteItems($input: RemoveNegotiableQuoteItemsInput!) {
   removeNegotiableQuoteItems(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -15374,23 +14759,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": RemoveNegotiableQuoteItemsInput}
+                  
    {"input": RemoveNegotiableQuoteItemsInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "removeNegotiableQuoteItems": {
       "quote": NegotiableQuote
@@ -15398,8 +14775,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -15451,9 +14826,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplateItemsInput!) {
+                  
    mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplateItemsInput!) {
   removeNegotiableQuoteTemplateItems(input: $input) {
     buyer {
       ...NegotiableQuoteUserFragment
@@ -15461,10 +14834,14 @@ 
    Query
    
     comments {
       ...NegotiableQuoteCommentFragment
     }
+    created_at
     expiration_date
     history {
       ...NegotiableQuoteHistoryEntryFragment
     }
+    historyV2 {
+      ...NegotiableQuoteTemplateHistoryEntryFragment
+    }
     is_min_max_qty_used
     is_virtual
     items {
@@ -15482,42 +14859,39 @@ 
    Query
    
     reference_document_links {
       ...NegotiableQuoteReferenceDocumentLinkFragment
     }
+    sales_rep_name
     shipping_addresses {
       ...NegotiableQuoteShippingAddressFragment
     }
     status
     template_id
     total_quantity
+    uid
+    updated_at
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": RemoveNegotiableQuoteTemplateItemsInput}
+                  
    {"input": RemoveNegotiableQuoteTemplateItemsInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "removeNegotiableQuoteTemplateItems": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
+      "created_at": "abc123",
       "expiration_date": "xyz789",
       "history": [NegotiableQuoteHistoryEntry],
+      "historyV2": [NegotiableQuoteTemplateHistoryEntry],
       "is_min_max_qty_used": false,
       "is_virtual": false,
       "items": [CartItemInterface],
-      "max_order_commitment": 123,
+      "max_order_commitment": 987,
       "min_order_commitment": 987,
       "name": "xyz789",
       "notifications": [QuoteTemplateNotificationMessage],
@@ -15525,18 +14899,19 @@ 
    Response
    
       "reference_document_links": [
         NegotiableQuoteReferenceDocumentLink
       ],
+      "sales_rep_name": "abc123",
       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
-      "status": "xyz789",
+      "status": "abc123",
       "template_id": "4",
-      "total_quantity": 987.65
+      "total_quantity": 987.65,
+      "uid": 4,
+      "updated_at": "xyz789"
     }
   }
 }
 
    
-                    
-
    back to top @@ -15588,9 +14963,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInput) {
+                  
    mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInput) {
   removeProductsFromCompareList(input: $input) {
     attributes {
       ...ComparableAttributeFragment
@@ -15603,23 +14976,15 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": RemoveProductsFromCompareListInput}
+                  
    {"input": RemoveProductsFromCompareListInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "removeProductsFromCompareList": {
       "attributes": [ComparableAttribute],
@@ -15630,8 +14995,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -15689,9 +15052,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation removeProductsFromWishlist(
+                  
    mutation removeProductsFromWishlist(
   $wishlistId: ID!,
   $wishlistItemsIds: [ID!]!
 ) {
@@ -15708,26 +15069,15 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
-  "wishlistId": "4",
-  "wishlistItemsIds": ["4"]
-}
+                  
    {"wishlistId": 4, "wishlistItemsIds": ["4"]}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "removeProductsFromWishlist": {
       "user_errors": [WishListUserInputError],
@@ -15736,8 +15086,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -15789,9 +15137,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation removeReturnTracking($input: RemoveReturnTrackingInput!) {
+                  
    mutation removeReturnTracking($input: RemoveReturnTrackingInput!) {
   removeReturnTracking(input: $input) {
     return {
       ...ReturnFragment
@@ -15799,26 +15145,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": RemoveReturnTrackingInput}
+                  
    {"input": RemoveReturnTrackingInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"removeReturnTracking": {"return": Return}}}
+                  
    {"data": {"removeReturnTracking": {"return": Return}}}
 
    
-                    
-
    back to top @@ -15871,9 +15207,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation removeRewardPointsFromCart($cartId: ID!) {
+                  
    mutation removeRewardPointsFromCart($cartId: ID!) {
   removeRewardPointsFromCart(cartId: $cartId) {
     cart {
       ...CartFragment
@@ -15881,26 +15215,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"cartId": "4"}
+                  
    {"cartId": 4}
 
    
-                    
-
    Response
    - - - 
    {"data": {"removeRewardPointsFromCart": {"cart": Cart}}}
+                  
    {"data": {"removeRewardPointsFromCart": {"cart": Cart}}}
 
    
-                    
-
    back to top @@ -15952,9 +15276,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) {
+                  
    mutation removeStoreCreditFromCart($input: RemoveStoreCreditFromCartInput!) {
   removeStoreCreditFromCart(input: $input) {
     cart {
       ...CartFragment
@@ -15962,26 +15284,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": RemoveStoreCreditFromCartInput}
+                  
    {"input": RemoveStoreCreditFromCartInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"removeStoreCreditFromCart": {"cart": Cart}}}
+                  
    {"data": {"removeStoreCreditFromCart": {"cart": Cart}}}
 
    
-                    
-
    back to top @@ -16033,9 +15345,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation renameNegotiableQuote($input: RenameNegotiableQuoteInput!) {
+                  
    mutation renameNegotiableQuote($input: RenameNegotiableQuoteInput!) {
   renameNegotiableQuote(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -16043,30 +15353,20 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": RenameNegotiableQuoteInput}
+                  
    {"input": RenameNegotiableQuoteInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "renameNegotiableQuote": {"quote": NegotiableQuote}
   }
 }
 
    
-                    
-
    back to top @@ -16119,9 +15419,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation reorderItems($orderNumber: String!) {
+                  
    mutation reorderItems($orderNumber: String!) {
   reorderItems(orderNumber: $orderNumber) {
     cart {
       ...CartFragment
@@ -16132,23 +15430,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"orderNumber": "xyz789"}
+                  
    {"orderNumber": "abc123"}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "reorderItems": {
       "cart": Cart,
@@ -16157,8 +15447,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -16211,9 +15499,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation requestGuestOrderCancel($input: GuestOrderCancelInput!) {
+                  
    mutation requestGuestOrderCancel($input: GuestOrderCancelInput!) {
   requestGuestOrderCancel(input: $input) {
     error
     errorV2 {
@@ -16225,23 +15511,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": GuestOrderCancelInput}
+                  
    {"input": GuestOrderCancelInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "requestGuestOrderCancel": {
       "error": "xyz789",
@@ -16251,8 +15529,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -16296,9 +15572,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation requestGuestReturn($input: RequestGuestReturnInput!) {
+                  
    mutation requestGuestReturn($input: RequestGuestReturnInput!) {
   requestGuestReturn(input: $input) {
     return {
       ...ReturnFragment
@@ -16309,23 +15583,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": RequestGuestReturnInput}
+                  
    {"input": RequestGuestReturnInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "requestGuestReturn": {
       "return": Return,
@@ -16334,8 +15600,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -16387,9 +15651,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) {
+                  
    mutation requestNegotiableQuote($input: RequestNegotiableQuoteInput!) {
   requestNegotiableQuote(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -16397,30 +15659,20 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": RequestNegotiableQuoteInput}
+                  
    {"input": RequestNegotiableQuoteInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "requestNegotiableQuote": {"quote": NegotiableQuote}
   }
 }
 
    
-                    
-
    back to top @@ -16472,9 +15724,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteTemplateInput!) {
+                  
    mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteTemplateInput!) {
   requestNegotiableQuoteTemplateFromQuote(input: $input) {
     buyer {
       ...NegotiableQuoteUserFragment
@@ -16482,10 +15732,14 @@ 
    Query
    
     comments {
       ...NegotiableQuoteCommentFragment
     }
+    created_at
     expiration_date
     history {
       ...NegotiableQuoteHistoryEntryFragment
     }
+    historyV2 {
+      ...NegotiableQuoteTemplateHistoryEntryFragment
+    }
     is_min_max_qty_used
     is_virtual
     items {
@@ -16503,61 +15757,59 @@ 
    Query
    
     reference_document_links {
       ...NegotiableQuoteReferenceDocumentLinkFragment
     }
+    sales_rep_name
     shipping_addresses {
       ...NegotiableQuoteShippingAddressFragment
     }
     status
     template_id
     total_quantity
+    uid
+    updated_at
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": RequestNegotiableQuoteTemplateInput}
+                  
    {"input": RequestNegotiableQuoteTemplateInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "requestNegotiableQuoteTemplateFromQuote": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
-      "expiration_date": "abc123",
+      "created_at": "xyz789",
+      "expiration_date": "xyz789",
       "history": [NegotiableQuoteHistoryEntry],
-      "is_min_max_qty_used": true,
+      "historyV2": [NegotiableQuoteTemplateHistoryEntry],
+      "is_min_max_qty_used": false,
       "is_virtual": false,
       "items": [CartItemInterface],
-      "max_order_commitment": 123,
+      "max_order_commitment": 987,
       "min_order_commitment": 123,
-      "name": "xyz789",
+      "name": "abc123",
       "notifications": [QuoteTemplateNotificationMessage],
       "prices": CartPrices,
       "reference_document_links": [
         NegotiableQuoteReferenceDocumentLink
       ],
+      "sales_rep_name": "xyz789",
       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
       "status": "abc123",
       "template_id": "4",
-      "total_quantity": 123.45
+      "total_quantity": 123.45,
+      "uid": "4",
+      "updated_at": "abc123"
     }
   }
 }
 
    
-                    
-
    back to top @@ -16609,32 +15861,20 @@
    Arguments

    Example

    Query
    - - - 
    mutation requestPasswordResetEmail($email: String!) {
+                  
    mutation requestPasswordResetEmail($email: String!) {
   requestPasswordResetEmail(email: $email)
 }
 
    
-                    
-
    Variables
    - - - 
    {"email": "abc123"}
+                  
    {"email": "xyz789"}
 
    
-                    
-
    Response
    - - - 
    {"data": {"requestPasswordResetEmail": true}}
+                  
    {"data": {"requestPasswordResetEmail": false}}
 
    
-                    
-
    back to top @@ -16686,9 +15926,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation requestReturn($input: RequestReturnInput!) {
+                  
    mutation requestReturn($input: RequestReturnInput!) {
   requestReturn(input: $input) {
     return {
       ...ReturnFragment
@@ -16699,23 +15937,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": RequestReturnInput}
+                  
    {"input": RequestReturnInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "requestReturn": {
       "return": Return,
@@ -16724,8 +15954,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -16777,32 +16005,20 @@
    Arguments

    Example

    Query
    - - - 
    mutation resendConfirmationEmail($email: String!) {
+                  
    mutation resendConfirmationEmail($email: String!) {
   resendConfirmationEmail(email: $email)
 }
 
    
-                    
-
    Variables
    - - - 
    {"email": "abc123"}
+                  
    {"email": "abc123"}
 
    
-                    
-
    Response
    - - - 
    {"data": {"resendConfirmationEmail": true}}
+                  
    {"data": {"resendConfirmationEmail": false}}
 
    
-                    
-
    back to top @@ -16866,9 +16082,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation resetPassword(
+                  
    mutation resetPassword(
   $email: String!,
   $resetPasswordToken: String!,
   $newPassword: String!
@@ -16880,30 +16094,20 @@ 
    Query
    
   )    
 }
 
    
-                    
-
    Variables
    - - - 
    {
+                  
    {
   "email": "xyz789",
-  "resetPasswordToken": "abc123",
+  "resetPasswordToken": "xyz789",
   "newPassword": "abc123"
 }
 
    
-                    
-
    Response
    - - - 
    {"data": {"resetPassword": false}}
+                  
    {"data": {"resetPassword": false}}
 
    
-                    
-
    back to top @@ -16936,25 +16140,17 @@
    Response

    Example

    Query
    - - - 
    mutation revokeCustomerToken {
+                  
    mutation revokeCustomerToken {
   revokeCustomerToken {
     result
   }
 }
 
    
-                    
-
    Response
    - - - 
    {"data": {"revokeCustomerToken": {"result": false}}}
+                  
    {"data": {"revokeCustomerToken": {"result": true}}}
 
    
-                    
-
    back to top @@ -17006,9 +16202,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput!) {
+                  
    mutation sendNegotiableQuoteForReview($input: SendNegotiableQuoteForReviewInput!) {
   sendNegotiableQuoteForReview(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -17016,23 +16210,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": SendNegotiableQuoteForReviewInput}
+                  
    {"input": SendNegotiableQuoteForReviewInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "sendNegotiableQuoteForReview": {
       "quote": NegotiableQuote
@@ -17040,8 +16226,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -17093,9 +16277,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) {
+                  
    mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) {
   setBillingAddressOnCart(input: $input) {
     cart {
       ...CartFragment
@@ -17103,43 +16285,33 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": SetBillingAddressOnCartInput}
+                  
    {"input": SetBillingAddressOnCartInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"setBillingAddressOnCart": {"cart": Cart}}}
+                  
    {"data": {"setBillingAddressOnCart": {"cart": Cart}}}
 
    
-                    
-
    back to top
    -
    +
    Mutations

    - setCustomAttributesOnCart + setCartAsInactive

    Description
    -

    Add custom attributes to the cart.

    +

    Sets the cart as inactive

    @@ -17147,7 +16319,7 @@
    Description
    Response
    -

    Returns an AddCustomAttributesToCartItemOutput +

    Returns a SetCartAsInactiveOutput

    @@ -17162,10 +16334,9 @@
    Arguments
    - input - CartCustomAttributesInput - - + cartId - String! + The customer cart ID @@ -17175,53 +16346,47 @@
    Arguments

    Example

    Query
    - - - 
    mutation setCustomAttributesOnCart($input: CartCustomAttributesInput) {
-  setCustomAttributesOnCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
+                  
    mutation setCartAsInactive($cartId: String!) {
+  setCartAsInactive(cartId: $cartId) {
+    error
+    success
   }
-}
+}
 
    
-                    
-
    Variables
    - - - 
    {"input": CartCustomAttributesInput}
+                  
    {"cartId": "xyz789"}
 
    
-                    
-
    Response
    - - - 
    {"data": {"setCustomAttributesOnCart": {"cart": Cart}}}
+                  
    {
+  "data": {
+    "setCartAsInactive": {
+      "error": "abc123",
+      "success": false
+    }
+  }
+}
 
    
-                    
-
    back to top
    -
    +
    Mutations

    - setCustomAttributesOnCartItem + setCustomAttributesOnCart

    Description
    -

    Add custom attributes to item in the cart.

    +

    Add custom attributes to the cart.

    @@ -17244,7 +16409,7 @@
    Arguments
    - input - CartItemCustomAttributesInput + input - CartCustomAttributesInput @@ -17257,57 +16422,41 @@
    Arguments

    Example

    Query
    - - - 
    mutation setCustomAttributesOnCartItem($input: CartItemCustomAttributesInput) {
-  setCustomAttributesOnCartItem(input: $input) {
+                  
    mutation setCustomAttributesOnCart($input: CartCustomAttributesInput) {
+  setCustomAttributesOnCart(input: $input) {
     cart {
       ...CartFragment
     }
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": CartItemCustomAttributesInput}
+                  
    {"input": CartCustomAttributesInput}
 
    
-                    
-
    Response
    - - - 
    {
-  "data": {
-    "setCustomAttributesOnCartItem": {"cart": Cart}
-  }
-}
+                  
    {"data": {"setCustomAttributesOnCart": {"cart": Cart}}}
 
    
-                    
-
    back to top
    -
    +
    Mutations

    - setCustomAttributesOnCompany + setCustomAttributesOnCartItem

    Description
    -

    Add custom attributes to company.

    +

    Add custom attributes to item in the cart.

    @@ -17315,7 +16464,7 @@
    Description
    Response
    -

    Returns a SetCustomAttributesOnCompanyOutput +

    Returns an AddCustomAttributesToCartItemOutput

    @@ -17330,9 +16479,10 @@
    Arguments
    - input - SetCustomAttributesOnCompanyInput! + input - CartItemCustomAttributesInput + + - An input object that defines the custom attributes to be assigned to a company. @@ -17342,57 +16492,45 @@
    Arguments

    Example

    Query
    - - - 
    mutation setCustomAttributesOnCompany($input: SetCustomAttributesOnCompanyInput!) {
-  setCustomAttributesOnCompany(input: $input) {
-    company {
-      ...CompanyFragment
+                  
    mutation setCustomAttributesOnCartItem($input: CartItemCustomAttributesInput) {
+  setCustomAttributesOnCartItem(input: $input) {
+    cart {
+      ...CartFragment
     }
   }
-}
+}
 
    
-                    
-
    Variables
    - - - 
    {"input": SetCustomAttributesOnCompanyInput}
+                  
    {"input": CartItemCustomAttributesInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
-    "setCustomAttributesOnCompany": {"company": Company}
+    "setCustomAttributesOnCartItem": {"cart": Cart}
   }
 }
 
    
-                    
-
    back to top
    -
    +
    Mutations

    - setCustomAttributesOnCreditMemo + setCustomAttributesOnCompany

    Description
    -

    Add custom attributes to the credit memo.

    +

    Add custom attributes to company.

    @@ -17400,7 +16538,7 @@
    Description
    Response
    -

    Returns a CreditMemoOutput +

    Returns a SetCustomAttributesOnCompanyOutput

    @@ -17415,10 +16553,9 @@
    Arguments
    - input - CreditMemoCustomAttributesInput - - + input - SetCustomAttributesOnCompanyInput! + An input object that defines the custom attributes to be assigned to a company. @@ -17428,59 +16565,45 @@
    Arguments

    Example

    Query
    - - - 
    mutation setCustomAttributesOnCreditMemo($input: CreditMemoCustomAttributesInput) {
-  setCustomAttributesOnCreditMemo(input: $input) {
-    credit_memo {
-      ...CreditMemoFragment
+                  
    mutation setCustomAttributesOnCompany($input: SetCustomAttributesOnCompanyInput!) {
+  setCustomAttributesOnCompany(input: $input) {
+    company {
+      ...CompanyFragment
     }
   }
-}
+}
 
    
-                    
-
    Variables
    - - - 
    {"input": CreditMemoCustomAttributesInput}
+                  
    {"input": SetCustomAttributesOnCompanyInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
-    "setCustomAttributesOnCreditMemo": {
-      "credit_memo": CreditMemo
-    }
+    "setCustomAttributesOnCompany": {"company": Company}
   }
 }
 
    
-                    
-
    back to top
    -
    +
    Mutations

    - setCustomAttributesOnCreditMemoItem + setCustomAttributesOnCreditMemo

    Description
    -

    Add custom attributes to the credit memo item.

    +

    Add custom attributes to the credit memo.

    @@ -17503,7 +16626,7 @@
    Arguments
    - input - CreditMemoItemCustomAttributesInput + input - CreditMemoCustomAttributesInput @@ -17516,59 +16639,47 @@
    Arguments

    Example

    Query
    - - - 
    mutation setCustomAttributesOnCreditMemoItem($input: CreditMemoItemCustomAttributesInput) {
-  setCustomAttributesOnCreditMemoItem(input: $input) {
+                  
    mutation setCustomAttributesOnCreditMemo($input: CreditMemoCustomAttributesInput) {
+  setCustomAttributesOnCreditMemo(input: $input) {
     credit_memo {
       ...CreditMemoFragment
     }
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": CreditMemoItemCustomAttributesInput}
+                  
    {"input": CreditMemoCustomAttributesInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
-    "setCustomAttributesOnCreditMemoItem": {
+    "setCustomAttributesOnCreditMemo": {
       "credit_memo": CreditMemo
     }
   }
 }
 
    
-                    
-
    back to top
    -
    +
    Mutations

    - setCustomAttributesOnInvoice + setCustomAttributesOnCreditMemoItem

    Description
    -

    Add custom attributes to the invoice.

    +

    Add custom attributes to the credit memo item.

    @@ -17576,7 +16687,7 @@
    Description
    Response
    -

    Returns an InvoiceOutput +

    Returns a CreditMemoOutput

    @@ -17591,7 +16702,7 @@
    Arguments
    - input - InvoiceCustomAttributesInput + input - CreditMemoItemCustomAttributesInput @@ -17604,57 +16715,121 @@
    Arguments

    Example

    Query
    - - - 
    mutation setCustomAttributesOnInvoice($input: InvoiceCustomAttributesInput) {
-  setCustomAttributesOnInvoice(input: $input) {
-    invoice {
-      ...InvoiceFragment
+                  
    mutation setCustomAttributesOnCreditMemoItem($input: CreditMemoItemCustomAttributesInput) {
+  setCustomAttributesOnCreditMemoItem(input: $input) {
+    credit_memo {
+      ...CreditMemoFragment
     }
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": InvoiceCustomAttributesInput}
+                  
    {"input": CreditMemoItemCustomAttributesInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
-    "setCustomAttributesOnInvoice": {"invoice": Invoice}
+    "setCustomAttributesOnCreditMemoItem": {
+      "credit_memo": CreditMemo
+    }
   }
 }
 
    
-                    
-
    back to top
    -
    +
    Mutations

    - setCustomAttributesOnInvoiceItem + setCustomAttributesOnInvoice

    Description
    -

    Add custom attributes to the invoice item.

    +

    Add custom attributes to the invoice.

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns an InvoiceOutput +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - InvoiceCustomAttributesInput + +
    +
    +
    +
    +

    Example

    +
    +
    Query
    + 
    mutation setCustomAttributesOnInvoice($input: InvoiceCustomAttributesInput) {
+  setCustomAttributesOnInvoice(input: $input) {
+    invoice {
+      ...InvoiceFragment
+    }
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {"input": InvoiceCustomAttributesInput}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "setCustomAttributesOnInvoice": {"invoice": Invoice}
+  }
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Mutations +
    +

    + setCustomAttributesOnInvoiceItem +

    +
    +
    +
    +
    Description
    +

    Add custom attributes to the invoice item.

    @@ -17690,9 +16865,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation setCustomAttributesOnInvoiceItem($input: InvoiceItemCustomAttributesInput) {
+                  
    mutation setCustomAttributesOnInvoiceItem($input: InvoiceItemCustomAttributesInput) {
   setCustomAttributesOnInvoiceItem(input: $input) {
     invoice {
       ...InvoiceFragment
@@ -17700,23 +16873,15 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": InvoiceItemCustomAttributesInput}
+                  
    {"input": InvoiceItemCustomAttributesInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "setCustomAttributesOnInvoiceItem": {
       "invoice": Invoice
@@ -17724,8 +16889,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -17777,9 +16940,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation setCustomAttributesOnNegotiableQuote($input: SetCustomAttributesOnNegotiableQuoteInput!) {
+                  
    mutation setCustomAttributesOnNegotiableQuote($input: SetCustomAttributesOnNegotiableQuoteInput!) {
   setCustomAttributesOnNegotiableQuote(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -17787,23 +16948,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": SetCustomAttributesOnNegotiableQuoteInput}
+                  
    {"input": SetCustomAttributesOnNegotiableQuoteInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "setCustomAttributesOnNegotiableQuote": {
       "quote": NegotiableQuote
@@ -17811,8 +16964,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -17864,9 +17015,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) {
+                  
    mutation setGiftOptionsOnCart($input: SetGiftOptionsOnCartInput) {
   setGiftOptionsOnCart(input: $input) {
     cart {
       ...CartFragment
@@ -17874,26 +17023,16 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": SetGiftOptionsOnCartInput}
+                  
    {"input": SetGiftOptionsOnCartInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"setGiftOptionsOnCart": {"cart": Cart}}}
+                  
    {"data": {"setGiftOptionsOnCart": {"cart": Cart}}}
 
    
-                    
-
    back to top @@ -17945,9 +17084,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) {
+                  
    mutation setGuestEmailOnCart($input: SetGuestEmailOnCartInput) {
   setGuestEmailOnCart(input: $input) {
     cart {
       ...CartFragment
@@ -17955,26 +17092,16 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": SetGuestEmailOnCartInput}
+                  
    {"input": SetGuestEmailOnCartInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"setGuestEmailOnCart": {"cart": Cart}}}
+                  
    {"data": {"setGuestEmailOnCart": {"cart": Cart}}}
 
    
-                    
-
    back to top @@ -18026,9 +17153,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation setLineItemNote($input: LineItemNoteInput!) {
+                  
    mutation setLineItemNote($input: LineItemNoteInput!) {
   setLineItemNote(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -18036,26 +17161,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": LineItemNoteInput}
+                  
    {"input": LineItemNoteInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"setLineItemNote": {"quote": NegotiableQuote}}}
+                  
    {"data": {"setLineItemNote": {"quote": NegotiableQuote}}}
 
    
-                    
-
    back to top @@ -18107,9 +17222,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddressInput!) {
+                  
    mutation setNegotiableQuoteBillingAddress($input: SetNegotiableQuoteBillingAddressInput!) {
   setNegotiableQuoteBillingAddress(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -18117,23 +17230,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": SetNegotiableQuoteBillingAddressInput}
+                  
    {"input": SetNegotiableQuoteBillingAddressInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "setNegotiableQuoteBillingAddress": {
       "quote": NegotiableQuote
@@ -18141,8 +17246,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -18194,9 +17297,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethodInput!) {
+                  
    mutation setNegotiableQuotePaymentMethod($input: SetNegotiableQuotePaymentMethodInput!) {
   setNegotiableQuotePaymentMethod(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -18204,23 +17305,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": SetNegotiableQuotePaymentMethodInput}
+                  
    {"input": SetNegotiableQuotePaymentMethodInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "setNegotiableQuotePaymentMethod": {
       "quote": NegotiableQuote
@@ -18228,8 +17321,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -18281,9 +17372,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAddressInput!) {
+                  
    mutation setNegotiableQuoteShippingAddress($input: SetNegotiableQuoteShippingAddressInput!) {
   setNegotiableQuoteShippingAddress(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -18291,23 +17380,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": SetNegotiableQuoteShippingAddressInput}
+                  
    {"input": SetNegotiableQuoteShippingAddressInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "setNegotiableQuoteShippingAddress": {
       "quote": NegotiableQuote
@@ -18315,8 +17396,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -18368,9 +17447,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation setNegotiableQuoteShippingMethods($input: SetNegotiableQuoteShippingMethodsInput!) {
+                  
    mutation setNegotiableQuoteShippingMethods($input: SetNegotiableQuoteShippingMethodsInput!) {
   setNegotiableQuoteShippingMethods(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -18378,23 +17455,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": SetNegotiableQuoteShippingMethodsInput}
+                  
    {"input": SetNegotiableQuoteShippingMethodsInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "setNegotiableQuoteShippingMethods": {
       "quote": NegotiableQuote
@@ -18402,8 +17471,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -18455,9 +17522,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTemplateShippingAddressInput!) {
+                  
    mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTemplateShippingAddressInput!) {
   setNegotiableQuoteTemplateShippingAddress(input: $input) {
     buyer {
       ...NegotiableQuoteUserFragment
@@ -18465,227 +17530,13 @@ 
    Query
    
     comments {
       ...NegotiableQuoteCommentFragment
     }
+    created_at
     expiration_date
     history {
       ...NegotiableQuoteHistoryEntryFragment
     }
-    is_min_max_qty_used
-    is_virtual
-    items {
-      ...CartItemInterfaceFragment
-    }
-    max_order_commitment
-    min_order_commitment
-    name
-    notifications {
-      ...QuoteTemplateNotificationMessageFragment
-    }
-    prices {
-      ...CartPricesFragment
-    }
-    reference_document_links {
-      ...NegotiableQuoteReferenceDocumentLinkFragment
-    }
-    shipping_addresses {
-      ...NegotiableQuoteShippingAddressFragment
-    }
-    status
-    template_id
-    total_quantity
-  }    
-}    
-
    
-                    
-                  
-
    -
    -
    Variables
    - - - 
    {"input": SetNegotiableQuoteTemplateShippingAddressInput}
-
    - - -
    -
    -
    Response
    - - - 
    {
-  "data": {
-    "setNegotiableQuoteTemplateShippingAddress": {
-      "buyer": NegotiableQuoteUser,
-      "comments": [NegotiableQuoteComment],
-      "expiration_date": "xyz789",
-      "history": [NegotiableQuoteHistoryEntry],
-      "is_min_max_qty_used": false,
-      "is_virtual": true,
-      "items": [CartItemInterface],
-      "max_order_commitment": 123,
-      "min_order_commitment": 987,
-      "name": "xyz789",
-      "notifications": [QuoteTemplateNotificationMessage],
-      "prices": CartPrices,
-      "reference_document_links": [
-        NegotiableQuoteReferenceDocumentLink
-      ],
-      "shipping_addresses": [
-        NegotiableQuoteShippingAddress
-      ],
-      "status": "abc123",
-      "template_id": 4,
-      "total_quantity": 123.45
-    }
-  }
-}
-
    - - -
    - - back to top - -
    -
    -
    - Mutations -
    -

    - setPaymentMethodOnCart -

    -
    -
    -
    -
    Description
    -

    Apply a payment method to the cart.

    -
    -
    -
    -
    -
    -
    -
    Response
    -

    Returns a SetPaymentMethodOnCartOutput -

    -
    -
    -
    Arguments
    - - - - - - - - - - - - - -
    NameDescription
    - input - SetPaymentMethodOnCartInput - An input object that defines which payment method to apply to the cart.
    -
    -
    -
    -

    Example

    -
    -
    Query
    - - - 
    mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) {
-  setPaymentMethodOnCart(input: $input) {
-    cart {
-      ...CartFragment
-    }
-  }
-}
-
    - - -
    -
    -
    Variables
    - - - 
    {"input": SetPaymentMethodOnCartInput}
-
    - - -
    -
    -
    Response
    - - - 
    {"data": {"setPaymentMethodOnCart": {"cart": Cart}}}
-
    - - -
    -
    - back to top -
    -
    -
    -
    - Mutations -
    -

    - setQuoteTemplateLineItemNote -

    -
    -
    -
    -
    Description
    -

    Add buyer's note to a negotiable quote template item.

    -
    -
    -
    -
    -
    -
    -
    Response
    -

    Returns a NegotiableQuoteTemplate -

    -
    -
    -
    Arguments
    - - - - - - - - - - - - - -
    NameDescription
    - input - QuoteTemplateLineItemNoteInput! - An input object that defines the quote template item note.
    -
    -
    -
    -

    Example

    -
    -
    Query
    - - - 
    mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) {
-  setQuoteTemplateLineItemNote(input: $input) {
-    buyer {
-      ...NegotiableQuoteUserFragment
-    }
-    comments {
-      ...NegotiableQuoteCommentFragment
-    }
-    expiration_date
-    history {
-      ...NegotiableQuoteHistoryEntryFragment
+    historyV2 {
+      ...NegotiableQuoteTemplateHistoryEntryFragment
     }
     is_min_max_qty_used
     is_virtual
@@ -18704,61 +17555,402 @@ 
    Query
    
     reference_document_links {
       ...NegotiableQuoteReferenceDocumentLinkFragment
     }
+    sales_rep_name
     shipping_addresses {
       ...NegotiableQuoteShippingAddressFragment
     }
     status
     template_id
     total_quantity
+    uid
+    updated_at
   }    
 }
    - -
    Variables
    - - - 
    {"input": QuoteTemplateLineItemNoteInput}
+                  
    {"input": SetNegotiableQuoteTemplateShippingAddressInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
-    "setQuoteTemplateLineItemNote": {
+    "setNegotiableQuoteTemplateShippingAddress": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
+      "created_at": "abc123",
       "expiration_date": "abc123",
       "history": [NegotiableQuoteHistoryEntry],
-      "is_min_max_qty_used": false,
+      "historyV2": [NegotiableQuoteTemplateHistoryEntry],
+      "is_min_max_qty_used": true,
+      "is_virtual": false,
+      "items": [CartItemInterface],
+      "max_order_commitment": 987,
+      "min_order_commitment": 987,
+      "name": "abc123",
+      "notifications": [QuoteTemplateNotificationMessage],
+      "prices": CartPrices,
+      "reference_document_links": [
+        NegotiableQuoteReferenceDocumentLink
+      ],
+      "sales_rep_name": "xyz789",
+      "shipping_addresses": [
+        NegotiableQuoteShippingAddress
+      ],
+      "status": "abc123",
+      "template_id": 4,
+      "total_quantity": 987.65,
+      "uid": "4",
+      "updated_at": "abc123"
+    }
+  }
+}
+
    
+
    +
    + back to top +
    +
    +
    +
    + Mutations +
    +

    + setPaymentMethodOnCart +

    +
    +
    +
    +
    Description
    +

    Apply a payment method to the cart.

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a SetPaymentMethodOnCartOutput +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - SetPaymentMethodOnCartInput + An input object that defines which payment method to apply to the cart.
    +
    +
    +
    +

    Example

    +
    +
    Query
    + 
    mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) {
+  setPaymentMethodOnCart(input: $input) {
+    cart {
+      ...CartFragment
+    }
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {"input": SetPaymentMethodOnCartInput}
+
    +
    +
    +
    Response
    + 
    {"data": {"setPaymentMethodOnCart": {"cart": Cart}}}
+
    +
    +
    + back to top +
    +
    +
    +
    + Mutations +
    +

    + setQuoteTemplateExpirationDate +

    +
    +
    +
    +
    Description
    +

    Set expiration date to a negotiable quote template.

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a NegotiableQuoteTemplate +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - QuoteTemplateExpirationDateInput! + An input object that defines the quote template expiration date.
    +
    +
    +
    +

    Example

    +
    +
    Query
    + 
    mutation setQuoteTemplateExpirationDate($input: QuoteTemplateExpirationDateInput!) {
+  setQuoteTemplateExpirationDate(input: $input) {
+    buyer {
+      ...NegotiableQuoteUserFragment
+    }
+    comments {
+      ...NegotiableQuoteCommentFragment
+    }
+    created_at
+    expiration_date
+    history {
+      ...NegotiableQuoteHistoryEntryFragment
+    }
+    historyV2 {
+      ...NegotiableQuoteTemplateHistoryEntryFragment
+    }
+    is_min_max_qty_used
+    is_virtual
+    items {
+      ...CartItemInterfaceFragment
+    }
+    max_order_commitment
+    min_order_commitment
+    name
+    notifications {
+      ...QuoteTemplateNotificationMessageFragment
+    }
+    prices {
+      ...CartPricesFragment
+    }
+    reference_document_links {
+      ...NegotiableQuoteReferenceDocumentLinkFragment
+    }
+    sales_rep_name
+    shipping_addresses {
+      ...NegotiableQuoteShippingAddressFragment
+    }
+    status
+    template_id
+    total_quantity
+    uid
+    updated_at
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {"input": QuoteTemplateExpirationDateInput}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "setQuoteTemplateExpirationDate": {
+      "buyer": NegotiableQuoteUser,
+      "comments": [NegotiableQuoteComment],
+      "created_at": "xyz789",
+      "expiration_date": "xyz789",
+      "history": [NegotiableQuoteHistoryEntry],
+      "historyV2": [NegotiableQuoteTemplateHistoryEntry],
+      "is_min_max_qty_used": true,
+      "is_virtual": true,
+      "items": [CartItemInterface],
+      "max_order_commitment": 123,
+      "min_order_commitment": 987,
+      "name": "abc123",
+      "notifications": [QuoteTemplateNotificationMessage],
+      "prices": CartPrices,
+      "reference_document_links": [
+        NegotiableQuoteReferenceDocumentLink
+      ],
+      "sales_rep_name": "abc123",
+      "shipping_addresses": [
+        NegotiableQuoteShippingAddress
+      ],
+      "status": "abc123",
+      "template_id": "4",
+      "total_quantity": 987.65,
+      "uid": 4,
+      "updated_at": "xyz789"
+    }
+  }
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Mutations +
    +

    + setQuoteTemplateLineItemNote +

    +
    +
    +
    +
    Description
    +

    Add buyer's note to a negotiable quote template item.

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a NegotiableQuoteTemplate +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + +
    NameDescription
    + input - QuoteTemplateLineItemNoteInput! + An input object that defines the quote template item note.
    +
    +
    +
    +

    Example

    +
    +
    Query
    + 
    mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) {
+  setQuoteTemplateLineItemNote(input: $input) {
+    buyer {
+      ...NegotiableQuoteUserFragment
+    }
+    comments {
+      ...NegotiableQuoteCommentFragment
+    }
+    created_at
+    expiration_date
+    history {
+      ...NegotiableQuoteHistoryEntryFragment
+    }
+    historyV2 {
+      ...NegotiableQuoteTemplateHistoryEntryFragment
+    }
+    is_min_max_qty_used
+    is_virtual
+    items {
+      ...CartItemInterfaceFragment
+    }
+    max_order_commitment
+    min_order_commitment
+    name
+    notifications {
+      ...QuoteTemplateNotificationMessageFragment
+    }
+    prices {
+      ...CartPricesFragment
+    }
+    reference_document_links {
+      ...NegotiableQuoteReferenceDocumentLinkFragment
+    }
+    sales_rep_name
+    shipping_addresses {
+      ...NegotiableQuoteShippingAddressFragment
+    }
+    status
+    template_id
+    total_quantity
+    uid
+    updated_at
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {"input": QuoteTemplateLineItemNoteInput}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "setQuoteTemplateLineItemNote": {
+      "buyer": NegotiableQuoteUser,
+      "comments": [NegotiableQuoteComment],
+      "created_at": "abc123",
+      "expiration_date": "xyz789",
+      "history": [NegotiableQuoteHistoryEntry],
+      "historyV2": [NegotiableQuoteTemplateHistoryEntry],
+      "is_min_max_qty_used": true,
       "is_virtual": false,
       "items": [CartItemInterface],
       "max_order_commitment": 123,
-      "min_order_commitment": 123,
-      "name": "xyz789",
+      "min_order_commitment": 987,
+      "name": "abc123",
       "notifications": [QuoteTemplateNotificationMessage],
       "prices": CartPrices,
       "reference_document_links": [
         NegotiableQuoteReferenceDocumentLink
       ],
+      "sales_rep_name": "abc123",
       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
       "status": "abc123",
       "template_id": "4",
-      "total_quantity": 123.45
+      "total_quantity": 123.45,
+      "uid": 4,
+      "updated_at": "abc123"
     }
   }
 }
    - -
    back to top @@ -18810,9 +18002,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) {
+                  
    mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) {
   setShippingAddressesOnCart(input: $input) {
     cart {
       ...CartFragment
@@ -18820,26 +18010,16 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": SetShippingAddressesOnCartInput}
+                  
    {"input": SetShippingAddressesOnCartInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"setShippingAddressesOnCart": {"cart": Cart}}}
+                  
    {"data": {"setShippingAddressesOnCart": {"cart": Cart}}}
 
    
-                    
-
    back to top @@ -18891,9 +18071,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) {
+                  
    mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) {
   setShippingMethodsOnCart(input: $input) {
     cart {
       ...CartFragment
@@ -18901,26 +18079,16 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": SetShippingMethodsOnCartInput}
+                  
    {"input": SetShippingMethodsOnCartInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"setShippingMethodsOnCart": {"cart": Cart}}}
+                  
    {"data": {"setShippingMethodsOnCart": {"cart": Cart}}}
 
    
-                    
-
    back to top @@ -18984,9 +18152,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation shareGiftRegistry(
+                  
    mutation shareGiftRegistry(
   $giftRegistryUid: ID!,
   $sender: ShareGiftRegistrySenderInput!,
   $invitees: [ShareGiftRegistryInviteeInput!]!
@@ -19000,30 +18166,20 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
-  "giftRegistryUid": 4,
+                  
    {
+  "giftRegistryUid": "4",
   "sender": ShareGiftRegistrySenderInput,
   "invitees": [ShareGiftRegistryInviteeInput]
 }
 
    
-                    
-
    Response
    - - - 
    {"data": {"shareGiftRegistry": {"is_shared": false}}}
+                  
    {"data": {"shareGiftRegistry": {"is_shared": true}}}
 
    
-                    
-
    back to top @@ -19075,9 +18231,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTemplateForReviewInput!) {
+                  
    mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTemplateForReviewInput!) {
   submitNegotiableQuoteTemplateForReview(input: $input) {
     buyer {
       ...NegotiableQuoteUserFragment
@@ -19085,10 +18239,14 @@ 
    Query
    
     comments {
       ...NegotiableQuoteCommentFragment
     }
+    created_at
     expiration_date
     history {
       ...NegotiableQuoteHistoryEntryFragment
     }
+    historyV2 {
+      ...NegotiableQuoteTemplateHistoryEntryFragment
+    }
     is_min_max_qty_used
     is_virtual
     items {
@@ -19106,61 +18264,59 @@ 
    Query
    
     reference_document_links {
       ...NegotiableQuoteReferenceDocumentLinkFragment
     }
+    sales_rep_name
     shipping_addresses {
       ...NegotiableQuoteShippingAddressFragment
     }
     status
     template_id
     total_quantity
+    uid
+    updated_at
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": SubmitNegotiableQuoteTemplateForReviewInput}
+                  
    {"input": SubmitNegotiableQuoteTemplateForReviewInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "submitNegotiableQuoteTemplateForReview": {
       "buyer": NegotiableQuoteUser,
       "comments": [NegotiableQuoteComment],
+      "created_at": "xyz789",
       "expiration_date": "xyz789",
       "history": [NegotiableQuoteHistoryEntry],
+      "historyV2": [NegotiableQuoteTemplateHistoryEntry],
       "is_min_max_qty_used": true,
       "is_virtual": true,
       "items": [CartItemInterface],
       "max_order_commitment": 987,
-      "min_order_commitment": 123,
-      "name": "xyz789",
+      "min_order_commitment": 987,
+      "name": "abc123",
       "notifications": [QuoteTemplateNotificationMessage],
       "prices": CartPrices,
       "reference_document_links": [
         NegotiableQuoteReferenceDocumentLink
       ],
+      "sales_rep_name": "xyz789",
       "shipping_addresses": [
         NegotiableQuoteShippingAddress
       ],
       "status": "abc123",
-      "template_id": "4",
-      "total_quantity": 123.45
+      "template_id": 4,
+      "total_quantity": 987.65,
+      "uid": 4,
+      "updated_at": "abc123"
     }
   }
 }
 
    
-                    
-
    back to top @@ -19212,34 +18368,22 @@
    Arguments

    Example

    Query
    - - - 
    mutation subscribeEmailToNewsletter($email: String!) {
+                  
    mutation subscribeEmailToNewsletter($email: String!) {
   subscribeEmailToNewsletter(email: $email) {
     status
   }
 }
 
    
-                    
-
    Variables
    - - - 
    {"email": "xyz789"}
+                  
    {"email": "abc123"}
 
    
-                    
-
    Response
    - - - 
    {"data": {"subscribeEmailToNewsletter": {"status": "NOT_ACTIVE"}}}
+                  
    {"data": {"subscribeEmailToNewsletter": {"status": "NOT_ACTIVE"}}}
 
    
-                    
-
    back to top @@ -19291,32 +18435,20 @@
    Arguments

    Example

    Query
    - - - 
    mutation syncPaymentOrder($input: SyncPaymentOrderInput) {
+                  
    mutation syncPaymentOrder($input: SyncPaymentOrderInput) {
   syncPaymentOrder(input: $input)
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": SyncPaymentOrderInput}
+                  
    {"input": SyncPaymentOrderInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"syncPaymentOrder": false}}
+                  
    {"data": {"syncPaymentOrder": true}}
 
    
-                    
-
    back to top @@ -19368,9 +18500,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation updateCartItems($input: UpdateCartItemsInput) {
+                  
    mutation updateCartItems($input: UpdateCartItemsInput) {
   updateCartItems(input: $input) {
     cart {
       ...CartFragment
@@ -19381,23 +18511,15 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"input": UpdateCartItemsInput}
+                  
    {"input": UpdateCartItemsInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "updateCartItems": {
       "cart": Cart,
@@ -19406,8 +18528,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -19460,9 +18580,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation updateCompany($input: CompanyUpdateInput!) {
+                  
    mutation updateCompany($input: CompanyUpdateInput!) {
   updateCompany(input: $input) {
     company {
       ...CompanyFragment
@@ -19470,26 +18588,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": CompanyUpdateInput}
+                  
    {"input": CompanyUpdateInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"updateCompany": {"company": Company}}}
+                  
    {"data": {"updateCompany": {"company": Company}}}
 
    
-                    
-
    back to top @@ -19542,9 +18650,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation updateCompanyRole($input: CompanyRoleUpdateInput!) {
+                  
    mutation updateCompanyRole($input: CompanyRoleUpdateInput!) {
   updateCompanyRole(input: $input) {
     role {
       ...CompanyRoleFragment
@@ -19552,26 +18658,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": CompanyRoleUpdateInput}
+                  
    {"input": CompanyRoleUpdateInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"updateCompanyRole": {"role": CompanyRole}}}
+                  
    {"data": {"updateCompanyRole": {"role": CompanyRole}}}
 
    
-                    
-
    back to top @@ -19624,9 +18720,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation updateCompanyStructure($input: CompanyStructureUpdateInput!) {
+                  
    mutation updateCompanyStructure($input: CompanyStructureUpdateInput!) {
   updateCompanyStructure(input: $input) {
     company {
       ...CompanyFragment
@@ -19634,26 +18728,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": CompanyStructureUpdateInput}
+                  
    {"input": CompanyStructureUpdateInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"updateCompanyStructure": {"company": Company}}}
+                  
    {"data": {"updateCompanyStructure": {"company": Company}}}
 
    
-                    
-
    back to top @@ -19706,9 +18790,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation updateCompanyTeam($input: CompanyTeamUpdateInput!) {
+                  
    mutation updateCompanyTeam($input: CompanyTeamUpdateInput!) {
   updateCompanyTeam(input: $input) {
     team {
       ...CompanyTeamFragment
@@ -19716,26 +18798,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": CompanyTeamUpdateInput}
+                  
    {"input": CompanyTeamUpdateInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"updateCompanyTeam": {"team": CompanyTeam}}}
+                  
    {"data": {"updateCompanyTeam": {"team": CompanyTeam}}}
 
    
-                    
-
    back to top @@ -19788,9 +18860,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation updateCompanyUser($input: CompanyUserUpdateInput!) {
+                  
    mutation updateCompanyUser($input: CompanyUserUpdateInput!) {
   updateCompanyUser(input: $input) {
     user {
       ...CustomerFragment
@@ -19798,26 +18868,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": CompanyUserUpdateInput}
+                  
    {"input": CompanyUserUpdateInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"updateCompanyUser": {"user": Customer}}}
+                  
    {"data": {"updateCompanyUser": {"user": Customer}}}
 
    
-                    
-
    back to top @@ -19827,9 +18887,16 @@
    Response
    Mutations
    -

    +

    updateCustomerAddress

    +
    +
    +
    +
    Use updateCustomerAddressV2 instead.
    +
    +
    +
    @@ -19875,9 +18942,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation updateCustomerAddress(
+                  
    mutation updateCustomerAddress(
   $id: Int!,
   $input: CustomerAddressInput
 ) {
@@ -19910,55 +18975,181 @@ 
    Query
    
     street
     suffix
     telephone
+    uid
     vat_id
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {"id": 987, "input": CustomerAddressInput}
+                  
    {"id": 987, "input": CustomerAddressInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "updateCustomerAddress": {
       "city": "abc123",
+      "company": "xyz789",
+      "country_code": "AF",
+      "custom_attributesV2": [AttributeValueInterface],
+      "default_billing": false,
+      "default_shipping": false,
+      "extension_attributes": [CustomerAddressAttribute],
+      "fax": "abc123",
+      "firstname": "abc123",
+      "id": 123,
+      "lastname": "xyz789",
+      "middlename": "xyz789",
+      "postcode": "abc123",
+      "prefix": "abc123",
+      "region": CustomerAddressRegion,
+      "region_id": 123,
+      "street": ["xyz789"],
+      "suffix": "xyz789",
+      "telephone": "abc123",
+      "uid": "4",
+      "vat_id": "xyz789"
+    }
+  }
+}
+
    
+
    +
    + back to top +
    +
    +
    +
    + Mutations +
    +

    + updateCustomerAddressV2 +

    +
    +
    +
    +
    Description
    +

    Update the billing or shipping address of a customer or guest.

    +
    +
    +
    +
    +
    +
    +
    Response
    +

    Returns a CustomerAddress +

    +
    +
    +
    Arguments
    + + + + + + + + + + + + + + + + + +
    NameDescription
    + uid - ID! + The unique ID of the customer address.
    + input - CustomerAddressInput + An input object that contains changes to the customer address.
    +
    +
    +
    +

    Example

    +
    +
    Query
    + 
    mutation updateCustomerAddressV2(
+  $uid: ID!,
+  $input: CustomerAddressInput
+) {
+  updateCustomerAddressV2(
+    uid: $uid,
+    input: $input
+  ) {
+    city
+    company
+    country_code
+    custom_attributesV2 {
+      ...AttributeValueInterfaceFragment
+    }
+    default_billing
+    default_shipping
+    extension_attributes {
+      ...CustomerAddressAttributeFragment
+    }
+    fax
+    firstname
+    id
+    lastname
+    middlename
+    postcode
+    prefix
+    region {
+      ...CustomerAddressRegionFragment
+    }
+    region_id
+    street
+    suffix
+    telephone
+    uid
+    vat_id
+  }
+}
+
    +
    +
    +
    Variables
    + 
    {
+  "uid": "4",
+  "input": CustomerAddressInput
+}
+
    +
    +
    +
    Response
    + 
    {
+  "data": {
+    "updateCustomerAddressV2": {
+      "city": "xyz789",
       "company": "abc123",
       "country_code": "AF",
       "custom_attributesV2": [AttributeValueInterface],
       "default_billing": false,
       "default_shipping": true,
       "extension_attributes": [CustomerAddressAttribute],
-      "fax": "xyz789",
+      "fax": "abc123",
       "firstname": "xyz789",
       "id": 123,
-      "lastname": "xyz789",
+      "lastname": "abc123",
       "middlename": "xyz789",
-      "postcode": "abc123",
+      "postcode": "xyz789",
       "prefix": "abc123",
       "region": CustomerAddressRegion,
       "region_id": 123,
-      "street": ["abc123"],
+      "street": ["xyz789"],
       "suffix": "abc123",
       "telephone": "xyz789",
+      "uid": 4,
       "vat_id": "xyz789"
     }
   }
 }
    - -
    back to top @@ -20016,9 +19207,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation updateCustomerEmail(
+                  
    mutation updateCustomerEmail(
   $email: String!,
   $password: String!
 ) {
@@ -20032,29 +19221,19 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
+                  
    {
   "email": "xyz789",
-  "password": "abc123"
+  "password": "xyz789"
 }
 
    
-                    
-
    Response
    - - - 
    {"data": {"updateCustomerEmail": {"customer": Customer}}}
+                  
    {"data": {"updateCustomerEmail": {"customer": Customer}}}
 
    
-                    
-
    back to top @@ -20106,9 +19285,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation updateCustomerV2($input: CustomerUpdateInput!) {
+                  
    mutation updateCustomerV2($input: CustomerUpdateInput!) {
   updateCustomerV2(input: $input) {
     customer {
       ...CustomerFragment
@@ -20116,26 +19293,16 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": CustomerUpdateInput}
+                  
    {"input": CustomerUpdateInput}
 
    
-                    
-
    Response
    - - - 
    {"data": {"updateCustomerV2": {"customer": Customer}}}
+                  
    {"data": {"updateCustomerV2": {"customer": Customer}}}
 
    
-                    
-
    back to top @@ -20193,9 +19360,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation updateGiftRegistry(
+                  
    mutation updateGiftRegistry(
   $giftRegistryUid: ID!,
   $giftRegistry: UpdateGiftRegistryInput!
 ) {
@@ -20209,33 +19374,23 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
-  "giftRegistryUid": 4,
+                  
    {
+  "giftRegistryUid": "4",
   "giftRegistry": UpdateGiftRegistryInput
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "updateGiftRegistry": {"gift_registry": GiftRegistry}
   }
 }
 
    
-                    
-
    back to top @@ -20293,9 +19448,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation updateGiftRegistryItems(
+                  
    mutation updateGiftRegistryItems(
   $giftRegistryUid: ID!,
   $items: [UpdateGiftRegistryItemInput!]!
 ) {
@@ -20309,26 +19462,18 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
-  "giftRegistryUid": "4",
+                  
    {
+  "giftRegistryUid": 4,
   "items": [UpdateGiftRegistryItemInput]
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "updateGiftRegistryItems": {
       "gift_registry": GiftRegistry
@@ -20336,8 +19481,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -20395,9 +19538,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation updateGiftRegistryRegistrants(
+                  
    mutation updateGiftRegistryRegistrants(
   $giftRegistryUid: ID!,
   $registrants: [UpdateGiftRegistryRegistrantInput!]!
 ) {
@@ -20411,26 +19552,18 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
+                  
    {
   "giftRegistryUid": 4,
   "registrants": [UpdateGiftRegistryRegistrantInput]
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "updateGiftRegistryRegistrants": {
       "gift_registry": GiftRegistry
@@ -20438,8 +19571,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -20491,9 +19622,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation updateNegotiableQuoteQuantities($input: UpdateNegotiableQuoteQuantitiesInput!) {
+                  
    mutation updateNegotiableQuoteQuantities($input: UpdateNegotiableQuoteQuantitiesInput!) {
   updateNegotiableQuoteQuantities(input: $input) {
     quote {
       ...NegotiableQuoteFragment
@@ -20501,23 +19630,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": UpdateNegotiableQuoteQuantitiesInput}
+                  
    {"input": UpdateNegotiableQuoteQuantitiesInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "updateNegotiableQuoteQuantities": {
       "quote": NegotiableQuote
@@ -20525,8 +19646,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -20578,9 +19697,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation updateNegotiableQuoteTemplateQuantities($input: UpdateNegotiableQuoteTemplateQuantitiesInput!) {
+                  
    mutation updateNegotiableQuoteTemplateQuantities($input: UpdateNegotiableQuoteTemplateQuantitiesInput!) {
   updateNegotiableQuoteTemplateQuantities(input: $input) {
     quote_template {
       ...NegotiableQuoteTemplateFragment
@@ -20588,23 +19705,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": UpdateNegotiableQuoteTemplateQuantitiesInput}
+                  
    {"input": UpdateNegotiableQuoteTemplateQuantitiesInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "updateNegotiableQuoteTemplateQuantities": {
       "quote_template": NegotiableQuoteTemplate
@@ -20612,8 +19721,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -20671,9 +19778,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation updateProductsInWishlist(
+                  
    mutation updateProductsInWishlist(
   $wishlistId: ID!,
   $wishlistItems: [WishlistItemUpdateInput!]!
 ) {
@@ -20690,26 +19795,18 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
+                  
    {
   "wishlistId": 4,
   "wishlistItems": [WishlistItemUpdateInput]
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "updateProductsInWishlist": {
       "user_errors": [WishListUserInputError],
@@ -20718,8 +19815,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -20772,9 +19867,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRuleInput!) {
+                  
    mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRuleInput!) {
   updatePurchaseOrderApprovalRule(input: $input) {
     applies_to_roles {
       ...CompanyRoleFragment
@@ -20795,31 +19888,23 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": UpdatePurchaseOrderApprovalRuleInput}
+                  
    {"input": UpdatePurchaseOrderApprovalRuleInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "updatePurchaseOrderApprovalRule": {
       "applies_to_roles": [CompanyRole],
       "approver_roles": [CompanyRole],
       "condition": PurchaseOrderApprovalRuleConditionInterface,
-      "created_at": "xyz789",
-      "created_by": "abc123",
-      "description": "abc123",
+      "created_at": "abc123",
+      "created_by": "xyz789",
+      "description": "xyz789",
       "name": "xyz789",
       "status": "ENABLED",
       "uid": "4",
@@ -20828,8 +19913,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -20888,9 +19971,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation updateRequisitionList(
+                  
    mutation updateRequisitionList(
   $requisitionListUid: ID!,
   $input: UpdateRequisitionListInput
 ) {
@@ -20904,26 +19985,18 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
+                  
    {
   "requisitionListUid": "4",
   "input": UpdateRequisitionListInput
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "updateRequisitionList": {
       "requisition_list": RequisitionList
@@ -20931,8 +20004,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -20990,9 +20061,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation updateRequisitionListItems(
+                  
    mutation updateRequisitionListItems(
   $requisitionListUid: ID!,
   $requisitionListItems: [UpdateRequisitionListItemsInput!]!
 ) {
@@ -21006,28 +20075,20 @@ 
    Query
    
   }    
 }
 
    
-                    
-
    Variables
    - - - 
    {
-  "requisitionListUid": "4",
+                  
    {
+  "requisitionListUid": 4,
   "requisitionListItems": [
     UpdateRequisitionListItemsInput
   ]
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "updateRequisitionListItems": {
       "requisition_list": RequisitionList
@@ -21035,8 +20096,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -21100,9 +20159,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation updateWishlist(
+                  
    mutation updateWishlist(
   $wishlistId: ID!,
   $name: String,
   $visibility: WishlistVisibilityEnum
@@ -21118,27 +20175,19 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {
-  "wishlistId": 4,
-  "name": "xyz789",
+                  
    {
+  "wishlistId": "4",
+  "name": "abc123",
   "visibility": "PUBLIC"
 }
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "updateWishlist": {
       "name": "xyz789",
@@ -21148,8 +20197,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -21202,9 +20249,7 @@
    Arguments

    Example

    Query
    - - - 
    mutation validatePurchaseOrders($input: ValidatePurchaseOrdersInput!) {
+                  
    mutation validatePurchaseOrders($input: ValidatePurchaseOrdersInput!) {
   validatePurchaseOrders(input: $input) {
     errors {
       ...ValidatePurchaseOrderErrorFragment
@@ -21215,23 +20260,15 @@ 
    Query
    
   }    
 }    
 
    
-                    
-
    Variables
    - - - 
    {"input": ValidatePurchaseOrdersInput}
+                  
    {"input": ValidatePurchaseOrdersInput}
 
    
-                    
-
    Response
    - - - 
    {
+                  
    {
   "data": {
     "validatePurchaseOrders": {
       "errors": [ValidatePurchaseOrderError],
@@ -21240,8 +20277,6 @@ 
    Response
    
   }
 }
 
    
-                    
-
    back to top @@ -21279,12 +20314,8 @@
    Fields
    Example
    - - - 
    {"template_id": 4}
+                  
    {"template_id": 4}
 
    
-                    
-
    back to top @@ -21323,12 +20354,8 @@
    Fields
    Example
    - - - 
    {"cart": Cart}
+                  
    {"cart": Cart}
 
    
-                    
-
    back to top @@ -21370,15 +20397,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "cart_id": "abc123",
   "cart_items": [DownloadableProductCartItemInput]
 }
 
    
-                    
-
    back to top @@ -21417,12 +20440,8 @@
    Fields
    Example
    - - - 
    {"cart": Cart}
+                  
    {"cart": Cart}
 
    
-                    
-
    back to top @@ -21480,9 +20499,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "dynamic_attributes": [
     GiftRegistryDynamicAttributeInput
   ],
@@ -21491,8 +20508,6 @@ 
    Example
    
   "lastname": "xyz789"
 }
 
    
-                    
-
    back to top @@ -21531,12 +20546,8 @@
    Fields
    Example
    - - - 
    {"gift_registry": GiftRegistry}
+                  
    {"gift_registry": GiftRegistry}
 
    
-                    
-
    back to top @@ -21580,15 +20591,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "cart": Cart,
   "user_errors": [Error]
 }
 
    
-                    
-
    back to top @@ -21634,12 +20641,59 @@
    Fields
    Example
    - - - 
    {"products": [4], "uid": "4"}
+                  
    {
+  "products": ["4"],
+  "uid": "4"
+}
+
    
+
    +
    + back to top + +
    +
    +
    + Types +
    +

    AddProductsToNewCartOutput

    +
    +
    +
    +
    Description
    +

    Contains details about the cart after adding products to it.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    cart - Cart + The cart after products have been added.
    user_errors - [CartUserInputError] + Contains errors encountered while adding an item to the cart.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "cart": Cart,
+  "user_errors": [CartUserInputError]
+}
    - -
    back to top @@ -21678,12 +20732,8 @@
    Fields
    Example
    - - - 
    {"requisition_list": RequisitionList}
+                  
    {"requisition_list": RequisitionList}
 
    
-                    
-
    back to top @@ -21727,15 +20777,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "user_errors": [WishListUserInputError],
   "wishlist": Wishlist
 }
 
    
-                    
-
    back to top @@ -21781,15 +20827,11 @@
    Fields
    Example
    - - - 
    {
-  "comment": "abc123",
+                  
    {
+  "comment": "xyz789",
   "purchase_order_uid": "4"
 }
 
    
-                    
-
    back to top @@ -21828,12 +20870,8 @@
    Fields
    Example
    - - - 
    {"comment": PurchaseOrderComment}
+                  
    {"comment": PurchaseOrderComment}
 
    
-                    
-
    back to top @@ -21885,16 +20923,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "cart_id": "xyz789",
   "purchase_order_uid": "4",
-  "replace_existing_cart_items": false
+  "replace_existing_cart_items": true
 }
 
    
-                    
-
    back to top @@ -21938,15 +20972,11 @@
    Fields
    Example
    - - - 
    {
-  "message": "xyz789",
+                  
    {
+  "message": "abc123",
   "type": "OUT_OF_STOCK"
 }
 
    
-                    
-
    back to top @@ -22004,12 +21034,8 @@
    Values
    Example
    - - - 
    "OUT_OF_STOCK"
+                  
    "OUT_OF_STOCK"
 
    
-                    
-
    back to top @@ -22058,18 +21084,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "add_requisition_list_items_to_cart_user_errors": [
     AddRequisitionListItemToCartUserError
   ],
   "cart": Cart,
-  "status": false
+  "status": true
 }
 
    
-                    
-
    back to top @@ -22115,15 +21137,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "comment_text": "xyz789",
   "return_uid": "4"
 }
 
    
-                    
-
    back to top @@ -22162,12 +21180,8 @@
    Fields
    Example
    - - - 
    {"return": Return}
+                  
    {"return": Return}
 
    
-                    
-
    back to top @@ -22219,16 +21233,12 @@
    Fields
    Example
    - - - 
    {
-  "carrier_uid": 4,
+                  
    {
+  "carrier_uid": "4",
   "return_uid": 4,
-  "tracking_number": "abc123"
+  "tracking_number": "xyz789"
 }
 
    
-                    
-
    back to top @@ -22272,15 +21282,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "return": Return,
   "return_shipping_tracking": ReturnShippingTracking
 }
 
    
-                    
-
    back to top @@ -22329,9 +21335,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "add_wishlist_items_to_cart_user_errors": [
     WishlistCartUserInputError
   ],
@@ -22339,8 +21343,6 @@ 
    Example
    
   "wishlist": Wishlist
 }
 
    
-                    
-
    back to top @@ -22394,17 +21396,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "attribute": "xyz789",
   "buckets": [Bucket],
-  "title": "abc123",
+  "title": "xyz789",
   "type": "INTELLIGENT"
 }
 
    
-                    
-
    back to top @@ -22459,12 +21457,8 @@
    Values
    Example
    - - - 
    "INTELLIGENT"
+                  
    "INTELLIGENT"
 
    
-                    
-
    back to top @@ -22534,21 +21528,17 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "button_styles": ButtonStyles,
-  "code": "xyz789",
-  "is_visible": true,
-  "payment_intent": "abc123",
-  "payment_source": "xyz789",
+  "code": "abc123",
+  "is_visible": false,
+  "payment_intent": "xyz789",
+  "payment_source": "abc123",
   "sdk_params": [SDKParams],
-  "sort_order": "abc123",
-  "title": "xyz789"
+  "sort_order": "xyz789",
+  "title": "abc123"
 }
 
    
-                    
-
    back to top @@ -22600,16 +21590,12 @@
    Fields
    Example
    - - - 
    {
-  "payment_source": "abc123",
+                  
    {
+  "payment_source": "xyz789",
   "payments_order_id": "abc123",
   "paypal_order_id": "xyz789"
 }
 
    
-                    
-
    back to top @@ -22648,12 +21634,8 @@
    Fields
    Example
    - - - 
    {"code": "xyz789"}
+                  
    {"code": "xyz789"}
 
    
-                    
-
    back to top @@ -22707,17 +21689,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "applied_balance": Money,
   "code": "xyz789",
   "current_balance": Money,
   "expiration_date": "xyz789"
 }
 
    
-                    
-
    back to top @@ -22766,16 +21744,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "action_type": "BOOST",
   "rule_id": "abc123",
   "rule_name": "xyz789"
 }
 
    
-                    
-
    back to top @@ -22830,12 +21804,8 @@
    Values
    Example
    - - - 
    "BOOST"
+                  
    "BOOST"
 
    
-                    
-
    back to top @@ -22884,16 +21854,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "applied_balance": Money,
   "current_balance": Money,
-  "enabled": true
+  "enabled": false
 }
 
    
-                    
-
    back to top @@ -22939,15 +21905,11 @@
    Fields
    Example
    - - - 
    {
-  "cart_id": "abc123",
-  "coupon_code": "xyz789"
+                  
    {
+  "cart_id": "xyz789",
+  "coupon_code": "abc123"
 }
 
    
-                    
-
    back to top @@ -22986,12 +21948,8 @@
    Fields
    Example
    - - - 
    {"cart": Cart}
+                  
    {"cart": Cart}
 
    
-                    
-
    back to top @@ -23037,12 +21995,8 @@
    Values
    Example
    - - - 
    "APPEND"
+                  
    "APPEND"
 
    
-                    
-
    back to top @@ -23096,16 +22050,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "cart_id": "abc123",
   "coupon_codes": ["xyz789"],
   "type": "APPEND"
 }
 
    
-                    
-
    back to top @@ -23151,15 +22101,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "cart_id": "abc123",
-  "gift_card_code": "abc123"
+  "gift_card_code": "xyz789"
 }
 
    
-                    
-
    back to top @@ -23198,12 +22144,8 @@
    Fields
    Example
    - - - 
    {"cart": Cart}
+                  
    {"cart": Cart}
 
    
-                    
-
    back to top @@ -23247,15 +22189,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "applied_balance": Money,
   "code": "xyz789"
 }
 
    
-                    
-
    back to top @@ -23294,12 +22232,8 @@
    Fields
    Example
    - - - 
    {"cart": Cart}
+                  
    {"cart": Cart}
 
    
-                    
-
    back to top @@ -23339,12 +22273,8 @@
    Fields
    Example
    - - - 
    {"cart_id": "abc123"}
+                  
    {"cart_id": "xyz789"}
 
    
-                    
-
    back to top @@ -23383,12 +22313,8 @@
    Fields
    Example
    - - - 
    {"cart": Cart}
+                  
    {"cart": Cart}
 
    
-                    
-
    back to top @@ -23434,12 +22360,8 @@
    Fields
    Example
    - - - 
    {"radius": 123, "search_term": "abc123"}
+                  
    {"radius": 123, "search_term": "abc123"}
 
    
-                    
-
    back to top @@ -23498,18 +22420,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "asset_image": ProductMediaGalleryEntriesAssetImage,
-  "disabled": true,
-  "label": "xyz789",
+  "disabled": false,
+  "label": "abc123",
   "position": 123,
-  "url": "xyz789"
+  "url": "abc123"
 }
 
    
-                    
-
    back to top @@ -23568,18 +22486,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "asset_video": ProductMediaGalleryEntriesAssetVideo,
-  "disabled": true,
-  "label": "abc123",
+  "disabled": false,
+  "label": "xyz789",
   "position": 123,
-  "url": "xyz789"
+  "url": "abc123"
 }
 
    
-                    
-
    back to top @@ -23623,12 +22537,8 @@
    Fields
    Example
    - - - 
    {"compare_list": CompareList, "result": false}
+                  
    {"compare_list": CompareList, "result": false}
 
    
-                    
-
    back to top @@ -23697,12 +22607,64 @@
    Values
    Example
    - - - 
    "CATALOG_PRODUCT"
+                  
    "CATALOG_PRODUCT"
+
    
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    AttributeFile

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    attribute_type - String + Attribute type code.
    code - ID! + The attribute code.
    url - String! + File URL to download the file.
    value - String! + File code. For file download use url field.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "attribute_type": "abc123",
+  "code": "4",
+  "url": "xyz789",
+  "value": "abc123"
+}
    - -
    back to top @@ -23808,25 +22770,21 @@
    Fields
    Example
    - - - 
    {
-  "is_comparable": false,
+                  
    {
+  "is_comparable": true,
   "is_filterable": true,
-  "is_filterable_in_search": true,
-  "is_html_allowed_on_front": false,
+  "is_filterable_in_search": false,
+  "is_html_allowed_on_front": true,
   "is_searchable": false,
   "is_used_for_customer_segment": true,
-  "is_used_for_price_rules": false,
-  "is_used_for_promo_rules": true,
+  "is_used_for_price_rules": true,
+  "is_used_for_promo_rules": false,
   "is_visible_in_advanced_search": true,
-  "is_visible_on_front": false,
-  "is_wysiwyg_enabled": false,
+  "is_visible_on_front": true,
+  "is_wysiwyg_enabled": true,
   "used_in_product_listing": false
 }
 
    
-                    
-
    back to top @@ -23972,12 +22930,64 @@
    Values
    Example
    - - - 
    "BOOLEAN"
+                  
    "BOOLEAN"
+
    
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    AttributeImage

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    attribute_type - String + Attribute type code.
    code - ID! + The attribute code.
    url - String! + Image URL to download the image.
    value - String! + Image code. For image download use url field.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "attribute_type": "xyz789",
+  "code": 4,
+  "url": "abc123",
+  "value": "xyz789"
+}
    - -
    back to top @@ -24023,15 +23033,11 @@
    Fields
    Example
    - - - 
    {
-  "attribute_code": "abc123",
+                  
    {
+  "attribute_code": "xyz789",
   "entity_type": "abc123"
 }
 
    
-                    
-
    back to top @@ -24071,12 +23077,8 @@
    Fields
    Example
    - - - 
    {"value": "abc123"}
+                  
    {"value": "abc123"}
 
    
-                    
-
    back to top @@ -24155,22 +23157,18 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "code": 4,
-  "default_value": "abc123",
+  "default_value": "xyz789",
   "entity_type": "CATALOG_PRODUCT",
-  "frontend_class": "xyz789",
+  "frontend_class": "abc123",
   "frontend_input": "BOOLEAN",
   "is_required": true,
-  "is_unique": false,
+  "is_unique": true,
   "label": "xyz789",
   "options": [CustomAttributeOptionInterface]
 }
 
    
-                    
-
    back to top @@ -24214,15 +23212,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "message": "xyz789",
   "type": "ENTITY_NOT_FOUND"
 }
 
    
-                    
-
    back to top @@ -24280,12 +23274,8 @@
    Values
    Example
    - - - 
    "ENTITY_NOT_FOUND"
+                  
    "ENTITY_NOT_FOUND"
 
    
-                    
-
    back to top @@ -24329,15 +23319,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "filterableInSearch": [FilterableInSearchAttribute],
   "sortable": [SortableAttribute]
 }
 
    
-                    
-
    back to top @@ -24386,16 +23372,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "is_default": false,
   "label": "xyz789",
-  "value": "xyz789"
+  "value": "abc123"
 }
 
    
-                    
-
    back to top @@ -24435,15 +23417,11 @@
    Fields
    Example
    - - - 
    {
-  "label": "abc123",
+                  
    {
+  "label": "xyz789",
   "value": "abc123"
 }
 
    
-                    
-
    back to top @@ -24500,15 +23478,11 @@
    Possible Types
    Example
    - - - 
    {
+                  
    {
   "label": "xyz789",
   "value": "abc123"
 }
 
    
-                    
-
    back to top @@ -24531,6 +23505,11 @@
    Fields
    + + attribute_type - String + + Attribute type code. + code - ID! @@ -24549,15 +23528,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
+  "attribute_type": "xyz789",
   "code": 4,
   "selected_options": [AttributeSelectedOptionInterface]
 }
 
    
-                    
-
    back to top @@ -24580,6 +23556,11 @@
    Fields
    + + attribute_type - String + + Attribute type code. + code - ID! @@ -24597,15 +23578,12 @@
    Fields
    Example
    - - - 
    {
-  "code": "4",
-  "value": "xyz789"
+                  
    {
+  "attribute_type": "abc123",
+  "code": 4,
+  "value": "abc123"
 }
 
    
-                    
-
    back to top @@ -24657,16 +23635,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "attribute_code": "xyz789",
   "selected_options": [AttributeInputSelectedOption],
-  "value": "xyz789"
+  "value": "abc123"
 }
 
    
-                    
-
    back to top @@ -24689,6 +23663,11 @@
    Fields
    + + attribute_type - String + + Attribute type code. + code - ID! @@ -24706,6 +23685,16 @@
    Possible Types
    + + +

    AttributeFile

    + + + + +

    AttributeImage

    + +

    AttributeSelectedOptions

    @@ -24723,12 +23712,11 @@
    Possible Types
    Example
    - - - 
    {"code": "4"}
+                  
    {
+  "attribute_type": "abc123",
+  "code": "4"
+}
 
    
-                    
-
    back to top @@ -24772,15 +23760,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "errors": [AttributeMetadataError],
   "items": [CustomAttributeMetadataInterface]
 }
 
    
-                    
-
    back to top @@ -24824,15 +23808,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "errors": [AttributeMetadataError],
   "items": [CustomAttributeMetadataInterface]
 }
 
    
-                    
-
    back to top @@ -24876,12 +23856,8 @@
    Fields
    Example
    - - - 
    {"code": "AFN", "symbol": "xyz789"}
+                  
    {"code": "AFN", "symbol": "abc123"}
 
    
-                    
-
    back to top @@ -24935,17 +23911,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "code": "abc123",
-  "is_deferred": true,
+  "is_deferred": false,
   "oope_payment_method_config": OopePaymentMethodConfig,
-  "title": "abc123"
+  "title": "xyz789"
 }
 
    
-                    
-
    back to top @@ -25029,23 +24001,19 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "additional_data": [ShippingAdditionalData],
   "amount": Money,
-  "available": true,
-  "carrier_code": "xyz789",
+  "available": false,
+  "carrier_code": "abc123",
   "carrier_title": "xyz789",
   "error_message": "xyz789",
-  "method_code": "abc123",
+  "method_code": "xyz789",
   "method_title": "abc123",
   "price_excl_tax": Money,
   "price_incl_tax": Money
 }
 
    
-                    
-
    back to top @@ -25096,12 +24064,8 @@
    Values
    Example
    - - - 
    "SUCCESS"
+                  
    "SUCCESS"
 
    
-                    
-
    back to top @@ -25140,6 +24104,12 @@
    Fields
    An ID from the customer's address book that uniquely identifies the address to be used for billing. + + + customer_address_uid - ID + + The unique ID from the customer's address book that uniquely identifies the address to be used for billing. + same_as_shipping - Boolean @@ -25159,17 +24129,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "address": CartAddressInput,
-  "customer_address_id": 123,
-  "same_as_shipping": false,
-  "use_for_shipping": true
+  "customer_address_id": 987,
+  "customer_address_uid": "4",
+  "same_as_shipping": true,
+  "use_for_shipping": false
 }
 
    
-                    
-
    back to top @@ -25239,9 +24206,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "address_line_1": "xyz789",
   "address_line_2": "abc123",
   "city": "xyz789",
@@ -25250,8 +24215,6 @@ 
    Example
    
   "region": "abc123"
 }
 
    
-                    
-
    back to top @@ -25298,6 +24261,11 @@
    Fields
    The custom attribute values of the billing or shipping address. + + customer_address_uid - ID + + The unique ID from the customer's address book that uniquely identifies the address. + fax - String @@ -25309,9 +24277,10 @@
    Fields
    The first name of the customer or guest. - id - Int + id - Int + + Id of the customer address. Use customer_address_uid instead. - Id of the customer address. lastname - String! @@ -25354,9 +24323,9 @@
    Fields
    The telephone number for the billing or shipping address. - uid - String! + uid - ID! - The unique id of the customer address. + The unique id of the customer cart address. vat_id - String @@ -25370,30 +24339,27 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "city": "xyz789",
   "company": "abc123",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
+  "customer_address_uid": "4",
   "fax": "xyz789",
-  "firstname": "abc123",
+  "firstname": "xyz789",
   "id": 123,
   "lastname": "xyz789",
   "middlename": "xyz789",
-  "postcode": "abc123",
+  "postcode": "xyz789",
   "prefix": "abc123",
   "region": CartAddressRegion,
   "street": ["abc123"],
   "suffix": "xyz789",
   "telephone": "xyz789",
-  "uid": "abc123",
+  "uid": "4",
   "vat_id": "abc123"
 }
 
    
-                    
-
    back to top @@ -25469,18 +24435,14 @@
    Fields
    Example
    - - - 
    {
-  "category_level": 987,
+                  
    {
+  "category_level": 123,
   "category_name": "xyz789",
   "category_uid": "4",
   "category_url_key": "abc123",
   "category_url_path": "xyz789"
 }
 
    
-                    
-
    back to top @@ -25556,12 +24518,8 @@
    Possible Types
    Example
    - - - 
    {"title": "xyz789"}
+                  
    {"title": "abc123"}
 
    
-                    
-
    back to top @@ -25686,9 +24644,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "available_gift_wrapping": [GiftWrapping],
   "bundle_options": [SelectedBundleOption],
   "custom_attributes": [CustomAttribute],
@@ -25698,19 +24654,17 @@ 
    Example
    
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
   "is_available": true,
-  "max_qty": 123.45,
-  "min_qty": 987.65,
-  "not_available_message": "abc123",
+  "max_qty": 987.65,
+  "min_qty": 123.45,
+  "not_available_message": "xyz789",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "uid": 4
 }
 
    
-                    
-
    back to top @@ -25789,22 +24743,18 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "bundle_options": [ItemSelectedBundleOption],
   "custom_attributes": [CustomAttribute],
   "discounts": [Discount],
   "id": "4",
   "order_item": OrderItemInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "xyz789",
-  "quantity_refunded": 987.65
+  "quantity_refunded": 123.45
 }
 
    
-                    
-
    back to top @@ -25883,22 +24833,18 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "bundle_options": [ItemSelectedBundleOption],
   "custom_attributes": [CustomAttribute],
   "discounts": [Discount],
-  "id": "4",
+  "id": 4,
   "order_item": OrderItemInterface,
-  "product_name": "xyz789",
+  "product_name": "abc123",
   "product_sale_price": Money,
   "product_sku": "xyz789",
-  "quantity_invoiced": 123.45
+  "quantity_invoiced": 987.65
 }
 
    
-                    
-
    back to top @@ -25972,21 +24918,17 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "options": [BundleItemOption],
   "position": 123,
   "price_range": PriceRange,
-  "required": false,
-  "sku": "abc123",
+  "required": true,
+  "sku": "xyz789",
   "title": "abc123",
   "type": "abc123",
   "uid": "4"
 }
 
    
-                    
-
    back to top @@ -26065,22 +25007,18 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "can_change_quantity": false,
-  "is_default": true,
-  "label": "abc123",
-  "position": 987,
+  "is_default": false,
+  "label": "xyz789",
+  "position": 123,
   "price": 987.65,
   "price_type": "FIXED",
   "product": ProductInterface,
-  "quantity": 987.65,
-  "uid": 4
+  "quantity": 123.45,
+  "uid": "4"
 }
 
    
-                    
-
    back to top @@ -26158,7 +25096,7 @@
    Fields
    Contains details about the price of the item, including taxes and discounts. - product - ProductInterface! + product - ProductInterface The ProductInterface object, which contains details about the base product Product information is part of a composable Catalog Service. @@ -26240,9 +25178,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "bundle_options": [ItemSelectedBundleOption],
   "custom_attributes": [CustomAttribute],
   "discounts": [Discount],
@@ -26257,21 +25193,19 @@ 
    Example
    
   "product_name": "abc123",
   "product_sale_price": Money,
   "product_sku": "xyz789",
-  "product_type": "abc123",
-  "product_url_key": "abc123",
+  "product_type": "xyz789",
+  "product_url_key": "xyz789",
   "quantity_canceled": 123.45,
   "quantity_invoiced": 987.65,
   "quantity_ordered": 123.45,
-  "quantity_refunded": 987.65,
-  "quantity_return_requested": 123.45,
+  "quantity_refunded": 123.45,
+  "quantity_return_requested": 987.65,
   "quantity_returned": 123.45,
   "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
-  "status": "xyz789"
+  "status": "abc123"
 }
 
    
-                    
-
    back to top @@ -26558,34 +25492,32 @@
    filters
    Example
    - - - 
    {
-  "canonical_url": "abc123",
+                  
    {
+  "canonical_url": "xyz789",
   "categories": [CategoryInterface],
   "country_of_manufacture": "xyz789",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "dynamic_price": true,
-  "dynamic_sku": false,
+  "dynamic_price": false,
+  "dynamic_sku": true,
   "dynamic_weight": false,
   "gift_message_available": true,
-  "gift_wrapping_available": true,
+  "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
   "image": ProductImage,
-  "is_returnable": "abc123",
+  "is_returnable": "xyz789",
   "items": [BundleItem],
-  "manufacturer": 123,
-  "max_sale_qty": 123.45,
+  "manufacturer": 987,
+  "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
   "meta_description": "xyz789",
   "meta_keyword": "xyz789",
-  "meta_title": "abc123",
+  "meta_title": "xyz789",
   "min_sale_qty": 987.65,
-  "name": "abc123",
+  "name": "xyz789",
   "new_from_date": "xyz789",
-  "new_to_date": "abc123",
+  "new_to_date": "xyz789",
   "only_x_left_in_stock": 987.65,
   "options": [CustomizableOptionInterface],
   "options_container": "abc123",
@@ -26594,25 +25526,23 @@ 
    Example
    
   "price_tiers": [TierPrice],
   "price_view": "PRICE_RANGE",
   "product_links": [ProductLinksInterface],
-  "quantity": 123.45,
+  "quantity": 987.65,
   "related_products": [ProductInterface],
   "ship_bundle_items": "TOGETHER",
   "short_description": ComplexTextValue,
   "sku": "abc123",
   "small_image": ProductImage,
   "special_price": 123.45,
-  "special_to_date": "xyz789",
+  "special_to_date": "abc123",
   "stock_status": "IN_STOCK",
   "swatch_image": "xyz789",
   "thumbnail": ProductImage,
-  "uid": "4",
+  "uid": 4,
   "upsell_products": [ProductInterface],
-  "url_key": "xyz789",
+  "url_key": "abc123",
   "weight": 123.45
 }
 
    
-                    
-
    back to top @@ -26671,18 +25601,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "bundle_options": [SelectedBundleOption],
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 123.45,
-  "uid": 4
+  "quantity": 987.65,
+  "uid": "4"
 }
 
    
-                    
-
    back to top @@ -26751,20 +25677,16 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "bundle_options": [ItemSelectedBundleOption],
   "id": 4,
   "order_item": OrderItemInterface,
-  "product_name": "xyz789",
+  "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "abc123",
+  "product_sku": "xyz789",
   "quantity_shipped": 123.45
 }
 
    
-                    
-
    back to top @@ -26834,20 +25756,16 @@
    Fields
    Example
    - - - 
    {
-  "added_at": "abc123",
+                  
    {
+  "added_at": "xyz789",
   "bundle_options": [SelectedBundleOption],
   "customizable_options": [SelectedCustomizableOption],
-  "description": "xyz789",
+  "description": "abc123",
   "id": "4",
   "product": ProductInterface,
   "quantity": 987.65
 }
 
    
-                    
-
    back to top @@ -26912,20 +25830,16 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "color": "xyz789",
   "height": 987,
   "label": "abc123",
-  "layout": "xyz789",
+  "layout": "abc123",
   "shape": "abc123",
-  "tagline": false,
+  "tagline": true,
   "use_default_height": false
 }
 
    
-                    
-
    back to top @@ -26971,15 +25885,11 @@
    Fields
    Example
    - - - 
    {
-  "cancellation_comment": "xyz789",
-  "template_id": "4"
+                  
    {
+  "cancellation_comment": "abc123",
+  "template_id": 4
 }
 
    
-                    
-
    back to top @@ -27019,15 +25929,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "code": "ORDER_CANCELLATION_DISABLED",
   "message": "xyz789"
 }
 
    
-                    
-
    back to top @@ -27099,12 +26005,8 @@
    Values
    Example
    - - - 
    "ORDER_CANCELLATION_DISABLED"
+                  
    "ORDER_CANCELLATION_DISABLED"
 
    
-                    
-
    back to top @@ -27150,12 +26052,8 @@
    Fields
    Example
    - - - 
    {"order_id": 4, "reason": "abc123"}
+                  
    {"order_id": 4, "reason": "xyz789"}
 
    
-                    
-
    back to top @@ -27205,16 +26103,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "error": "abc123",
   "errorV2": CancelOrderError,
   "order": CustomerOrder
 }
 
    
-                    
-
    back to top @@ -27250,12 +26144,8 @@
    Fields
    Example
    - - - 
    {"description": "xyz789"}
+                  
    {"description": "xyz789"}
 
    
-                    
-
    back to top @@ -27310,18 +26200,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "bin_details": CardBin,
-  "card_expiry_month": "abc123",
+  "card_expiry_month": "xyz789",
   "card_expiry_year": "xyz789",
   "last_digits": "abc123",
   "name": "abc123"
 }
 
    
-                    
-
    back to top @@ -27356,12 +26242,8 @@
    Fields
    Example
    - - - 
    {"bin": "xyz789"}
+                  
    {"bin": "xyz789"}
 
    
-                    
-
    back to top @@ -27407,15 +26289,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "billing_address": BillingAddressPaymentSourceInput,
-  "name": "xyz789"
+  "name": "abc123"
 }
 
    
-                    
-
    back to top @@ -27464,16 +26342,12 @@
    Fields
    Example
    - - - 
    {
-  "brand": "abc123",
+                  
    {
+  "brand": "xyz789",
   "expiry": "xyz789",
-  "last_digits": "abc123"
+  "last_digits": "xyz789"
 }
 
    
-                    
-
    back to top @@ -27634,9 +26508,7 @@
    sort
    Example
    - - - 
    {
+                  
    {
   "applied_coupons": [AppliedCoupon],
   "applied_gift_cards": [AppliedGiftCard],
   "applied_reward_points": RewardPointsAmount,
@@ -27645,23 +26517,21 @@ 
    Example
    
   "available_payment_methods": [AvailablePaymentMethod],
   "billing_address": BillingCartAddress,
   "custom_attributes": [CustomAttribute],
-  "email": "abc123",
+  "email": "xyz789",
   "gift_message": GiftMessage,
-  "gift_receipt_included": false,
+  "gift_receipt_included": true,
   "gift_wrapping": GiftWrapping,
-  "id": "4",
+  "id": 4,
   "is_virtual": false,
   "itemsV2": CartItems,
   "prices": CartPrices,
-  "printed_card_included": false,
+  "printed_card_included": true,
   "rules": [CartRuleStorefront],
   "selected_payment_method": SelectedPaymentMethod,
   "shipping_addresses": [ShippingCartAddress],
   "total_quantity": 123.45
 }
 
    
-                    
-
    back to top @@ -27705,15 +26575,11 @@
    Fields
    Example
    - - - 
    {
-  "code": "xyz789",
-  "label": "xyz789"
+                  
    {
+  "code": "abc123",
+  "label": "abc123"
 }
 
    
-                    
-
    back to top @@ -27849,30 +26715,26 @@
    Fields
    Example
    - - - 
    {
-  "city": "xyz789",
-  "company": "xyz789",
-  "country_code": "xyz789",
+                  
    {
+  "city": "abc123",
+  "company": "abc123",
+  "country_code": "abc123",
   "custom_attributes": [AttributeValueInput],
-  "fax": "abc123",
+  "fax": "xyz789",
   "firstname": "xyz789",
   "lastname": "xyz789",
-  "middlename": "xyz789",
+  "middlename": "abc123",
   "postcode": "xyz789",
   "prefix": "abc123",
   "region": "xyz789",
   "region_id": 123,
   "save_in_address_book": true,
-  "street": ["xyz789"],
-  "suffix": "xyz789",
+  "street": ["abc123"],
+  "suffix": "abc123",
   "telephone": "abc123",
   "vat_id": "abc123"
 }
 
    
-                    
-
    back to top @@ -27915,6 +26777,11 @@
    Fields
    The custom attribute values of the billing or shipping address. + + customer_address_uid - ID + + The unique ID from the customer's address book that uniquely identifies the address. + fax - String @@ -27926,9 +26793,10 @@
    Fields
    The first name of the customer or guest. - id - Int + id - Int + + Id of the customer address. Use customer_address_uid instead. - Id of the customer address. lastname - String! @@ -27971,9 +26839,9 @@
    Fields
    The telephone number for the billing or shipping address. - uid - String! + uid - ID! - The unique id of the customer address. + The unique id of the customer cart address. vat_id - String @@ -28009,30 +26877,27 @@
    Possible Types
    Example
    - - - 
    {
-  "city": "xyz789",
-  "company": "xyz789",
+                  
    {
+  "city": "abc123",
+  "company": "abc123",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
+  "customer_address_uid": 4,
   "fax": "xyz789",
   "firstname": "abc123",
-  "id": 987,
-  "lastname": "xyz789",
+  "id": 123,
+  "lastname": "abc123",
   "middlename": "abc123",
   "postcode": "abc123",
   "prefix": "xyz789",
   "region": CartAddressRegion,
   "street": ["xyz789"],
-  "suffix": "abc123",
-  "telephone": "abc123",
-  "uid": "xyz789",
+  "suffix": "xyz789",
+  "telephone": "xyz789",
+  "uid": "4",
   "vat_id": "xyz789"
 }
 
    
-                    
-
    back to top @@ -28081,16 +26946,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "code": "xyz789",
-  "label": "xyz789",
+  "label": "abc123",
   "region_id": 123
 }
 
    
-                    
-
    back to top @@ -28136,15 +26997,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "cart_id": "abc123",
   "custom_attributes": [CustomAttributeInput]
 }
 
    
-                    
-
    back to top @@ -28188,12 +27045,8 @@
    Values
    Example
    - - - 
    "ITEM"
+                  
    "ITEM"
 
    
-                    
-
    back to top @@ -28245,16 +27098,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "cart_id": "xyz789",
   "cart_item_id": "xyz789",
   "custom_attributes": [CustomAttributeInput]
 }
 
    
-                    
-
    back to top @@ -28294,12 +27143,8 @@
    Fields
    Example
    - - - 
    {"code": "UNDEFINED", "message": "abc123"}
+                  
    {"code": "UNDEFINED", "message": "abc123"}
 
    
-                    
-
    back to top @@ -28350,12 +27195,8 @@
    Values
    Example
    - - - 
    "UNDEFINED"
+                  
    "UNDEFINED"
 
    
-                    
-
    back to top @@ -28419,18 +27260,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "entered_options": [EnteredOptionInput],
   "parent_sku": "abc123",
-  "quantity": 123.45,
+  "quantity": 987.65,
   "selected_options": [4],
   "sku": "abc123"
 }
 
    
-                    
-
    back to top @@ -28572,26 +27409,22 @@
    Possible Types
    Example
    - - - 
    {
+                  
    {
   "custom_attributes": [CustomAttribute],
   "discount": [Discount],
   "errors": [CartItemError],
-  "is_available": true,
-  "max_qty": 123.45,
+  "is_available": false,
+  "max_qty": 987.65,
   "min_qty": 987.65,
-  "not_available_message": "abc123",
+  "not_available_message": "xyz789",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "uid": "4"
 }
 
    
-                    
-
    back to top @@ -28680,9 +27513,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "catalog_discount": ProductDiscount,
   "discounts": [Discount],
   "fixed_product_taxes": [FixedProductTax],
@@ -28696,8 +27527,6 @@ 
    Example
    
   "total_item_discount": Money
 }
 
    
-                    
-
    back to top @@ -28746,16 +27575,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "type": "FIXED",
-  "units": "abc123",
-  "value": 987.65
+  "units": "xyz789",
+  "value": 123.45
 }
 
    
-                    
-
    back to top @@ -28819,18 +27644,14 @@
    Fields
    Example
    - - - 
    {
-  "cart_item_uid": 4,
+                  
    {
+  "cart_item_uid": "4",
   "customizable_options": [CustomizableOptionInput],
   "gift_message": GiftMessageInput,
   "gift_wrapping_id": 4,
-  "quantity": 123.45
+  "quantity": 987.65
 }
 
    
-                    
-
    back to top @@ -28875,16 +27696,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "items": [CartItemInterface],
   "page_info": SearchResultPageInfo,
   "total_count": 123
 }
 
    
-                    
-
    back to top @@ -28958,9 +27775,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "applied_taxes": [CartTaxItem],
   "discounts": [Discount],
   "gift_options": GiftOptionsPrices,
@@ -28971,8 +27786,6 @@ 
    Example
    
   "subtotal_with_discount_excluding_tax": Money
 }
 
    
-                    
-
    back to top @@ -29007,12 +27820,8 @@
    Fields
    Example
    - - - 
    {"uid": 4}
+                  
    {"uid": 4}
 
    
-                    
-
    back to top @@ -29056,15 +27865,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "amount": Money,
-  "label": "xyz789"
+  "label": "abc123"
 }
 
    
-                    
-
    back to top @@ -29104,15 +27909,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "code": "PRODUCT_NOT_FOUND",
   "message": "xyz789"
 }
 
    
-                    
-
    back to top @@ -29198,12 +27999,8 @@
    Values
    Example
    - - - 
    "PRODUCT_NOT_FOUND"
+                  
    "PRODUCT_NOT_FOUND"
 
    
-                    
-
    back to top @@ -29282,12 +28079,8 @@
    Values
    Example
    - - - 
    "SIMPLE"
+                  
    "SIMPLE"
 
    
-                    
-
    back to top @@ -29441,37 +28234,33 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "apply_to": ["SIMPLE"],
-  "code": "4",
+  "code": 4,
   "default_value": "xyz789",
   "entity_type": "CATALOG_PRODUCT",
-  "frontend_class": "abc123",
+  "frontend_class": "xyz789",
   "frontend_input": "BOOLEAN",
   "is_comparable": true,
-  "is_filterable": false,
+  "is_filterable": true,
   "is_filterable_in_search": false,
-  "is_html_allowed_on_front": true,
+  "is_html_allowed_on_front": false,
   "is_required": true,
-  "is_searchable": false,
-  "is_unique": false,
+  "is_searchable": true,
+  "is_unique": true,
   "is_used_for_price_rules": false,
   "is_used_for_promo_rules": false,
   "is_visible_in_advanced_search": true,
-  "is_visible_on_front": false,
-  "is_wysiwyg_enabled": false,
-  "label": "xyz789",
+  "is_visible_on_front": true,
+  "is_wysiwyg_enabled": true,
+  "label": "abc123",
   "options": [CustomAttributeOptionInterface],
   "swatch_input_type": "BOOLEAN",
   "update_product_preview_image": true,
-  "use_product_image_for_swatch": true,
-  "used_in_product_listing": true
+  "use_product_image_for_swatch": false,
+  "used_in_product_listing": false
 }
 
    
-                    
-
    back to top @@ -29529,17 +28318,13 @@
    Fields
    Example
    - - - 
    {
-  "count": 123,
-  "id": "4",
+                  
    {
+  "count": 987,
+  "id": 4,
   "path": "xyz789",
   "title": "xyz789"
 }
 
    
-                    
-
    back to top @@ -29592,12 +28377,68 @@
    Possible Types
    Example
    - - - 
    {"id": 4}
+                  
    {"id": 4}
+
    
+
    +
    + back to top + +
    +
    +
    + Types +
    +

    CategoryImage

    +
    +
    +
    +
    Description
    +

    Represents an image associated with a category.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    url - String! + The URL where the image is hosted.
    label - String + A descriptive label or alt text for the image.
    roles - [String] + Standard predefined roles for the image.
    customRoles - [String] + Custom roles specific to the implementation.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "url": "xyz789",
+  "label": "abc123",
+  "roles": ["xyz789"],
+  "customRoles": ["abc123"]
+}
    - -
    back to top @@ -29785,25 +28626,23 @@
    Possible Types
    Example
    - - - 
    {
-  "available_sort_by": ["xyz789"],
+                  
    {
+  "available_sort_by": ["abc123"],
   "breadcrumbs": [Breadcrumb],
   "canonical_url": "xyz789",
-  "children_count": "xyz789",
-  "custom_layout_update_file": "abc123",
+  "children_count": "abc123",
+  "custom_layout_update_file": "xyz789",
   "default_sort_by": "xyz789",
   "description": "xyz789",
   "display_mode": "xyz789",
   "filter_price_range": 987.65,
   "image": "xyz789",
-  "include_in_menu": 123,
-  "is_anchor": 123,
+  "include_in_menu": 987,
+  "is_anchor": 987,
   "landing_page": 987,
-  "level": 123,
-  "meta_description": "xyz789",
-  "meta_keywords": "abc123",
+  "level": 987,
+  "meta_description": "abc123",
+  "meta_keywords": "xyz789",
   "meta_title": "xyz789",
   "name": "abc123",
   "path": "abc123",
@@ -29812,11 +28651,177 @@ 
    Example
    
   "product_count": 123,
   "uid": "4",
   "url_key": "abc123",
-  "url_path": "xyz789"
+  "url_path": "abc123"
+}
+
    
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    CategoryMetaTags

    +
    +
    +
    +
    Description
    +

    SEO metadata tags for the category.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    title - String + The page title for SEO purposes.
    description - String + The meta description for SEO purposes.
    keywords - [String] + Keywords associated with the category for SEO.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "title": "abc123",
+  "description": "abc123",
+  "keywords": ["abc123"]
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    CategoryNavigationView

    +
    +
    +
    +
    Description
    +

    Represents a category optimized for navigation menus, with nested children for building navigation trees.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    slug - String! + The unique URL-friendly identifier for the category.
    name - String! + The display name of the category.
    children - [CategoryNavigationView] + The direct child categories for building nested navigation menus.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "slug": "xyz789",
+  "name": "abc123",
+  "children": [CategoryNavigationView]
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    CategoryProductView

    +
    +
    +
    +
    Description
    +

    Represents category information associated with a product, including hierarchical parent relationships.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    name - String! + The display name of the category.
    slug - String! + The unique URL-friendly identifier for the category.
    level - Int! + The depth level of the category in the hierarchy (0 for root categories).
    parents - [CategoryProductView!] + The ancestor categories in the hierarchy, ordered from root to immediate parent.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "name": "abc123",
+  "slug": "xyz789",
+  "level": 987,
+  "parents": [CategoryProductView]
 }
    - -
    back to top @@ -29987,38 +28992,118 @@
    Fields
    Example
    - - - 
    {
-  "available_sort_by": ["abc123"],
+                  
    {
+  "available_sort_by": ["xyz789"],
   "breadcrumbs": [Breadcrumb],
-  "canonical_url": "xyz789",
-  "children_count": "xyz789",
+  "canonical_url": "abc123",
+  "children_count": "abc123",
   "custom_layout_update_file": "xyz789",
   "default_sort_by": "abc123",
   "description": "xyz789",
   "display_mode": "xyz789",
   "filter_price_range": 987.65,
-  "image": "xyz789",
-  "include_in_menu": 987,
-  "is_anchor": 123,
-  "landing_page": 987,
+  "image": "abc123",
+  "include_in_menu": 123,
+  "is_anchor": 987,
+  "landing_page": 123,
   "level": 123,
   "meta_description": "abc123",
   "meta_keywords": "xyz789",
-  "meta_title": "xyz789",
-  "name": "xyz789",
+  "meta_title": "abc123",
+  "name": "abc123",
   "path": "xyz789",
   "path_in_store": "abc123",
   "position": 987,
-  "product_count": 123,
+  "product_count": 987,
   "uid": 4,
-  "url_key": "xyz789",
+  "url_key": "abc123",
   "url_path": "abc123"
 }
 
    
-                    
-                  
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    CategoryTreeView

    +
    +
    +
    +
    Description
    +

    Represents a category within a hierarchical tree structure, including parent and children relationships.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    slug - String! + The unique URL-friendly identifier for the category.
    name - String! + The display name of the category.
    description - String + A detailed description of the category.
    metaTags - CategoryMetaTags + SEO metadata tags for the category.
    images - [CategoryImage] + Visual images associated with the category.
    level - Int + The depth level of the category in the tree hierarchy (0 for root categories).
    parentSlug - String + The slug of the parent category, if any.
    childrenSlugs - [String] + The slugs of all direct child categories.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "slug": "xyz789",
+  "name": "abc123",
+  "description": "xyz789",
+  "metaTags": CategoryMetaTags,
+  "images": [CategoryImage],
+  "level": 123,
+  "parentSlug": "abc123",
+  "childrenSlugs": ["xyz789"]
+}
+
    back to top @@ -30134,26 +29219,22 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "availableSortBy": ["xyz789"],
-  "children": ["xyz789"],
-  "defaultSortBy": "xyz789",
-  "id": "4",
-  "level": 123,
-  "name": "abc123",
-  "parentId": "abc123",
-  "path": "abc123",
-  "roles": ["xyz789"],
-  "urlKey": "abc123",
-  "urlPath": "abc123",
-  "count": 987,
-  "title": "abc123"
+  "children": ["abc123"],
+  "defaultSortBy": "abc123",
+  "id": 4,
+  "level": 987,
+  "name": "xyz789",
+  "parentId": "xyz789",
+  "path": "xyz789",
+  "roles": ["abc123"],
+  "urlKey": "xyz789",
+  "urlPath": "xyz789",
+  "count": 123,
+  "title": "xyz789"
 }
 
    
-                    
-
    back to top @@ -30255,22 +29336,93 @@
    Possible Types
    Example
    - - - 
    {
+                  
    {
   "availableSortBy": ["xyz789"],
   "defaultSortBy": "xyz789",
-  "id": 4,
-  "level": 987,
+  "id": "4",
+  "level": 123,
   "name": "xyz789",
   "path": "xyz789",
   "roles": ["xyz789"],
-  "urlKey": "xyz789",
+  "urlKey": "abc123",
   "urlPath": "xyz789"
 }
 
    
-                    
-                  
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    CategoryViewV2

    +
    +
    +
    +
    Description
    +

    Base interface defining essential category fields shared across all category views.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    slug - String! + The unique URL-friendly identifier for the category.
    name - String! + The display name of the category.
    +
    +
    +
    Possible Types
    + + + + + + + + + + + + + + + + + +
    CategoryViewV2 Types
    +

    CategoryNavigationView

    +
    +

    CategoryProductView

    +
    +

    CategoryTreeView

    +
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "slug": "abc123",
+  "name": "xyz789"
+}
+
    back to top @@ -30339,20 +29491,16 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "agreement_id": 987,
-  "checkbox_text": "abc123",
+  "checkbox_text": "xyz789",
   "content": "abc123",
-  "content_height": "xyz789",
+  "content_height": "abc123",
   "is_html": false,
   "mode": "AUTO",
   "name": "abc123"
 }
 
    
-                    
-
    back to top @@ -30398,12 +29546,8 @@
    Values
    Example
    - - - 
    "AUTO"
+                  
    "AUTO"
 
    
-                    
-
    back to top @@ -30452,16 +29596,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "code": "REORDER_NOT_AVAILABLE",
-  "message": "abc123",
+  "message": "xyz789",
   "path": ["abc123"]
 }
 
    
-                    
-
    back to top @@ -30526,12 +29666,8 @@
    Values
    Example
    - - - 
    "REORDER_NOT_AVAILABLE"
+                  
    "REORDER_NOT_AVAILABLE"
 
    
-                    
-
    back to top @@ -30575,12 +29711,8 @@
    Fields
    Example
    - - - 
    {"cart": Cart, "status": false}
+                  
    {"cart": Cart, "status": false}
 
    
-                    
-
    back to top @@ -30624,12 +29756,8 @@
    Types
    Example
    - - - 
    NegotiableQuoteInvalidStateError
+                  
    NegotiableQuoteInvalidStateError
 
    
-                    
-
    back to top @@ -30673,15 +29801,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "errors": [NegotiableQuoteInvalidStateError],
   "quote_uid": 4
 }
 
    
-                    
-
    back to top @@ -30720,12 +29844,8 @@
    Types
    Example
    - - - 
    NegotiableQuoteUidOperationSuccess
+                  
    NegotiableQuoteUidOperationSuccess
 
    
-                    
-
    back to top @@ -30765,12 +29885,8 @@
    Fields
    Example
    - - - 
    {"quote_uids": [4]}
+                  
    {"quote_uids": ["4"]}
 
    
-                    
-
    back to top @@ -30848,9 +29964,7 @@
    sort
    Example
    - - - 
    {
+                  
    {
   "negotiable_quotes": NegotiableQuotesOutput,
   "operation_results": [
     NegotiableQuoteUidOperationSuccess
@@ -30858,8 +29972,6 @@ 
    Example
    
   "result_status": "SUCCESS"
 }
 
    
-                    
-
    back to top @@ -30894,12 +30006,48 @@
    Fields
    Example
    - - - 
    {"value": "abc123"}
+                  
    {"value": "xyz789"}
+
    
+
    +
    + back to top + +
    +
    +
    + Types +
    +

    CommerceOptimizerContext

    +
    +
    +
    +
    Description
    +

    Commerce Optimizer entities

    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Field NameDescription
    priceBookId - ID! + The priceBookId for current customer session.
    +
    +
    +
    +
    +
    Example
    + 
    {"priceBookId": "4"}
    - -
    back to top @@ -30939,12 +30087,8 @@
    Values
    Example
    - - - 
    "NAME"
+                  
    "NAME"
 
    
-                    
-
    back to top @@ -30990,12 +30134,8 @@
    Fields
    Example
    - - - 
    {"field": "NAME", "order": "ASC"}
+                  
    {"field": "NAME", "order": "ASC"}
 
    
-                    
-
    back to top @@ -31027,6 +30167,16 @@
    Fields
    The list of all resources defined within the company. + + available_payment_methods - [AvailablePaymentMethod] + + Available payment methods for the company with proper B2B configuration and company-specific filtering. + + + available_shipping_methods - [CompanyAvailableShippingMethod] + + Available shipping carriers for the company with proper B2B configuration and company-specific filtering. + company_admin - Customer @@ -31150,6 +30300,11 @@
    currentPage An object containing information about the company sales representative. + + status - CompanyStatusEnum + + The current status of the company. + structure - CompanyStructure @@ -31251,24 +30406,27 @@
    currentPage
    Example
    - - - 
    {
+                  
    {
   "acl_resources": [CompanyAclResource],
+  "available_payment_methods": [AvailablePaymentMethod],
+  "available_shipping_methods": [
+    CompanyAvailableShippingMethod
+  ],
   "company_admin": Customer,
   "credit": CompanyCredit,
   "credit_history": CompanyCreditHistory,
   "custom_attributes": [CustomAttribute],
-  "email": "abc123",
-  "id": 4,
+  "email": "xyz789",
+  "id": "4",
   "legal_address": CompanyLegalAddress,
   "legal_name": "xyz789",
-  "name": "abc123",
-  "payment_methods": ["abc123"],
+  "name": "xyz789",
+  "payment_methods": ["xyz789"],
   "reseller_id": "abc123",
   "role": CompanyRole,
   "roles": CompanyRoles,
   "sales_representative": CompanySalesRepresentative,
+  "status": "PENDING",
   "structure": CompanyStructure,
   "team": CompanyTeam,
   "user": Customer,
@@ -31276,8 +30434,6 @@ 
    Example
    
   "vat_tax_id": "xyz789"
 }
 
    
-                    
-
    back to top @@ -31331,17 +30487,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "children": [CompanyAclResource],
-  "id": 4,
+  "id": "4",
   "sort_order": 123,
-  "text": "abc123"
+  "text": "xyz789"
 }
 
    
-                    
-
    back to top @@ -31417,20 +30569,66 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "custom_attributes": [AttributeValueInput],
   "email": "xyz789",
-  "firstname": "xyz789",
+  "firstname": "abc123",
   "gender": 123,
-  "job_title": "xyz789",
+  "job_title": "abc123",
   "lastname": "abc123",
-  "telephone": "xyz789"
+  "telephone": "abc123"
+}
+
    
+
    +
    + back to top + +
    +
    +
    + Types +
    +

    CompanyAvailableShippingMethod

    +
    +
    +
    +
    Description
    +

    Describes a carrier-level shipping option available to the company.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    code - String! + +
    title - String! + +
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "code": "abc123",
+  "title": "abc123"
 }
    - -
    back to top @@ -31472,6 +30670,11 @@
    Fields
    The name of the company. + + status - CompanyStatusEnum + + The current status of the company. +
    @@ -31479,16 +30682,13 @@
    Fields
    Example
    - - - 
    {
-  "id": 4,
+                  
    {
+  "id": "4",
   "legal_name": "abc123",
-  "name": "xyz789"
+  "name": "xyz789",
+  "status": "PENDING"
 }
 
    
-                    
-
    back to top @@ -31564,20 +30764,16 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "company_admin": CompanyAdminInput,
-  "company_email": "xyz789",
-  "company_name": "abc123",
+  "company_email": "abc123",
+  "company_name": "xyz789",
   "legal_address": CompanyLegalAddressCreateInput,
   "legal_name": "xyz789",
   "reseller_id": "abc123",
-  "vat_tax_id": "abc123"
+  "vat_tax_id": "xyz789"
 }
 
    
-                    
-
    back to top @@ -31614,6 +30810,11 @@
    Fields
    The amount of credit extended to the company. + + exceed_limit - Boolean! + + Indicates whether company credit functionality is allowed to exceed current company credit limit. + outstanding_balance - Money! @@ -31626,16 +30827,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "available_credit": Money,
   "credit_limit": Money,
+  "exceed_limit": true,
   "outstanding_balance": Money
 }
 
    
-                    
-
    back to top @@ -31684,16 +30882,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "items": [CompanyCreditOperation],
   "page_info": SearchResultPageInfo,
   "total_count": 123
 }
 
    
-                    
-
    back to top @@ -31745,16 +30939,12 @@
    Fields
    Example
    - - - 
    {
-  "custom_reference_number": "abc123",
+                  
    {
+  "custom_reference_number": "xyz789",
   "operation_type": "ALLOCATION",
-  "updated_by": "abc123"
+  "updated_by": "xyz789"
 }
 
    
-                    
-
    back to top @@ -31818,19 +31008,15 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "amount": Money,
   "balance": CompanyCredit,
   "custom_reference_number": "xyz789",
-  "date": "abc123",
+  "date": "xyz789",
   "type": "ALLOCATION",
   "updated_by": CompanyCreditOperationUser
 }
 
    
-                    
-
    back to top @@ -31902,12 +31088,8 @@
    Values
    Example
    - - - 
    "ALLOCATION"
+                  
    "ALLOCATION"
 
    
-                    
-
    back to top @@ -31951,12 +31133,8 @@
    Fields
    Example
    - - - 
    {"name": "xyz789", "type": "CUSTOMER"}
+                  
    {"name": "abc123", "type": "CUSTOMER"}
 
    
-                    
-
    back to top @@ -32000,12 +31178,8 @@
    Values
    Example
    - - - 
    "CUSTOMER"
+                  
    "CUSTOMER"
 
    
-                    
-
    back to top @@ -32057,16 +31231,12 @@
    Fields
    Example
    - - - 
    {
-  "code": "xyz789",
+                  
    {
+  "code": "abc123",
   "role_id": 4,
   "user": CompanyInvitationUserInput
 }
 
    
-                    
-
    back to top @@ -32105,12 +31275,8 @@
    Fields
    Example
    - - - 
    {"success": false}
+                  
    {"success": false}
 
    
-                    
-
    back to top @@ -32174,18 +31340,14 @@
    Fields
    Example
    - - - 
    {
-  "company_id": 4,
-  "customer_id": "4",
+                  
    {
+  "company_id": "4",
+  "customer_id": 4,
   "job_title": "abc123",
   "status": "ACTIVE",
   "telephone": "abc123"
 }
 
    
-                    
-
    back to top @@ -32249,19 +31411,15 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "city": "xyz789",
   "country_code": "AF",
-  "postcode": "abc123",
+  "postcode": "xyz789",
   "region": CustomerAddressRegion,
   "street": ["abc123"],
   "telephone": "abc123"
 }
 
    
-                    
-
    back to top @@ -32331,19 +31489,15 @@
    Fields
    Example
    - - - 
    {
-  "city": "abc123",
+                  
    {
+  "city": "xyz789",
   "country_id": "AF",
-  "postcode": "xyz789",
+  "postcode": "abc123",
   "region": CustomerAddressRegionInput,
-  "street": ["xyz789"],
+  "street": ["abc123"],
   "telephone": "abc123"
 }
 
    
-                    
-
    back to top @@ -32413,19 +31567,15 @@
    Fields
    Example
    - - - 
    {
-  "city": "abc123",
+                  
    {
+  "city": "xyz789",
   "country_id": "AF",
   "postcode": "xyz789",
   "region": CustomerAddressRegionInput,
-  "street": ["abc123"],
+  "street": ["xyz789"],
   "telephone": "abc123"
 }
 
    
-                    
-
    back to top @@ -32479,17 +31629,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "id": 4,
-  "name": "xyz789",
+  "name": "abc123",
   "permissions": [CompanyAclResource],
-  "users_count": 987
+  "users_count": 123
 }
 
    
-                    
-
    back to top @@ -32524,7 +31670,7 @@
    Fields
    - permissions - [String]! + permissions - [String] A list of resources the role can access. @@ -32535,15 +31681,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "name": "xyz789",
-  "permissions": ["xyz789"]
+  "permissions": ["abc123"]
 }
 
    
-                    
-
    back to top @@ -32595,16 +31737,12 @@
    Fields
    Example
    - - - 
    {
-  "id": 4,
-  "name": "xyz789",
+                  
    {
+  "id": "4",
+  "name": "abc123",
   "permissions": ["xyz789"]
 }
 
    
-                    
-
    back to top @@ -32653,16 +31791,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "items": [CompanyRole],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
 
    
-                    
-
    back to top @@ -32711,16 +31845,71 @@
    Fields
    Example
    - - - 
    {
-  "email": "abc123",
+                  
    {
+  "email": "xyz789",
   "firstname": "abc123",
   "lastname": "abc123"
 }
 
    
-                    
-                  
+
    +
    + back to top + +
    +
    +
    + Types +
    +

    CompanyStatusEnum

    +
    +
    +
    +
    Description
    +

    Defines the list of company status values.

    +
    +
    +
    Values
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Enum ValueDescription
    +

    PENDING

    +     		Company is pending approval.
    +

    APPROVED

    +     		Company is approved.
    +

    REJECTED

    +     		Company is rejected.
    +

    BLOCKED

    +     		Company is blocked.
    +
    +
    +
    +
    +
    Example
    + 
    "PENDING"
+
    back to top @@ -32759,12 +31948,8 @@
    Fields
    Example
    - - - 
    {"items": [CompanyStructureItem]}
+                  
    {"items": [CompanyStructureItem]}
 
    
-                    
-
    back to top @@ -32803,12 +31988,8 @@
    Types
    Example
    - - - 
    CompanyTeam
+                  
    CompanyTeam
 
    
-                    
-
    back to top @@ -32857,16 +32038,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "entity": CompanyTeam,
-  "id": 4,
-  "parent_id": "4"
+  "id": "4",
+  "parent_id": 4
 }
 
    
-                    
-
    back to top @@ -32912,12 +32089,8 @@
    Fields
    Example
    - - - 
    {"parent_tree_id": 4, "tree_id": 4}
+                  
    {"parent_tree_id": "4", "tree_id": 4}
 
    
-                    
-
    back to top @@ -32950,7 +32123,7 @@
    Fields
    An optional description of the team. - id - ID! + id - ID The unique ID for a CompanyTeam object. @@ -32971,17 +32144,13 @@
    Fields
    Example
    - - - 
    {
-  "description": "abc123",
+                  
    {
+  "description": "xyz789",
   "id": "4",
   "name": "xyz789",
   "structure_id": 4
 }
 
    
-                    
-
    back to top @@ -33033,16 +32202,12 @@
    Fields
    Example
    - - - 
    {
-  "description": "abc123",
-  "name": "xyz789",
-  "target_id": "4"
+                  
    {
+  "description": "xyz789",
+  "name": "abc123",
+  "target_id": 4
 }
 
    
-                    
-
    back to top @@ -33094,16 +32259,12 @@
    Fields
    Example
    - - - 
    {
-  "description": "xyz789",
-  "id": 4,
+                  
    {
+  "description": "abc123",
+  "id": "4",
   "name": "xyz789"
 }
 
    
-                    
-
    back to top @@ -33173,19 +32334,15 @@
    Fields
    Example
    - - - 
    {
-  "company_email": "xyz789",
-  "company_name": "xyz789",
+                  
    {
+  "company_email": "abc123",
+  "company_name": "abc123",
   "legal_address": CompanyLegalAddressUpdateInput,
   "legal_name": "xyz789",
   "reseller_id": "xyz789",
   "vat_tax_id": "xyz789"
 }
 
    
-                    
-
    back to top @@ -33267,21 +32424,17 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "email": "abc123",
   "firstname": "abc123",
-  "job_title": "abc123",
-  "lastname": "abc123",
+  "job_title": "xyz789",
+  "lastname": "xyz789",
   "role_id": "4",
   "status": "ACTIVE",
-  "target_id": 4,
-  "telephone": "xyz789"
+  "target_id": "4",
+  "telephone": "abc123"
 }
 
    
-                    
-
    back to top @@ -33327,12 +32480,8 @@
    Values
    Example
    - - - 
    "ACTIVE"
+                  
    "ACTIVE"
 
    
-                    
-
    back to top @@ -33414,21 +32563,17 @@
    Fields
    Example
    - - - 
    {
-  "email": "xyz789",
+                  
    {
+  "email": "abc123",
   "firstname": "xyz789",
   "id": "4",
-  "job_title": "xyz789",
+  "job_title": "abc123",
   "lastname": "abc123",
-  "role_id": 4,
+  "role_id": "4",
   "status": "ACTIVE",
-  "telephone": "xyz789"
+  "telephone": "abc123"
 }
 
    
-                    
-
    back to top @@ -33477,16 +32622,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "items": [Customer],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
 
    
-                    
-
    back to top @@ -33526,12 +32667,8 @@
    Fields
    Example
    - - - 
    {"status": "ACTIVE"}
+                  
    {"status": "ACTIVE"}
 
    
-                    
-
    back to top @@ -33575,15 +32712,11 @@
    Fields
    Example
    - - - 
    {
-  "code": "xyz789",
+                  
    {
+  "code": "abc123",
   "label": "abc123"
 }
 
    
-                    
-
    back to top @@ -33633,16 +32766,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "attributes": [ProductAttribute],
   "product": ProductInterface,
-  "uid": "4"
+  "uid": 4
 }
 
    
-                    
-
    back to top @@ -33696,17 +32825,63 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "attributes": [ComparableAttribute],
   "item_count": 123,
   "items": [ComparableItem],
   "uid": "4"
 }
 
    
-                    
-                  
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    CompleteOrderInput

    +
    +
    +
    +
    Description
    +

    Update the quote and complete the order

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + cartId - String! + The customer cart ID
    + id - String! + PayPal order ID
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "cartId": "xyz789",
+  "id": "xyz789"
+}
+
    back to top @@ -33754,7 +32929,7 @@
    Fields
    attributes - [ProductViewAttribute] - A list of merchant-defined attributes designated for the storefront. + A list of merchant-defined attributes designated for the storefront. They can be filtered by roles and names. @@ -33765,6 +32940,10 @@
    Arguments
    roles - [String]
    +
    +
    names - [String] +
    +
    @@ -33888,6 +33067,24 @@
    linkTypes + + categories - [CategoryProductView!] + + A list of categories in which the product is present. + + + +
    +
    Arguments
    +
    +
    +
    family - String +
    +
    +
    +
    + + queryType - String @@ -33905,11 +33102,9 @@
    linkTypes
    Example
    - - - 
    {
+                  
    {
   "addToCartAllowed": false,
-  "inStock": true,
+  "inStock": false,
   "lowStock": false,
   "attributes": [ProductViewAttribute],
   "description": "abc123",
@@ -33917,25 +33112,24 @@ 
    Example
    
   "images": [ProductViewImage],
   "videos": [ProductViewVideo],
   "lastModifiedAt": "2007-12-03T10:15:30Z",
-  "metaDescription": "xyz789",
-  "metaKeyword": "xyz789",
-  "metaTitle": "abc123",
-  "name": "xyz789",
+  "metaDescription": "abc123",
+  "metaKeyword": "abc123",
+  "metaTitle": "xyz789",
+  "name": "abc123",
   "inputOptions": [ProductViewInputOption],
   "options": [ProductViewOption],
   "priceRange": ProductViewPriceRange,
   "shortDescription": "xyz789",
-  "sku": "abc123",
+  "sku": "xyz789",
   "externalId": "abc123",
-  "url": "abc123",
-  "urlKey": "xyz789",
+  "url": "xyz789",
+  "urlKey": "abc123",
   "links": [ProductViewLink],
+  "categories": [CategoryProductView],
   "queryType": "abc123",
   "visibility": "xyz789"
 }
 
    
-                    
-
    back to top @@ -33970,12 +33164,64 @@
    Fields
    Example
    - - - 
    {"html": "xyz789"}
+                  
    {"html": "abc123"}
+
    
+
    +
    + back to top + +
    +
    +
    + Types +
    +

    ConditionInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + field - Field + +
    + operator - OperatorInput + +
    + enabled - Boolean + +
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "field": "UNKNOWN_FIELD",
+  "operator": OperatorInput,
+  "enabled": true
+}
    - -
    back to top @@ -34029,17 +33275,13 @@
    Fields
    Example
    - - - 
    {
-  "code": "abc123",
-  "label": "abc123",
+                  
    {
+  "code": "xyz789",
+  "label": "xyz789",
   "uid": "4",
   "value_index": 987
 }
 
    
-                    
-
    back to top @@ -34169,9 +33411,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "available_gift_wrapping": [GiftWrapping],
   "configurable_options": [SelectedConfigurableOption],
   "configured_variant": ProductInterface,
@@ -34181,10 +33421,10 @@ 
    Example
    
   "errors": [CartItemError],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "is_available": false,
+  "is_available": true,
   "max_qty": 123.45,
-  "min_qty": 987.65,
-  "not_available_message": "abc123",
+  "min_qty": 123.45,
+  "not_available_message": "xyz789",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
@@ -34193,8 +33433,6 @@ 
    Example
    
   "uid": 4
 }
 
    
-                    
-
    back to top @@ -34238,15 +33476,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "attribute_code": "abc123",
-  "option_value_uids": ["4"]
+  "option_value_uids": [4]
 }
 
    
-                    
-
    back to top @@ -34315,7 +33549,7 @@
    Fields
    Contains details about the price of the item, including taxes and discounts. - product - ProductInterface! + product - ProductInterface The ProductInterface object, which contains details about the base product Product information is part of a composable Catalog Service. @@ -34397,37 +33631,33 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "custom_attributes": [CustomAttribute],
   "discounts": [Discount],
   "eligible_for_return": false,
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": "4",
+  "id": 4,
   "parent_sku": "xyz789",
   "prices": OrderItemPrices,
   "product": ProductInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "xyz789",
   "product_type": "xyz789",
   "product_url_key": "xyz789",
-  "quantity_canceled": 987.65,
+  "quantity_canceled": 123.45,
   "quantity_invoiced": 987.65,
   "quantity_ordered": 987.65,
   "quantity_refunded": 987.65,
   "quantity_return_requested": 987.65,
   "quantity_returned": 987.65,
-  "quantity_shipped": 987.65,
+  "quantity_shipped": 123.45,
   "selected_options": [OrderItemOption],
-  "status": "abc123"
+  "status": "xyz789"
 }
 
    
-                    
-
    back to top @@ -34707,9 +33937,7 @@
    filters
    Example
    - - - 
    {
+                  
    {
   "canonical_url": "abc123",
   "categories": [CategoryInterface],
   "configurable_options": [ConfigurableProductOptions],
@@ -34718,21 +33946,21 @@ 
    Example
    
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
-  "gift_message_available": false,
+  "gift_message_available": true,
   "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
   "image": ProductImage,
-  "is_returnable": "xyz789",
+  "is_returnable": "abc123",
   "manufacturer": 123,
   "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
-  "meta_description": "xyz789",
-  "meta_keyword": "abc123",
-  "meta_title": "xyz789",
-  "min_sale_qty": 123.45,
-  "name": "abc123",
+  "meta_description": "abc123",
+  "meta_keyword": "xyz789",
+  "meta_title": "abc123",
+  "min_sale_qty": 987.65,
+  "name": "xyz789",
   "new_from_date": "xyz789",
-  "new_to_date": "abc123",
+  "new_to_date": "xyz789",
   "only_x_left_in_stock": 987.65,
   "options": [CustomizableOptionInterface],
   "options_container": "abc123",
@@ -34742,7 +33970,7 @@ 
    Example
    
   "quantity": 987.65,
   "related_products": [ProductInterface],
   "short_description": ComplexTextValue,
-  "sku": "xyz789",
+  "sku": "abc123",
   "small_image": ProductImage,
   "special_price": 987.65,
   "special_to_date": "xyz789",
@@ -34751,13 +33979,11 @@ 
    Example
    
   "thumbnail": ProductImage,
   "uid": 4,
   "upsell_products": [ProductInterface],
-  "url_key": "xyz789",
+  "url_key": "abc123",
   "variants": [ConfigurableVariant],
   "weight": 987.65
 }
 
    
-                    
-
    back to top @@ -34811,17 +34037,13 @@
    Fields
    Example
    - - - 
    {
-  "attribute_code": "xyz789",
-  "label": "xyz789",
+                  
    {
+  "attribute_code": "abc123",
+  "label": "abc123",
   "uid": "4",
   "values": [ConfigurableProductOptionValue]
 }
 
    
-                    
-
    back to top @@ -34880,18 +34102,14 @@
    Fields
    Example
    - - - 
    {
-  "is_available": false,
+                  
    {
+  "is_available": true,
   "is_use_default": false,
-  "label": "abc123",
+  "label": "xyz789",
   "swatch": SwatchDataInterface,
-  "uid": 4
+  "uid": "4"
 }
 
    
-                    
-
    back to top @@ -34960,20 +34178,16 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "attribute_code": "xyz789",
-  "attribute_uid": "4",
-  "label": "xyz789",
+  "attribute_uid": 4,
+  "label": "abc123",
   "position": 987,
-  "uid": 4,
+  "uid": "4",
   "use_default": true,
   "values": [ConfigurableProductOptionsValues]
 }
 
    
-                    
-
    back to top @@ -35027,9 +34241,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "configurable_options": [ConfigurableProductOption],
   "media_gallery": [MediaGalleryInterface],
   "options_available_for_selection": [
@@ -35038,8 +34250,6 @@ 
    Example
    
   "variant": SimpleProduct
 }
 
    
-                    
-
    back to top @@ -35103,19 +34313,15 @@
    Fields
    Example
    - - - 
    {
-  "default_label": "abc123",
+                  
    {
+  "default_label": "xyz789",
   "label": "xyz789",
-  "store_label": "abc123",
+  "store_label": "xyz789",
   "swatch_data": SwatchDataInterface,
-  "uid": "4",
-  "use_default_value": false
+  "uid": 4,
+  "use_default_value": true
 }
 
    
-                    
-
    back to top @@ -35174,18 +34380,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "configurable_options": [SelectedConfigurableOption],
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "uid": "4"
 }
 
    
-                    
-
    back to top @@ -35229,15 +34431,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "attributes": [ConfigurableAttributeOption],
   "product": SimpleProduct
 }
 
    
-                    
-
    back to top @@ -35312,21 +34510,17 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "added_at": "xyz789",
   "configurable_options": [SelectedConfigurableOption],
   "configured_variant": ProductInterface,
   "customizable_options": [SelectedCustomizableOption],
   "description": "abc123",
-  "id": 4,
+  "id": "4",
   "product": ProductInterface,
-  "quantity": 987.65
+  "quantity": 123.45
 }
 
    
-                    
-
    back to top @@ -35368,15 +34562,11 @@
    Fields
    Example
    - - - 
    {
-  "confirmation_key": "xyz789",
+                  
    {
+  "confirmation_key": "abc123",
   "order_id": "4"
 }
 
    
-                    
-
    back to top @@ -35422,15 +34612,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "confirmation_key": "abc123",
   "email": "abc123"
 }
 
    
-                    
-
    back to top @@ -35472,15 +34658,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "confirmation_key": "abc123",
   "order_id": "4"
 }
 
    
-                    
-
    back to top @@ -35526,12 +34708,8 @@
    Values
    Example
    - - - 
    "ACCOUNT_CONFIRMED"
+                  
    "ACCOUNT_CONFIRMED"
 
    
-                    
-
    back to top @@ -35585,17 +34763,13 @@
    Fields
    Example
    - - - 
    {
-  "comment": "abc123",
+                  
    {
+  "comment": "xyz789",
   "email": "abc123",
-  "name": "xyz789",
-  "telephone": "xyz789"
+  "name": "abc123",
+  "telephone": "abc123"
 }
 
    
-                    
-
    back to top @@ -35634,12 +34808,8 @@
    Fields
    Example
    - - - 
    {"status": false}
+                  
    {"status": true}
 
    
-                    
-
    back to top @@ -35679,12 +34849,8 @@
    Fields
    Example
    - - - 
    {"requisitionListItemUids": ["4"]}
+                  
    {"requisitionListItemUids": [4]}
 
    
-                    
-
    back to top @@ -35723,12 +34889,8 @@
    Fields
    Example
    - - - 
    {"requisition_list": RequisitionList}
+                  
    {"requisition_list": RequisitionList}
 
    
-                    
-
    back to top @@ -35777,16 +34939,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "destination_wishlist": Wishlist,
   "source_wishlist": Wishlist,
   "user_errors": [WishListUserInputError]
 }
 
    
-                    
-
    back to top @@ -35846,19 +35004,15 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "available_regions": [Region],
-  "full_name_english": "xyz789",
+  "full_name_english": "abc123",
   "full_name_locale": "abc123",
   "id": "xyz789",
-  "three_letter_abbreviation": "xyz789",
-  "two_letter_abbreviation": "xyz789"
+  "three_letter_abbreviation": "abc123",
+  "two_letter_abbreviation": "abc123"
 }
 
    
-                    
-
    back to top @@ -37362,12 +36516,8 @@
    Values
    Example
    - - - 
    "AF"
+                  
    "AF"
 
    
-                    
-
    back to top @@ -37406,12 +36556,8 @@
    Fields
    Example
    - - - 
    {"company": Company}
+                  
    {"company": Company}
 
    
-                    
-
    back to top @@ -37450,12 +36596,8 @@
    Fields
    Example
    - - - 
    {"role": CompanyRole}
+                  
    {"role": CompanyRole}
 
    
-                    
-
    back to top @@ -37494,12 +36636,8 @@
    Fields
    Example
    - - - 
    {"team": CompanyTeam}
+                  
    {"team": CompanyTeam}
 
    
-                    
-
    back to top @@ -37538,12 +36676,8 @@
    Fields
    Example
    - - - 
    {"user": Customer}
+                  
    {"user": Customer}
 
    
-                    
-
    back to top @@ -37583,12 +36717,8 @@
    Fields
    Example
    - - - 
    {"products": [4]}
+                  
    {"products": [4]}
 
    
-                    
-
    back to top @@ -37670,23 +36800,19 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "dynamic_attributes": [
     GiftRegistryDynamicAttributeInput
   ],
-  "event_name": "abc123",
+  "event_name": "xyz789",
   "gift_registry_type_uid": "4",
-  "message": "xyz789",
+  "message": "abc123",
   "privacy_settings": "PRIVATE",
   "registrants": [AddGiftRegistryRegistrantInput],
   "shipping_address": GiftRegistryShippingAddressInput,
   "status": "ACTIVE"
 }
 
    
-                    
-
    back to top @@ -37725,12 +36851,8 @@
    Fields
    Example
    - - - 
    {"gift_registry": GiftRegistry}
+                  
    {"gift_registry": GiftRegistry}
 
    
-                    
-
    back to top @@ -37766,12 +36888,8 @@
    Fields
    Example
    - - - 
    {"cart_uid": "4"}
+                  
    {"cart_uid": 4}
 
    
-                    
-
    back to top @@ -37806,12 +36924,8 @@
    Fields
    Example
    - - - 
    {"cart": Cart}
+                  
    {"cart": Cart}
 
    
-                    
-
    back to top @@ -37875,18 +36989,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "cartId": "abc123",
   "location": "PRODUCT_DETAIL",
-  "methodCode": "xyz789",
+  "methodCode": "abc123",
   "paymentSource": "xyz789",
-  "vaultIntent": true
+  "vaultIntent": false
 }
 
    
-                    
-
    back to top @@ -37945,18 +37055,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "amount": 123.45,
-  "currency_code": "xyz789",
+  "currency_code": "abc123",
   "id": "xyz789",
   "mp_order_id": "abc123",
-  "status": "xyz789"
+  "status": "abc123"
 }
 
    
-                    
-
    back to top @@ -38002,12 +37108,8 @@
    Fields
    Example
    - - - 
    {"currency": "AFN", "value": 987.65}
+                  
    {"currency": "AFN", "value": 987.65}
 
    
-                    
-
    back to top @@ -38065,17 +37167,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput,
   "attribute": "GRAND_TOTAL",
   "operator": "MORE_THAN",
   "quantity": 987
 }
 
    
-                    
-
    back to top @@ -38121,15 +37219,11 @@
    Fields
    Example
    - - - 
    {
-  "description": "abc123",
-  "name": "xyz789"
+                  
    {
+  "description": "xyz789",
+  "name": "abc123"
 }
 
    
-                    
-
    back to top @@ -38168,12 +37262,8 @@
    Fields
    Example
    - - - 
    {"requisition_list": RequisitionList}
+                  
    {"requisition_list": RequisitionList}
 
    
-                    
-
    back to top @@ -38219,15 +37309,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "card_description": "abc123",
   "setup_token_id": "xyz789"
 }
 
    
-                    
-
    back to top @@ -38271,15 +37357,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "payment_source": PaymentSourceOutput,
-  "vault_token_id": "xyz789"
+  "vault_token_id": "abc123"
 }
 
    
-                    
-
    back to top @@ -38325,15 +37407,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "setup_token": VaultSetupTokenInput,
   "three_ds_mode": "OFF"
 }
 
    
-                    
-
    back to top @@ -38372,12 +37450,8 @@
    Fields
    Example
    - - - 
    {"setup_token": "xyz789"}
+                  
    {"setup_token": "abc123"}
 
    
-                    
-
    back to top @@ -38423,12 +37497,8 @@
    Fields
    Example
    - - - 
    {"name": "abc123", "visibility": "PUBLIC"}
+                  
    {"name": "abc123", "visibility": "PUBLIC"}
 
    
-                    
-
    back to top @@ -38467,12 +37537,8 @@
    Fields
    Example
    - - - 
    {"wishlist": Wishlist}
+                  
    {"wishlist": Wishlist}
 
    
-                    
-
    back to top @@ -38536,19 +37602,15 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "comments": [SalesCommentItem],
   "custom_attributes": [CustomAttribute],
   "id": "4",
   "items": [CreditMemoItemInterface],
-  "number": "xyz789",
+  "number": "abc123",
   "total": CreditMemoTotal
 }
 
    
-                    
-
    back to top @@ -38594,15 +37656,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "credit_memo_id": "abc123",
   "custom_attributes": [CustomAttributeInput]
 }
 
    
-                    
-
    back to top @@ -38672,21 +37730,17 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "custom_attributes": [CustomAttribute],
   "discounts": [Discount],
   "id": 4,
   "order_item": OrderItemInterface,
-  "product_name": "xyz789",
+  "product_name": "abc123",
   "product_sale_price": Money,
   "product_sku": "xyz789",
-  "quantity_refunded": 123.45
+  "quantity_refunded": 987.65
 }
 
    
-                    
-
    back to top @@ -38738,16 +37792,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "credit_memo_id": "xyz789",
   "credit_memo_item_id": "abc123",
   "custom_attributes": [CustomAttributeInput]
 }
 
    
-                    
-
    back to top @@ -38853,21 +37903,17 @@
    Possible Types
    Example
    - - - 
    {
+                  
    {
   "custom_attributes": [CustomAttribute],
   "discounts": [Discount],
-  "id": "4",
+  "id": 4,
   "order_item": OrderItemInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "xyz789",
   "quantity_refunded": 123.45
 }
 
    
-                    
-
    back to top @@ -38906,12 +37952,8 @@
    Fields
    Example
    - - - 
    {"credit_memo": CreditMemo}
+                  
    {"credit_memo": CreditMemo}
 
    
-                    
-
    back to top @@ -38990,9 +38032,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "adjustment": Money,
   "base_grand_total": Money,
   "discounts": [Discount],
@@ -39004,8 +38044,6 @@ 
    Example
    
   "total_tax": Money
 }
 
    
-                    
-
    back to top @@ -39065,19 +38103,15 @@
    Fields
    Example
    - - - 
    {
-  "available_currency_codes": ["xyz789"],
-  "base_currency_code": "abc123",
+                  
    {
+  "available_currency_codes": ["abc123"],
+  "base_currency_code": "xyz789",
   "base_currency_symbol": "abc123",
-  "default_display_currency_code": "abc123",
+  "default_display_currency_code": "xyz789",
   "default_display_currency_symbol": "abc123",
   "exchange_rates": [ExchangeRate]
 }
 
    
-                    
-
    back to top @@ -40294,12 +39328,8 @@
    Values
    Example
    - - - 
    "AFN"
+                  
    "AFN"
 
    
-                    
-
    back to top @@ -40343,15 +39373,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "attribute_code": "xyz789",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
    
-                    
-
    back to top @@ -40397,15 +39423,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "attribute_code": "abc123",
   "value": "abc123"
 }
 
    
-                    
-
    back to top @@ -40516,22 +39538,18 @@
    Possible Types
    Example
    - - - 
    {
+                  
    {
   "code": "4",
   "default_value": "abc123",
   "entity_type": "CATALOG_PRODUCT",
   "frontend_class": "abc123",
   "frontend_input": "BOOLEAN",
-  "is_required": true,
+  "is_required": false,
   "is_unique": false,
   "label": "abc123",
   "options": [CustomAttributeOptionInterface]
 }
 
    
-                    
-
    back to top @@ -40593,16 +39611,12 @@
    Possible Types
    Example
    - - - 
    {
-  "is_default": false,
-  "label": "abc123",
-  "value": "abc123"
+                  
    {
+  "is_default": true,
+  "label": "xyz789",
+  "value": "xyz789"
 }
 
    
-                    
-
    back to top @@ -40648,15 +39662,104 @@
    Fields
    Example
    - - - 
    {
-  "key": "abc123",
-  "value": "abc123"
+                  
    {
+  "key": "xyz789",
+  "value": "xyz789"
 }
 
    
-                    
-                  
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    CustomOperatorInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + type - CustomOperatorType + +
    + value - [String] + +
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "type": "UNKNOWN_CUSTOMOPERATOR_TYPE",
+  "value": ["xyz789"]
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    CustomOperatorType

    +
    +
    +
    +
    Values
    + + + + + + + + + + + + + + + + + +
    Enum ValueDescription
    +

    UNKNOWN_CUSTOMOPERATOR_TYPE

    +     		+
    +

    CUSTOM

    +     		+
    +
    +
    +
    +
    +
    Example
    + 
    "UNKNOWN_CUSTOMOPERATOR_TYPE"
+
    back to top @@ -40826,6 +39929,12 @@
    giftRegistryUi Customer group assigned to the customer + + id - ID! + + The unique ID assigned to the customer. id is not needed as part of Customer, because on the server side, it can be identified based on the customer token used for authentication. There is no need to know customer ID on the client side. + + is_subscribed - Boolean @@ -40985,6 +40094,11 @@
    pageSize Indicates whether purchase order functionality is enabled for the current customer. Global and company-level settings are factored into the result. + + quote_enabled - Boolean! + + Indicates whether negotiable quote functionality is enabled for the current customer. Global and company-level settings are factored into the result. + requisition_lists - RequisitionLists @@ -41010,6 +40124,11 @@
    filter<

    The filter to use to limit the number of requisition lists to return.

    +
    +
    sort - RequisitionListSortInput +
    +

    The field to use for sorting results.

    +
    @@ -41155,38 +40274,38 @@
    currentPage
    Example
    - - - 
    {
+                  
    {
   "addresses": [CustomerAddress],
   "addressesV2": CustomerAddresses,
-  "allow_remote_shopping_assistance": false,
+  "allow_remote_shopping_assistance": true,
   "companies": UserCompaniesOutput,
   "compare_list": CompareList,
   "confirmation_status": "ACCOUNT_CONFIRMED",
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "custom_attributes": [AttributeValueInterface],
   "date_of_birth": "abc123",
-  "default_billing": "abc123",
-  "default_shipping": "xyz789",
+  "default_billing": "xyz789",
+  "default_shipping": "abc123",
   "email": "xyz789",
-  "firstname": "abc123",
+  "firstname": "xyz789",
   "gender": 123,
   "gift_registries": [GiftRegistry],
   "gift_registry": GiftRegistry,
   "group": CustomerGroupStorefront,
-  "is_subscribed": false,
-  "job_title": "xyz789",
+  "id": 4,
+  "is_subscribed": true,
+  "job_title": "abc123",
   "lastname": "xyz789",
   "middlename": "xyz789",
   "orders": CustomerOrders,
-  "prefix": "abc123",
+  "prefix": "xyz789",
   "purchase_order": PurchaseOrder,
   "purchase_order_approval_rule": PurchaseOrderApprovalRule,
   "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
   "purchase_order_approval_rules": PurchaseOrderApprovalRules,
   "purchase_orders": PurchaseOrders,
-  "purchase_orders_enabled": false,
+  "purchase_orders_enabled": true,
+  "quote_enabled": false,
   "requisition_lists": RequisitionLists,
   "return": Return,
   "returns": Returns,
@@ -41195,7 +40314,7 @@ 
    Example
    
   "segments": [CustomerSegmentStorefront],
   "status": "ACTIVE",
   "store_credit": CustomerStoreCredit,
-  "structure_id": "4",
+  "structure_id": 4,
   "suffix": "abc123",
   "taxvat": "abc123",
   "team": CompanyTeam,
@@ -41204,8 +40323,6 @@ 
    Example
    
   "wishlists": [Wishlist]
 }
 
    
-                    
-
    back to top @@ -41291,9 +40408,10 @@
    attributeCodes The first name of the person associated with the shipping/billing address. - id - Int + id - Int + + The ID of a CustomerAddress object. Use uid instead. - The ID of a CustomerAddress object. lastname - String @@ -41340,6 +40458,11 @@
    attributeCodes The customer's telephone number. + + uid - ID + + The unique ID for a CustomerAddress object. + vat_id - String @@ -41352,9 +40475,7 @@
    attributeCodes
    Example
    - - - 
    {
+                  
    {
   "city": "xyz789",
   "company": "abc123",
   "country_code": "AF",
@@ -41362,23 +40483,22 @@ 
    Example
    
   "default_billing": false,
   "default_shipping": true,
   "extension_attributes": [CustomerAddressAttribute],
-  "fax": "abc123",
-  "firstname": "abc123",
-  "id": 987,
+  "fax": "xyz789",
+  "firstname": "xyz789",
+  "id": 123,
   "lastname": "xyz789",
   "middlename": "xyz789",
   "postcode": "xyz789",
-  "prefix": "xyz789",
+  "prefix": "abc123",
   "region": CustomerAddressRegion,
-  "region_id": 987,
+  "region_id": 123,
   "street": ["xyz789"],
-  "suffix": "abc123",
-  "telephone": "xyz789",
+  "suffix": "xyz789",
+  "telephone": "abc123",
+  "uid": 4,
   "vat_id": "xyz789"
 }
 
    
-                    
-
    back to top @@ -41422,15 +40542,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "attribute_code": "xyz789",
   "value": "abc123"
 }
 
    
-                    
-
    back to top @@ -41566,21 +40682,19 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "city": "abc123",
   "company": "abc123",
   "country_code": "AF",
   "custom_attributesV2": [AttributeValueInput],
-  "default_billing": true,
+  "default_billing": false,
   "default_shipping": true,
-  "fax": "abc123",
-  "firstname": "abc123",
-  "lastname": "abc123",
-  "middlename": "xyz789",
+  "fax": "xyz789",
+  "firstname": "xyz789",
+  "lastname": "xyz789",
+  "middlename": "abc123",
   "postcode": "abc123",
-  "prefix": "abc123",
+  "prefix": "xyz789",
   "region": CustomerAddressRegionInput,
   "street": ["xyz789"],
   "suffix": "xyz789",
@@ -41588,8 +40702,6 @@ 
    Example
    
   "vat_id": "abc123"
 }
 
    
-                    
-
    back to top @@ -41638,16 +40750,12 @@
    Fields
    Example
    - - - 
    {
-  "region": "abc123",
+                  
    {
+  "region": "xyz789",
   "region_code": "abc123",
   "region_id": 123
 }
 
    
-                    
-
    back to top @@ -41699,16 +40807,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "region": "xyz789",
   "region_code": "xyz789",
-  "region_id": 987
+  "region_id": 123
 }
 
    
-                    
-
    back to top @@ -41753,16 +40857,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "items": [CustomerAddress],
   "page_info": SearchResultPageInfo,
-  "total_count": 987
+  "total_count": 123
 }
 
    
-                    
-
    back to top @@ -41861,26 +40961,22 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "code": "4",
-  "default_value": "abc123",
+  "default_value": "xyz789",
   "entity_type": "CATALOG_PRODUCT",
-  "frontend_class": "abc123",
+  "frontend_class": "xyz789",
   "frontend_input": "BOOLEAN",
   "input_filter": "NONE",
   "is_required": false,
   "is_unique": true,
-  "label": "xyz789",
-  "multiline_count": 123,
+  "label": "abc123",
+  "multiline_count": 987,
   "options": [CustomAttributeOptionInterface],
-  "sort_order": 987,
+  "sort_order": 123,
   "validate_rules": [ValidationRule]
 }
 
    
-                    
-
    back to top @@ -41992,26 +41088,22 @@
    Fields
    Example
    - - - 
    {
-  "allow_remote_shopping_assistance": true,
+                  
    {
+  "allow_remote_shopping_assistance": false,
   "custom_attributes": [AttributeValueInput],
   "date_of_birth": "abc123",
-  "email": "xyz789",
+  "email": "abc123",
   "firstname": "xyz789",
   "gender": 987,
-  "is_subscribed": false,
+  "is_subscribed": true,
   "lastname": "abc123",
   "middlename": "xyz789",
   "password": "abc123",
-  "prefix": "abc123",
+  "prefix": "xyz789",
   "suffix": "abc123",
-  "taxvat": "xyz789"
+  "taxvat": "abc123"
 }
 
    
-                    
-
    back to top @@ -42070,18 +41162,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "date": "xyz789",
   "download_url": "xyz789",
-  "order_increment_id": "abc123",
-  "remaining_downloads": "abc123",
-  "status": "xyz789"
+  "order_increment_id": "xyz789",
+  "remaining_downloads": "xyz789",
+  "status": "abc123"
 }
 
    
-                    
-
    back to top @@ -42120,12 +41208,8 @@
    Fields
    Example
    - - - 
    {"items": [CustomerDownloadableProduct]}
+                  
    {"items": [CustomerDownloadableProduct]}
 
    
-                    
-
    back to top @@ -42164,12 +41248,8 @@
    Fields
    Example
    - - - 
    {"uid": "4"}
+                  
    {"uid": 4}
 
    
-                    
-
    back to top @@ -42288,6 +41368,11 @@
    Fields
    A list of order items eligible to be in a return request. + + negotiable_quote - NegotiableQuote + + The negotiable quote associated with this order. + number - String! @@ -42374,9 +41459,7 @@
    currentPage
    Example
    - - - 
    {
+                  
    {
   "applied_coupons": [AppliedCoupon],
   "applied_gift_cards": [ApplyGiftCardToOrder],
   "available_actions": ["REORDER"],
@@ -42386,31 +41469,30 @@ 
    Example
    
   "credit_memos": [CreditMemo],
   "custom_attributes": [CustomAttribute],
   "customer_info": OrderCustomerInfo,
-  "email": "xyz789",
+  "email": "abc123",
   "gift_message": GiftMessage,
   "gift_receipt_included": false,
   "gift_wrapping": GiftWrapping,
-  "id": "4",
+  "id": 4,
   "invoices": [Invoice],
   "is_virtual": false,
   "items": [OrderItemInterface],
   "items_eligible_for_return": [OrderItemInterface],
+  "negotiable_quote": NegotiableQuote,
   "number": "xyz789",
   "order_date": "xyz789",
-  "order_status_change_date": "xyz789",
+  "order_status_change_date": "abc123",
   "payment_methods": [OrderPaymentMethod],
   "printed_card_included": false,
   "returns": Returns,
   "shipments": [OrderShipment],
   "shipping_address": OrderAddress,
-  "shipping_method": "abc123",
-  "status": "abc123",
-  "token": "abc123",
+  "shipping_method": "xyz789",
+  "status": "xyz789",
+  "token": "xyz789",
   "total": OrderTotal
 }
 
    
-                    
-
    back to top @@ -42456,12 +41538,8 @@
    Fields
    Example
    - - - 
    {"sort_direction": "ASC", "sort_field": "NUMBER"}
+                  
    {"sort_direction": "ASC", "sort_field": "NUMBER"}
 
    
-                    
-
    back to top @@ -42507,12 +41585,8 @@
    Values
    Example
    - - - 
    "NUMBER"
+                  
    "NUMBER"
 
    
-                    
-
    back to top @@ -42566,17 +41640,13 @@
    Fields
    Example
    - - - 
    {
-  "date_of_first_order": "abc123",
+                  
    {
+  "date_of_first_order": "xyz789",
   "items": [CustomerOrder],
   "page_info": SearchResultPageInfo,
   "total_count": 987
 }
 
    
-                    
-
    back to top @@ -42634,17 +41704,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "grand_total": FilterRangeTypeInput,
   "number": FilterStringTypeInput,
   "order_date": FilterRangeTypeInput,
   "status": FilterEqualTypeInput
 }
 
    
-                    
-
    back to top @@ -42683,12 +41749,8 @@
    Fields
    Example
    - - - 
    {"customer": Customer}
+                  
    {"customer": Customer}
 
    
-                    
-
    back to top @@ -42727,12 +41789,8 @@
    Fields
    Example
    - - - 
    {"items": [PaymentToken]}
+                  
    {"items": [PaymentToken]}
 
    
-                    
-
    back to top @@ -42771,12 +41829,8 @@
    Fields
    Example
    - - - 
    {"uid": 4}
+                  
    {"uid": "4"}
 
    
-                    
-
    back to top @@ -42844,16 +41898,12 @@
    currentPage
    Example
    - - - 
    {
+                  
    {
   "balance_history": CustomerStoreCreditHistory,
   "current_balance": Money,
   "enabled": true
 }
 
    
-                    
-
    back to top @@ -42902,16 +41952,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "items": [CustomerStoreCreditHistoryItem],
   "page_info": SearchResultPageInfo,
   "total_count": 123
 }
 
    
-                    
-
    back to top @@ -42965,17 +42011,13 @@
    Fields
    Example
    - - - 
    {
-  "action": "xyz789",
+                  
    {
+  "action": "abc123",
   "actual_balance": Money,
   "balance_change": Money,
-  "date_time_changed": "abc123"
+  "date_time_changed": "xyz789"
 }
 
    
-                    
-
    back to top @@ -43014,12 +42056,8 @@
    Fields
    Example
    - - - 
    {"token": "abc123"}
+                  
    {"token": "abc123"}
 
    
-                    
-
    back to top @@ -43119,24 +42157,20 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "allow_remote_shopping_assistance": false,
   "custom_attributes": [AttributeValueInput],
-  "date_of_birth": "abc123",
-  "firstname": "xyz789",
-  "gender": 123,
+  "date_of_birth": "xyz789",
+  "firstname": "abc123",
+  "gender": 987,
   "is_subscribed": false,
-  "lastname": "xyz789",
+  "lastname": "abc123",
   "middlename": "abc123",
   "prefix": "abc123",
-  "suffix": "xyz789",
+  "suffix": "abc123",
   "taxvat": "abc123"
 }
 
    
-                    
-
    back to top @@ -43200,19 +42234,15 @@
    Fields
    Example
    - - - 
    {
-  "product_sku": "abc123",
+                  
    {
+  "product_sku": "xyz789",
   "required": false,
-  "sort_order": 123,
+  "sort_order": 987,
   "title": "abc123",
-  "uid": 4,
+  "uid": "4",
   "value": CustomizableAreaValue
 }
 
    
-                    
-
    back to top @@ -43271,18 +42301,14 @@
    Fields
    Example
    - - - 
    {
-  "max_characters": 987,
+                  
    {
+  "max_characters": 123,
   "price": 123.45,
   "price_type": "FIXED",
-  "sku": "abc123",
-  "uid": 4
+  "sku": "xyz789",
+  "uid": "4"
 }
 
    
-                    
-
    back to top @@ -43341,18 +42367,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "required": false,
   "sort_order": 123,
-  "title": "xyz789",
+  "title": "abc123",
   "uid": 4,
   "value": [CustomizableCheckboxValue]
 }
 
    
-                    
-
    back to top @@ -43421,20 +42443,16 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "option_type_id": 987,
-  "price": 123.45,
+  "price": 987.65,
   "price_type": "FIXED",
-  "sku": "abc123",
+  "sku": "xyz789",
   "sort_order": 123,
-  "title": "xyz789",
-  "uid": "4"
+  "title": "abc123",
+  "uid": 4
 }
 
    
-                    
-
    back to top @@ -43498,19 +42516,15 @@
    Fields
    Example
    - - - 
    {
-  "product_sku": "xyz789",
+                  
    {
+  "product_sku": "abc123",
   "required": true,
-  "sort_order": 987,
-  "title": "abc123",
-  "uid": 4,
+  "sort_order": 123,
+  "title": "xyz789",
+  "uid": "4",
   "value": CustomizableDateValue
 }
 
    
-                    
-
    back to top @@ -43565,12 +42579,8 @@
    Values
    Example
    - - - 
    "DATE"
+                  
    "DATE"
 
    
-                    
-
    back to top @@ -43629,9 +42639,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "price": 123.45,
   "price_type": "FIXED",
   "sku": "abc123",
@@ -43639,8 +42647,6 @@ 
    Example
    
   "uid": "4"
 }
 
    
-                    
-
    back to top @@ -43699,9 +42705,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "required": true,
   "sort_order": 123,
   "title": "xyz789",
@@ -43709,8 +42713,6 @@ 
    Example
    
   "value": [CustomizableDropDownValue]
 }
 
    
-                    
-
    back to top @@ -43779,20 +42781,16 @@
    Fields
    Example
    - - - 
    {
-  "option_type_id": 987,
+                  
    {
+  "option_type_id": 123,
   "price": 987.65,
   "price_type": "FIXED",
   "sku": "abc123",
-  "sort_order": 987,
-  "title": "abc123",
-  "uid": 4
+  "sort_order": 123,
+  "title": "xyz789",
+  "uid": "4"
 }
 
    
-                    
-
    back to top @@ -43856,19 +42854,15 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "product_sku": "abc123",
   "required": false,
-  "sort_order": 987,
-  "title": "xyz789",
+  "sort_order": 123,
+  "title": "abc123",
   "uid": "4",
   "value": CustomizableFieldValue
 }
 
    
-                    
-
    back to top @@ -43927,18 +42921,14 @@
    Fields
    Example
    - - - 
    {
-  "max_characters": 123,
+                  
    {
+  "max_characters": 987,
   "price": 123.45,
   "price_type": "FIXED",
-  "sku": "xyz789",
-  "uid": "4"
+  "sku": "abc123",
+  "uid": 4
 }
 
    
-                    
-
    back to top @@ -44002,9 +42992,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "product_sku": "abc123",
   "required": false,
   "sort_order": 987,
@@ -44013,8 +43001,6 @@ 
    Example
    
   "value": CustomizableFileValue
 }
 
    
-                    
-
    back to top @@ -44083,20 +43069,16 @@
    Fields
    Example
    - - - 
    {
-  "file_extension": "abc123",
-  "image_size_x": 123,
-  "image_size_y": 987,
-  "price": 123.45,
+                  
    {
+  "file_extension": "xyz789",
+  "image_size_x": 987,
+  "image_size_y": 123,
+  "price": 987.65,
   "price_type": "FIXED",
-  "sku": "abc123",
-  "uid": "4"
+  "sku": "xyz789",
+  "uid": 4
 }
 
    
-                    
-
    back to top @@ -44155,18 +43137,14 @@
    Fields
    Example
    - - - 
    {
-  "required": false,
+                  
    {
+  "required": true,
   "sort_order": 123,
-  "title": "abc123",
+  "title": "xyz789",
   "uid": "4",
   "value": [CustomizableMultipleValue]
 }
 
    
-                    
-
    back to top @@ -44235,11 +43213,9 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "option_type_id": 987,
-  "price": 987.65,
+  "price": 123.45,
   "price_type": "FIXED",
   "sku": "abc123",
   "sort_order": 987,
@@ -44247,8 +43223,6 @@ 
    Example
    
   "uid": "4"
 }
 
    
-                    
-
    back to top @@ -44294,12 +43268,11 @@
    Fields
    Example
    - - - 
    {"uid": 4, "value_string": "abc123"}
+                  
    {
+  "uid": "4",
+  "value_string": "xyz789"
+}
 
    
-                    
-
    back to top @@ -44405,17 +43378,13 @@
    Possible Types
    Example
    - - - 
    {
-  "required": true,
+                  
    {
+  "required": false,
   "sort_order": 123,
   "title": "abc123",
-  "uid": 4
+  "uid": "4"
 }
 
    
-                    
-
    back to top @@ -44496,12 +43465,8 @@
    Possible Types
    Example
    - - - 
    {"options": [CustomizableOptionInterface]}
+                  
    {"options": [CustomizableOptionInterface]}
 
    
-                    
-
    back to top @@ -44560,18 +43525,14 @@
    Fields
    Example
    - - - 
    {
-  "required": true,
+                  
    {
+  "required": false,
   "sort_order": 123,
   "title": "xyz789",
   "uid": "4",
   "value": [CustomizableRadioValue]
 }
 
    
-                    
-
    back to top @@ -44640,20 +43601,16 @@
    Fields
    Example
    - - - 
    {
-  "option_type_id": 123,
+                  
    {
+  "option_type_id": 987,
   "price": 987.65,
   "price_type": "FIXED",
-  "sku": "xyz789",
+  "sku": "abc123",
   "sort_order": 123,
   "title": "abc123",
-  "uid": 4
+  "uid": "4"
 }
 
    
-                    
-
    back to top @@ -44674,12 +43631,8 @@
    Description
    Example
    - - - 
    "2007-12-03T10:15:30Z"
+                  
    "2007-12-03T10:15:30Z"
 
    
-                    
-
    back to top @@ -44718,12 +43671,8 @@
    Fields
    Example
    - - - 
    {"success": true}
+                  
    {"success": false}
 
    
-                    
-
    back to top @@ -44762,12 +43711,8 @@
    Fields
    Example
    - - - 
    {"success": true}
+                  
    {"success": false}
 
    
-                    
-
    back to top @@ -44806,12 +43751,8 @@
    Fields
    Example
    - - - 
    {"success": true}
+                  
    {"success": true}
 
    
-                    
-
    back to top @@ -44850,12 +43791,8 @@
    Fields
    Example
    - - - 
    {"result": false}
+                  
    {"result": false}
 
    
-                    
-
    back to top @@ -44899,12 +43836,8 @@
    Types
    Example
    - - - 
    NegotiableQuoteInvalidStateError
+                  
    NegotiableQuoteInvalidStateError
 
    
-                    
-
    back to top @@ -44949,15 +43882,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "errors": [NegotiableQuoteInvalidStateError],
   "quote_uid": "4"
 }
 
    
-                    
-
    back to top @@ -44996,12 +43925,8 @@
    Types
    Example
    - - - 
    NegotiableQuoteUidOperationSuccess
+                  
    NegotiableQuoteUidOperationSuccess
 
    
-                    
-
    back to top @@ -45041,12 +43966,8 @@
    Fields
    Example
    - - - 
    {"template_id": 4}
+                  
    {"template_id": 4}
 
    
-                    
-
    back to top @@ -45082,12 +44003,8 @@
    Fields
    Example
    - - - 
    {"quote_uids": ["4"]}
+                  
    {"quote_uids": [4]}
 
    
-                    
-
    back to top @@ -45165,9 +44082,7 @@
    sort
    Example
    - - - 
    {
+                  
    {
   "negotiable_quotes": NegotiableQuotesOutput,
   "operation_results": [
     NegotiableQuoteUidOperationSuccess
@@ -45175,8 +44090,6 @@ 
    Example
    
   "result_status": "SUCCESS"
 }
 
    
-                    
-
    back to top @@ -45220,15 +44133,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "customerPaymentTokens": CustomerPaymentTokens,
   "result": true
 }
 
    
-                    
-
    back to top @@ -45272,12 +44181,8 @@
    Fields
    Example
    - - - 
    {"message": "abc123", "type": "UNDEFINED"}
+                  
    {"message": "xyz789", "type": "UNDEFINED"}
 
    
-                    
-
    back to top @@ -45321,12 +44226,8 @@
    Values
    Example
    - - - 
    "UNDEFINED"
+                  
    "UNDEFINED"
 
    
-                    
-
    back to top @@ -45366,12 +44267,8 @@
    Fields
    Example
    - - - 
    {"approval_rule_uids": ["4"]}
+                  
    {"approval_rule_uids": ["4"]}
 
    
-                    
-
    back to top @@ -45410,12 +44307,8 @@
    Fields
    Example
    - - - 
    {"errors": [DeletePurchaseOrderApprovalRuleError]}
+                  
    {"errors": [DeletePurchaseOrderApprovalRuleError]}
 
    
-                    
-
    back to top @@ -45454,12 +44347,8 @@
    Fields
    Example
    - - - 
    {"requisition_list": RequisitionList}
+                  
    {"requisition_list": RequisitionList}
 
    
-                    
-
    back to top @@ -45503,12 +44392,8 @@
    Fields
    Example
    - - - 
    {"requisition_lists": RequisitionLists, "status": true}
+                  
    {"requisition_lists": RequisitionLists, "status": true}
 
    
-                    
-
    back to top @@ -45552,12 +44437,8 @@
    Fields
    Example
    - - - 
    {"status": true, "wishlists": [Wishlist]}
+                  
    {"status": false, "wishlists": [Wishlist]}
 
    
-                    
-
    back to top @@ -45626,20 +44507,16 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "amount": Money,
   "applied_to": "ITEM",
   "coupon": AppliedCoupon,
-  "is_discounting_locked": false,
-  "label": "xyz789",
+  "is_discounting_locked": true,
+  "label": "abc123",
   "type": "abc123",
   "value": 987.65
 }
 
    
-                    
-
    back to top @@ -45754,17 +44631,15 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "custom_attributes": [CustomAttribute],
   "customizable_options": [SelectedCustomizableOption],
   "discount": [Discount],
   "errors": [CartItemError],
-  "is_available": false,
+  "is_available": true,
   "links": [DownloadableProductLinks],
-  "max_qty": 987.65,
-  "min_qty": 123.45,
+  "max_qty": 123.45,
+  "min_qty": 987.65,
   "not_available_message": "abc123",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
@@ -45775,8 +44650,6 @@ 
    Example
    
   "uid": "4"
 }
 
    
-                    
-
    back to top @@ -45855,9 +44728,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "custom_attributes": [CustomAttribute],
   "discounts": [Discount],
   "downloadable_links": [DownloadableItemsLinks],
@@ -45869,8 +44740,6 @@ 
    Example
    
   "quantity_refunded": 123.45
 }
 
    
-                    
-
    back to top @@ -45949,9 +44818,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "custom_attributes": [CustomAttribute],
   "discounts": [Discount],
   "downloadable_links": [DownloadableItemsLinks],
@@ -45960,11 +44827,9 @@ 
    Example
    
   "product_name": "abc123",
   "product_sale_price": Money,
   "product_sku": "xyz789",
-  "quantity_invoiced": 987.65
+  "quantity_invoiced": 123.45
 }
 
    
-                    
-
    back to top @@ -46013,16 +44878,12 @@
    Fields
    Example
    - - - 
    {
-  "sort_order": 123,
-  "title": "abc123",
+                  
    {
+  "sort_order": 987,
+  "title": "xyz789",
   "uid": 4
 }
 
    
-                    
-
    back to top @@ -46095,7 +44956,7 @@
    Fields
    Contains details about the price of the item, including taxes and discounts. - product - ProductInterface! + product - ProductInterface The ProductInterface object, which contains details about the base product Product information is part of a composable Catalog Service. @@ -46177,13 +45038,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "custom_attributes": [CustomAttribute],
   "discounts": [Discount],
   "downloadable_links": [DownloadableItemsLinks],
-  "eligible_for_return": false,
+  "eligible_for_return": true,
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
@@ -46194,20 +45053,18 @@ 
    Example
    
   "product_sale_price": Money,
   "product_sku": "xyz789",
   "product_type": "abc123",
-  "product_url_key": "abc123",
-  "quantity_canceled": 987.65,
-  "quantity_invoiced": 987.65,
-  "quantity_ordered": 987.65,
-  "quantity_refunded": 123.45,
-  "quantity_return_requested": 987.65,
+  "product_url_key": "xyz789",
+  "quantity_canceled": 123.45,
+  "quantity_invoiced": 123.45,
+  "quantity_ordered": 123.45,
+  "quantity_refunded": 987.65,
+  "quantity_return_requested": 123.45,
   "quantity_returned": 987.65,
-  "quantity_shipped": 123.45,
+  "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
-  "status": "xyz789"
+  "status": "abc123"
 }
 
    
-                    
-
    back to top @@ -46474,12 +45331,10 @@
    filters
    Example
    - - - 
    {
-  "canonical_url": "abc123",
+                  
    {
+  "canonical_url": "xyz789",
   "categories": [CategoryInterface],
-  "country_of_manufacture": "xyz789",
+  "country_of_manufacture": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
@@ -46489,26 +45344,26 @@ 
    Example
    
   "downloadable_product_samples": [
     DownloadableProductSamples
   ],
-  "gift_message_available": true,
+  "gift_message_available": false,
   "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
   "image": ProductImage,
   "is_returnable": "xyz789",
-  "links_purchased_separately": 123,
-  "links_title": "abc123",
+  "links_purchased_separately": 987,
+  "links_title": "xyz789",
   "manufacturer": 987,
   "max_sale_qty": 123.45,
   "media_gallery": [MediaGalleryInterface],
-  "meta_description": "abc123",
-  "meta_keyword": "xyz789",
-  "meta_title": "abc123",
-  "min_sale_qty": 987.65,
+  "meta_description": "xyz789",
+  "meta_keyword": "abc123",
+  "meta_title": "xyz789",
+  "min_sale_qty": 123.45,
   "name": "abc123",
   "new_from_date": "abc123",
-  "new_to_date": "abc123",
+  "new_to_date": "xyz789",
   "only_x_left_in_stock": 123.45,
   "options": [CustomizableOptionInterface],
-  "options_container": "abc123",
+  "options_container": "xyz789",
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
@@ -46517,18 +45372,16 @@ 
    Example
    
   "short_description": ComplexTextValue,
   "sku": "abc123",
   "small_image": ProductImage,
-  "special_price": 123.45,
-  "special_to_date": "abc123",
+  "special_price": 987.65,
+  "special_to_date": "xyz789",
   "stock_status": "IN_STOCK",
   "swatch_image": "abc123",
   "thumbnail": ProductImage,
-  "uid": 4,
+  "uid": "4",
   "upsell_products": [ProductInterface],
   "url_key": "xyz789"
 }
 
    
-                    
-
    back to top @@ -46580,9 +45433,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "customizable_options": [CustomizableOptionInput],
   "data": CartItemInput,
   "downloadable_product_links": [
@@ -46590,8 +45441,6 @@ 
    Example
    
   ]
 }
 
    
-                    
-
    back to top @@ -46650,18 +45499,14 @@
    Fields
    Example
    - - - 
    {
-  "price": 123.45,
-  "sample_url": "xyz789",
-  "sort_order": 123,
+                  
    {
+  "price": 987.65,
+  "sample_url": "abc123",
+  "sort_order": 987,
   "title": "xyz789",
-  "uid": "4"
+  "uid": 4
 }
 
    
-                    
-
    back to top @@ -46701,12 +45546,8 @@
    Fields
    Example
    - - - 
    {"link_id": 123}
+                  
    {"link_id": 987}
 
    
-                    
-
    back to top @@ -46755,16 +45596,12 @@
    Fields
    Example
    - - - 
    {
-  "sample_url": "abc123",
+                  
    {
+  "sample_url": "xyz789",
   "sort_order": 987,
   "title": "xyz789"
 }
 
    
-                    
-
    back to top @@ -46828,19 +45665,15 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "customizable_options": [SelectedCustomizableOption],
   "links": [DownloadableProductLinks],
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "samples": [DownloadableProductSamples],
   "uid": "4"
 }
 
    
-                    
-
    back to top @@ -46915,21 +45748,17 @@
    Fields
    Example
    - - - 
    {
-  "added_at": "xyz789",
+                  
    {
+  "added_at": "abc123",
   "customizable_options": [SelectedCustomizableOption],
   "description": "xyz789",
   "id": 4,
   "links_v2": [DownloadableProductLinks],
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "samples": [DownloadableProductSamples]
 }
 
    
-                    
-
    back to top @@ -46975,15 +45804,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "duplicated_quote_uid": "4",
   "quote_uid": 4
 }
 
    
-                    
-
    back to top @@ -47022,12 +45847,8 @@
    Fields
    Example
    - - - 
    {"quote": NegotiableQuote}
+                  
    {"quote": NegotiableQuote}
 
    
-                    
-
    back to top @@ -47073,15 +45894,11 @@
    Fields
    Example
    - - - 
    {
-  "attribute_code": "xyz789",
+                  
    {
+  "attribute_code": "abc123",
   "value": "abc123"
 }
 
    
-                    
-
    back to top @@ -47127,12 +45944,8 @@
    Fields
    Example
    - - - 
    {"uid": 4, "value": "xyz789"}
+                  
    {"uid": 4, "value": "abc123"}
 
    
-                    
-
    back to top @@ -47198,15 +46011,11 @@
    Possible Types
    Example
    - - - 
    {
+                  
    {
   "code": "PRODUCT_NOT_FOUND",
   "message": "xyz789"
 }
 
    
-                    
-
    back to top @@ -47268,12 +46077,8 @@
    Possible Types
    Example
    - - - 
    {"message": "abc123"}
+                  
    {"message": "abc123"}
 
    
-                    
-
    back to top @@ -47325,16 +46130,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "country_code": "AF",
-  "postcode": "xyz789",
+  "postcode": "abc123",
   "region": CustomerAddressRegionInput
 }
 
    
-                    
-
    back to top @@ -47382,16 +46183,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "address": EstimateAddressInput,
   "cart_id": "abc123",
   "shipping_method": ShippingMethodInput
 }
 
    
-                    
-
    back to top @@ -47430,12 +46227,8 @@
    Fields
    Example
    - - - 
    {"cart": Cart}
+                  
    {"cart": Cart}
 
    
-                    
-
    back to top @@ -47475,12 +46268,8 @@
    Fields
    Example
    - - - 
    {"customer": CustomerCreateInput}
+                  
    {"customer": CustomerCreateInput}
 
    
-                    
-
    back to top @@ -47524,15 +46313,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "customer": Customer,
-  "token": "xyz789"
+  "token": "abc123"
 }
 
    
-                    
-
    back to top @@ -47576,12 +46361,225 @@
    Fields
    Example
    - - - 
    {"currency_to": "abc123", "rate": 123.45}
+                  
    {"currency_to": "xyz789", "rate": 123.45}
+
    
+
    +
    + back to top + +
    +
    +
    + Types +
    +

    FastlaneConfig

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    code - String + The payment method code as defined in the payment gateway
    is_visible - Boolean + Indicates whether the payment method is displayed
    payment_intent - String + Defines the payment intent (Authorize or Capture
    payment_source - String + The payment source for the payment method
    sdk_params - [SDKParams] + The PayPal parameters required to load the JS SDK
    sort_order - String + The relative order the payment method is displayed on the checkout page
    three_ds_mode - ThreeDSMode + 3DS mode
    title - String + The name displayed for the payment method
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "code": "abc123",
+  "is_visible": false,
+  "payment_intent": "abc123",
+  "payment_source": "xyz789",
+  "sdk_params": [SDKParams],
+  "sort_order": "abc123",
+  "three_ds_mode": "OFF",
+  "title": "abc123"
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    FastlaneMethodInput

    +
    +
    +
    +
    Description
    +

    Fastlane Payment inputs

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + payment_source - String + The payment source for the payment method
    + paypal_fastlane_token - String + The single use token from Fastlane
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "payment_source": "abc123",
+  "paypal_fastlane_token": "xyz789"
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    Field

    +
    +
    +
    +
    Values
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Enum ValueDescription
    +

    UNKNOWN_FIELD

    +     		+
    +

    CATEGORY

    +     		+
    +

    PRICE

    +     		+
    +

    PRODUCT

    +     		+
    +

    OUT_OF_STOCK

    +     		+
    +

    LOW_STOCK

    +     		+
    +

    TYPE

    +     		+
    +

    VISIBILITY

    +     		+
    +
    +
    +
    +
    +
    Example
    + 
    "UNKNOWN_FIELD"
    - -
    back to top @@ -47627,15 +46625,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "eq": "abc123",
   "in": ["abc123"]
 }
 
    
-                    
-
    back to top @@ -47679,12 +46673,8 @@
    Values
    Example
    - - - 
    "FULL"
+                  
    "FULL"
 
    
-                    
-
    back to top @@ -47730,12 +46720,8 @@
    Fields
    Example
    - - - 
    {"match": "abc123", "match_type": "FULL"}
+                  
    {"match": "xyz789", "match_type": "FULL"}
 
    
-                    
-
    back to top @@ -47781,15 +46767,119 @@
    Fields
    Example
    - - - 
    {
-  "from": "xyz789",
-  "to": "xyz789"
+                  
    {
+  "from": "abc123",
+  "to": "abc123"
 }
 
    
-                    
-                  
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    FilterRuleInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + name - String + +
    + type - FilterRuleType + +
    + conditions - [ConditionInput] + +
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "name": "xyz789",
+  "type": "UNKNOWN_FILTER_RULE_TYPE",
+  "conditions": [ConditionInput]
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    FilterRuleType

    +
    +
    +
    +
    Values
    + + + + + + + + + + + + + + + + + + + + + +
    Enum ValueDescription
    +

    UNKNOWN_FILTER_RULE_TYPE

    +     		+
    +

    INCLUSION

    +     		+
    +

    EXCLUSION

    +     		+
    +
    +
    +
    +
    +
    Example
    + 
    "UNKNOWN_FILTER_RULE_TYPE"
+
    back to top @@ -47841,16 +46931,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "eq": "abc123",
   "in": ["xyz789"],
   "match": "xyz789"
 }
 
    
-                    
-
    back to top @@ -47968,27 +47054,23 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "eq": "xyz789",
-  "from": "abc123",
-  "gt": "xyz789",
-  "gteq": "xyz789",
-  "in": ["abc123"],
-  "like": "abc123",
-  "lt": "abc123",
+  "from": "xyz789",
+  "gt": "abc123",
+  "gteq": "abc123",
+  "in": ["xyz789"],
+  "like": "xyz789",
+  "lt": "xyz789",
   "lteq": "xyz789",
   "moreq": "abc123",
-  "neq": "abc123",
-  "nin": ["abc123"],
+  "neq": "xyz789",
+  "nin": ["xyz789"],
   "notnull": "xyz789",
-  "null": "abc123",
+  "null": "xyz789",
   "to": "abc123"
 }
 
    
-                    
-
    back to top @@ -48042,17 +47124,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "attribute": "abc123",
   "frontendInput": "xyz789",
   "label": "abc123",
   "numeric": true
 }
 
    
-                    
-
    back to top @@ -48096,15 +47174,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "amount": Money,
-  "label": "xyz789"
+  "label": "abc123"
 }
 
    
-                    
-
    back to top @@ -48168,12 +47242,8 @@
    Values
    Example
    - - - 
    "INCLUDE_FPT_WITHOUT_DETAILS"
+                  
    "INCLUDE_FPT_WITHOUT_DETAILS"
 
    
-                    
-
    back to top @@ -48194,12 +47264,8 @@
    Description
    Example
    - - - 
    123.45
+                  
    987.65
 
    
-                    
-
    back to top @@ -48239,12 +47305,8 @@
    Fields
    Example
    - - - 
    {"customer_email": "abc123"}
+                  
    {"customer_email": "abc123"}
 
    
-                    
-
    back to top @@ -48283,12 +47345,8 @@
    Fields
    Example
    - - - 
    {"customer_token": "xyz789"}
+                  
    {"customer_token": "abc123"}
 
    
-                    
-
    back to top @@ -48328,12 +47386,8 @@
    Fields
    Example
    - - - 
    {"template_id": 4}
+                  
    {"template_id": 4}
 
    
-                    
-
    back to top @@ -48372,12 +47426,8 @@
    Fields
    Example
    - - - 
    {"negotiable_quote_uid": "4"}
+                  
    {"negotiable_quote_uid": 4}
 
    
-                    
-
    back to top @@ -48416,12 +47466,8 @@
    Fields
    Example
    - - - 
    {"sdkParams": [PaymentSDKParamsItem]}
+                  
    {"sdkParams": [PaymentSDKParamsItem]}
 
    
-                    
-
    back to top @@ -48470,16 +47516,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "balance": Money,
   "code": "abc123",
   "expiration_date": "abc123"
 }
 
    
-                    
-
    back to top @@ -48519,12 +47561,8 @@
    Fields
    Example
    - - - 
    {"gift_card_code": "abc123"}
+                  
    {"gift_card_code": "abc123"}
 
    
-                    
-
    back to top @@ -48583,18 +47621,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "attribute_id": 987,
-  "uid": 4,
-  "value": 123.45,
+  "uid": "4",
+  "value": 987.65,
   "website_id": 123,
   "website_value": 987.65
 }
 
    
-                    
-
    back to top @@ -48744,9 +47778,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "amount": Money,
   "available_gift_wrapping": [GiftWrapping],
   "custom_attributes": [CustomAttribute],
@@ -48755,11 +47787,11 @@ 
    Example
    
   "errors": [CartItemError],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "is_available": false,
-  "max_qty": 123.45,
-  "message": "abc123",
+  "is_available": true,
+  "max_qty": 987.65,
+  "message": "xyz789",
   "min_qty": 987.65,
-  "not_available_message": "abc123",
+  "not_available_message": "xyz789",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
@@ -48767,13 +47799,11 @@ 
    Example
    
   "quantity": 987.65,
   "recipient_email": "abc123",
   "recipient_name": "abc123",
-  "sender_email": "abc123",
-  "sender_name": "abc123",
+  "sender_email": "xyz789",
+  "sender_name": "xyz789",
   "uid": 4
 }
 
    
-                    
-
    back to top @@ -48848,22 +47878,18 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "custom_attributes": [CustomAttribute],
   "discounts": [Discount],
   "gift_card": GiftCardItem,
-  "id": "4",
+  "id": 4,
   "order_item": OrderItemInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "xyz789",
+  "product_sku": "abc123",
   "quantity_refunded": 987.65
 }
 
    
-                    
-
    back to top @@ -48938,22 +47964,18 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "custom_attributes": [CustomAttribute],
   "discounts": [Discount],
   "gift_card": GiftCardItem,
   "id": "4",
   "order_item": OrderItemInterface,
-  "product_name": "xyz789",
+  "product_name": "abc123",
   "product_sale_price": Money,
   "product_sku": "xyz789",
   "quantity_invoiced": 987.65
 }
 
    
-                    
-
    back to top @@ -49012,18 +48034,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "message": "abc123",
-  "recipient_email": "xyz789",
+  "recipient_email": "abc123",
   "recipient_name": "xyz789",
-  "sender_email": "abc123",
+  "sender_email": "xyz789",
   "sender_name": "xyz789"
 }
 
    
-                    
-
    back to top @@ -49092,20 +48110,16 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "amount": Money,
   "custom_giftcard_amount": Money,
-  "message": "abc123",
+  "message": "xyz789",
   "recipient_email": "abc123",
-  "recipient_name": "xyz789",
+  "recipient_name": "abc123",
   "sender_email": "xyz789",
   "sender_name": "xyz789"
 }
 
    
-                    
-
    back to top @@ -49174,7 +48188,7 @@
    Fields
    Contains details about the price of the item, including taxes and discounts. - product - ProductInterface! + product - ProductInterface The ProductInterface object, which contains details about the base product Product information is part of a composable Catalog Service. @@ -49256,9 +48270,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "custom_attributes": [CustomAttribute],
   "discounts": [Discount],
   "eligible_for_return": true,
@@ -49266,27 +48278,25 @@ 
    Example
    
   "gift_card": GiftCardItem,
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
-  "id": 4,
+  "id": "4",
   "prices": OrderItemPrices,
   "product": ProductInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "abc123",
   "product_type": "xyz789",
-  "product_url_key": "abc123",
+  "product_url_key": "xyz789",
   "quantity_canceled": 123.45,
   "quantity_invoiced": 987.65,
-  "quantity_ordered": 987.65,
-  "quantity_refunded": 123.45,
-  "quantity_return_requested": 123.45,
-  "quantity_returned": 987.65,
+  "quantity_ordered": 123.45,
+  "quantity_refunded": 987.65,
+  "quantity_return_requested": 987.65,
+  "quantity_returned": 123.45,
   "quantity_shipped": 123.45,
   "selected_options": [OrderItemOption],
   "status": "xyz789"
 }
 
    
-                    
-
    back to top @@ -49588,10 +48598,8 @@
    filters
    Example
    - - - 
    {
-  "allow_message": false,
+                  
    {
+  "allow_message": true,
   "allow_open_amount": false,
   "canonical_url": "abc123",
   "categories": [CategoryInterface],
@@ -49600,52 +48608,50 @@ 
    Example
    
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
   "gift_card_options": [CustomizableOptionInterface],
-  "gift_message_available": false,
-  "gift_wrapping_available": false,
+  "gift_message_available": true,
+  "gift_wrapping_available": true,
   "gift_wrapping_price": Money,
   "giftcard_amounts": [GiftCardAmounts],
   "giftcard_type": "VIRTUAL",
   "image": ProductImage,
   "is_redeemable": true,
-  "is_returnable": "abc123",
-  "lifetime": 123,
-  "manufacturer": 987,
-  "max_sale_qty": 123.45,
+  "is_returnable": "xyz789",
+  "lifetime": 987,
+  "manufacturer": 123,
+  "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
   "message_max_length": 123,
   "meta_description": "xyz789",
   "meta_keyword": "xyz789",
   "meta_title": "abc123",
-  "min_sale_qty": 987.65,
-  "name": "abc123",
+  "min_sale_qty": 123.45,
+  "name": "xyz789",
   "new_from_date": "xyz789",
-  "new_to_date": "abc123",
-  "only_x_left_in_stock": 123.45,
+  "new_to_date": "xyz789",
+  "only_x_left_in_stock": 987.65,
   "open_amount_max": 987.65,
-  "open_amount_min": 123.45,
+  "open_amount_min": 987.65,
   "options": [CustomizableOptionInterface],
-  "options_container": "xyz789",
+  "options_container": "abc123",
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
   "quantity": 123.45,
   "related_products": [ProductInterface],
   "short_description": ComplexTextValue,
-  "sku": "xyz789",
+  "sku": "abc123",
   "small_image": ProductImage,
   "special_price": 987.65,
   "special_to_date": "abc123",
   "stock_status": "IN_STOCK",
   "swatch_image": "xyz789",
   "thumbnail": ProductImage,
-  "uid": "4",
+  "uid": 4,
   "upsell_products": [ProductInterface],
-  "url_key": "xyz789",
-  "weight": 123.45
+  "url_key": "abc123",
+  "weight": 987.65
 }
 
    
-                    
-
    back to top @@ -49705,18 +48711,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "customizable_options": [SelectedCustomizableOption],
   "gift_card_options": GiftCardOptions,
   "product": ProductInterface,
-  "quantity": 987.65,
-  "uid": "4"
+  "quantity": 123.45,
+  "uid": 4
 }
 
    
-                    
-
    back to top @@ -49781,20 +48783,16 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "gift_card": GiftCardItem,
   "id": 4,
   "order_item": OrderItemInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_shipped": 123.45
+  "product_sku": "xyz789",
+  "quantity_shipped": 987.65
 }
 
    
-                    
-
    back to top @@ -49849,12 +48847,8 @@
    Values
    Example
    - - - 
    "VIRTUAL"
+                  
    "VIRTUAL"
 
    
-                    
-
    back to top @@ -49924,20 +48918,16 @@
    Fields
    Example
    - - - 
    {
-  "added_at": "abc123",
+                  
    {
+  "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
-  "description": "xyz789",
+  "description": "abc123",
   "gift_card_options": GiftCardOptions,
   "id": "4",
   "product": ProductInterface,
   "quantity": 987.65
 }
 
    
-                    
-
    back to top @@ -49986,16 +48976,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "from": "abc123",
-  "message": "abc123",
-  "to": "abc123"
+  "message": "xyz789",
+  "to": "xyz789"
 }
 
    
-                    
-
    back to top @@ -50047,16 +49033,12 @@
    Fields
    Example
    - - - 
    {
-  "from": "xyz789",
-  "message": "xyz789",
-  "to": "xyz789"
+                  
    {
+  "from": "abc123",
+  "message": "abc123",
+  "to": "abc123"
 }
 
    
-                    
-
    back to top @@ -50120,9 +49102,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "gift_wrapping_for_items": Money,
   "gift_wrapping_for_items_incl_tax": Money,
   "gift_wrapping_for_order": Money,
@@ -50131,8 +49111,6 @@ 
    Example
    
   "printed_card_incl_tax": Money
 }
 
    
-                    
-
    back to top @@ -50226,9 +49204,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "created_at": "abc123",
   "dynamic_attributes": [GiftRegistryDynamicAttribute],
   "event_name": "xyz789",
@@ -50240,11 +49216,9 @@ 
    Example
    
   "shipping_address": CustomerAddress,
   "status": "ACTIVE",
   "type": GiftRegistryType,
-  "uid": "4"
+  "uid": 4
 }
 
    
-                    
-
    back to top @@ -50294,17 +49268,13 @@
    Fields
    Example
    - - - 
    {
-  "code": 4,
+                  
    {
+  "code": "4",
   "group": "EVENT_INFORMATION",
   "label": "abc123",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
    
-                    
-
    back to top @@ -50380,12 +49350,8 @@
    Values
    Example
    - - - 
    "EVENT_INFORMATION"
+                  
    "EVENT_INFORMATION"
 
    
-                    
-
    back to top @@ -50431,12 +49397,8 @@
    Fields
    Example
    - - - 
    {"code": 4, "value": "abc123"}
+                  
    {"code": 4, "value": "abc123"}
 
    
-                    
-
    back to top @@ -50503,16 +49465,12 @@
    Possible Types
    Example
    - - - 
    {
-  "code": 4,
+                  
    {
+  "code": "4",
   "label": "xyz789",
-  "value": "xyz789"
+  "value": "abc123"
 }
 
    
-                    
-
    back to top @@ -50572,19 +49530,15 @@
    Fields
    Example
    - - - 
    {
-  "attribute_group": "abc123",
-  "code": 4,
-  "input_type": "abc123",
-  "is_required": false,
-  "label": "abc123",
+                  
    {
+  "attribute_group": "xyz789",
+  "code": "4",
+  "input_type": "xyz789",
+  "is_required": true,
+  "label": "xyz789",
   "sort_order": 123
 }
 
    
-                    
-
    back to top @@ -50661,19 +49615,15 @@
    Possible Types
    Example
    - - - 
    {
+                  
    {
   "attribute_group": "abc123",
   "code": 4,
-  "input_type": "abc123",
-  "is_required": false,
+  "input_type": "xyz789",
+  "is_required": true,
   "label": "abc123",
   "sort_order": 123
 }
 
    
-                    
-
    back to top @@ -50734,19 +49684,15 @@
    Fields
    Example
    - - - 
    {
-  "created_at": "abc123",
-  "note": "abc123",
+                  
    {
+  "created_at": "xyz789",
+  "note": "xyz789",
   "product": ProductInterface,
-  "quantity": 987.65,
+  "quantity": 123.45,
   "quantity_fulfilled": 123.45,
   "uid": "4"
 }
 
    
-                    
-
    back to top @@ -50824,19 +49770,15 @@
    Possible Types
    Example
    - - - 
    {
-  "created_at": "xyz789",
-  "note": "xyz789",
+                  
    {
+  "created_at": "abc123",
+  "note": "abc123",
   "product": ProductInterface,
   "quantity": 987.65,
-  "quantity_fulfilled": 123.45,
+  "quantity_fulfilled": 987.65,
   "uid": 4
 }
 
    
-                    
-
    back to top @@ -50897,15 +49839,11 @@
    Possible Types
    Example
    - - - 
    {
+                  
    {
   "status": true,
   "user_errors": [GiftRegistryItemsUserError]
 }
 
    
-                    
-
    back to top @@ -50964,18 +49902,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "code": "OUT_OF_STOCK",
-  "gift_registry_item_uid": 4,
+  "gift_registry_item_uid": "4",
   "gift_registry_uid": "4",
-  "message": "abc123",
+  "message": "xyz789",
   "product_uid": "4"
 }
 
    
-                    
-
    back to top @@ -51027,12 +49961,8 @@
    Values
    Example
    - - - 
    "OUT_OF_STOCK"
+                  
    "OUT_OF_STOCK"
 
    
-                    
-
    back to top @@ -51088,12 +50018,8 @@
    Possible Types
    Example
    - - - 
    {"gift_registry": GiftRegistry}
+                  
    {"gift_registry": GiftRegistry}
 
    
-                    
-
    back to top @@ -51141,12 +50067,8 @@
    Values
    Example
    - - - 
    "PRIVATE"
+                  
    "PRIVATE"
 
    
-                    
-
    back to top @@ -51205,20 +50127,16 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "dynamic_attributes": [
     GiftRegistryRegistrantDynamicAttribute
   ],
-  "email": "xyz789",
+  "email": "abc123",
   "firstname": "xyz789",
-  "lastname": "xyz789",
+  "lastname": "abc123",
   "uid": "4"
 }
 
    
-                    
-
    back to top @@ -51263,16 +50181,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "code": "4",
   "label": "xyz789",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
    
-                    
-
    back to top @@ -51336,19 +50250,15 @@
    Fields
    Example
    - - - 
    {
-  "event_date": "xyz789",
+                  
    {
+  "event_date": "abc123",
   "event_title": "xyz789",
   "gift_registry_uid": "4",
-  "location": "xyz789",
+  "location": "abc123",
   "name": "xyz789",
-  "type": "xyz789"
+  "type": "abc123"
 }
 
    
-                    
-
    back to top @@ -51387,6 +50297,12 @@
    Fields
    The ID assigned to this customer address. + + + customer_address_uid - ID + + The unique ID assigned to this customer address. +
    @@ -51394,12 +50310,12 @@
    Fields
    Example
    - - - 
    {"address_data": CustomerAddressInput, "address_id": 4}
+                  
    {
+  "address_data": CustomerAddressInput,
+  "address_id": 4,
+  "customer_address_uid": 4
+}
 
    
-                    
-
    back to top @@ -51447,12 +50363,8 @@
    Values
    Example
    - - - 
    "ACTIVE"
+                  
    "ACTIVE"
 
    
-                    
-
    back to top @@ -51501,18 +50413,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "dynamic_attributes_metadata": [
     GiftRegistryDynamicAttributeMetadataInterface
   ],
   "label": "abc123",
-  "uid": 4
+  "uid": "4"
 }
 
    
-                    
-
    back to top @@ -51566,17 +50474,13 @@
    Fields
    Example
    - - - 
    {
-  "design": "abc123",
+                  
    {
+  "design": "xyz789",
   "image": GiftWrappingImage,
   "price": Money,
   "uid": "4"
 }
 
    
-                    
-
    back to top @@ -51620,15 +50524,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "label": "abc123",
-  "url": "xyz789"
+  "url": "abc123"
 }
 
    
-                    
-
    back to top @@ -51673,16 +50573,12 @@
    Fields
    Example
    - - - 
    {
-  "color": "abc123",
+                  
    {
+  "color": "xyz789",
   "height": 987,
   "type": "abc123"
 }
 
    
-                    
-
    back to top @@ -51757,22 +50653,18 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "button_styles": GooglePayButtonStyles,
   "code": "xyz789",
   "is_visible": false,
-  "payment_intent": "xyz789",
+  "payment_intent": "abc123",
   "payment_source": "abc123",
   "sdk_params": [SDKParams],
-  "sort_order": "abc123",
+  "sort_order": "xyz789",
   "three_ds_mode": "OFF",
   "title": "abc123"
 }
 
    
-                    
-
    back to top @@ -51824,16 +50716,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "payment_source": "xyz789",
   "payments_order_id": "xyz789",
   "paypal_order_id": "abc123"
 }
 
    
-                    
-
    back to top @@ -52085,12 +50973,10 @@
    filters
    Example
    - - - 
    {
-  "canonical_url": "abc123",
+                  
    {
+  "canonical_url": "xyz789",
   "categories": [CategoryInterface],
-  "country_of_manufacture": "xyz789",
+  "country_of_manufacture": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
@@ -52101,38 +50987,36 @@ 
    Example
    
   "is_returnable": "xyz789",
   "items": [GroupedProductItem],
   "manufacturer": 987,
-  "max_sale_qty": 987.65,
+  "max_sale_qty": 123.45,
   "media_gallery": [MediaGalleryInterface],
   "meta_description": "xyz789",
   "meta_keyword": "abc123",
   "meta_title": "xyz789",
   "min_sale_qty": 123.45,
-  "name": "abc123",
-  "new_from_date": "xyz789",
+  "name": "xyz789",
+  "new_from_date": "abc123",
   "new_to_date": "abc123",
   "only_x_left_in_stock": 987.65,
-  "options_container": "xyz789",
+  "options_container": "abc123",
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "quantity": 987.65,
+  "quantity": 123.45,
   "related_products": [ProductInterface],
   "short_description": ComplexTextValue,
-  "sku": "abc123",
+  "sku": "xyz789",
   "small_image": ProductImage,
-  "special_price": 987.65,
-  "special_to_date": "abc123",
+  "special_price": 123.45,
+  "special_to_date": "xyz789",
   "stock_status": "IN_STOCK",
-  "swatch_image": "xyz789",
+  "swatch_image": "abc123",
   "thumbnail": ProductImage,
   "uid": "4",
   "upsell_products": [ProductInterface],
-  "url_key": "abc123",
+  "url_key": "xyz789",
   "weight": 123.45
 }
 
    
-                    
-
    back to top @@ -52182,16 +51066,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "position": 987,
   "product": ProductInterface,
-  "qty": 123.45
+  "qty": 987.65
 }
 
    
-                    
-
    back to top @@ -52256,19 +51136,15 @@
    Fields
    Example
    - - - 
    {
-  "added_at": "abc123",
+                  
    {
+  "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
   "description": "xyz789",
   "id": 4,
   "product": ProductInterface,
-  "quantity": 987.65
+  "quantity": 123.45
 }
 
    
-                    
-
    back to top @@ -52314,15 +51190,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "reason": "abc123",
-  "token": "abc123"
+  "token": "xyz789"
 }
 
    
-                    
-
    back to top @@ -52374,16 +51246,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "email": "xyz789",
-  "lastname": "abc123",
+  "lastname": "xyz789",
   "number": "xyz789"
 }
 
    
-                    
-
    back to top @@ -52432,16 +51300,84 @@
    Fields
    Example
    - - - 
    {
-  "attribute": "abc123",
+                  
    {
+  "attribute": "xyz789",
   "matched_words": ["abc123"],
   "value": "xyz789"
 }
 
    
-                    
-                  
+
    +
    + back to top + +
    +
    +
    + Types +
    +

    HistoryItemNoteData

    +
    +
    +
    +
    Description
    +

    Item note data that is added to the negotiable quote history object.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    created_at - String! + Datetime of the note added.
    creator_name - String! + Name of the creator.
    creator_type - String! + Creator type: Buyer or Seller.
    item_id - Int! + Id of the quote item for which the note has been added.
    note - String! + The note added by the creator for the item
    product_name - String! + Name of the quote item product for which note has been added.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "created_at": "abc123",
+  "creator_name": "abc123",
+  "creator_type": "xyz789",
+  "item_id": 123,
+  "note": "xyz789",
+  "product_name": "xyz789"
+}
+
    back to top @@ -52526,24 +51462,20 @@
    Fields
    Example
    - - - 
    {
-  "cc_vault_code": "abc123",
-  "code": "xyz789",
-  "is_vault_enabled": false,
+                  
    {
+  "cc_vault_code": "xyz789",
+  "code": "abc123",
+  "is_vault_enabled": true,
   "is_visible": true,
-  "payment_intent": "abc123",
+  "payment_intent": "xyz789",
   "payment_source": "abc123",
   "requires_card_details": true,
   "sdk_params": [SDKParams],
-  "sort_order": "xyz789",
+  "sort_order": "abc123",
   "three_ds_mode": "OFF",
-  "title": "xyz789"
+  "title": "abc123"
 }
 
    
-                    
-
    back to top @@ -52631,22 +51563,18 @@
    Fields
    Example
    - - - 
    {
-  "cardBin": "abc123",
+                  
    {
+  "cardBin": "xyz789",
   "cardExpiryMonth": "abc123",
   "cardExpiryYear": "abc123",
-  "cardLast4": "xyz789",
+  "cardLast4": "abc123",
   "holderName": "xyz789",
-  "is_active_payment_token_enabler": true,
-  "payment_source": "xyz789",
-  "payments_order_id": "abc123",
+  "is_active_payment_token_enabler": false,
+  "payment_source": "abc123",
+  "payments_order_id": "xyz789",
   "paypal_order_id": "xyz789"
 }
 
    
-                    
-
    back to top @@ -52667,12 +51595,8 @@
    Description
    Example
    - - - 
    "4"
+                  
    4
 
    
-                    
-
    back to top @@ -52712,15 +51636,11 @@
    Fields
    Example
    - - - 
    {
-  "thumbnail": "abc123",
+                  
    {
+  "thumbnail": "xyz789",
   "value": "abc123"
 }
 
    
-                    
-
    back to top @@ -52784,12 +51704,8 @@
    Values
    Example
    - - - 
    "NONE"
+                  
    "NONE"
 
    
-                    
-
    back to top @@ -52834,16 +51750,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "code": "PRODUCT_NOT_FOUND",
-  "message": "xyz789",
-  "quantity": 987.65
+  "message": "abc123",
+  "quantity": 123.45
 }
 
    
-                    
-
    back to top @@ -52864,12 +51776,8 @@
    Description
    Example
    - - - 
    987
+                  
    123
 
    
-                    
-
    back to top @@ -52908,12 +51816,8 @@
    Fields
    Example
    - - - 
    {"message": "abc123"}
+                  
    {"message": "xyz789"}
 
    
-                    
-
    back to top @@ -52977,19 +51881,15 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "comments": [SalesCommentItem],
   "custom_attributes": [CustomAttribute],
   "id": 4,
   "items": [InvoiceItemInterface],
-  "number": "xyz789",
+  "number": "abc123",
   "total": InvoiceTotal
 }
 
    
-                    
-
    back to top @@ -53035,15 +51935,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "custom_attributes": [CustomAttributeInput],
   "invoice_id": "xyz789"
 }
 
    
-                    
-
    back to top @@ -53113,21 +52009,17 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "custom_attributes": [CustomAttribute],
   "discounts": [Discount],
-  "id": 4,
+  "id": "4",
   "order_item": OrderItemInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "abc123",
-  "quantity_invoiced": 123.45
+  "quantity_invoiced": 987.65
 }
 
    
-                    
-
    back to top @@ -53179,16 +52071,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "custom_attributes": [CustomAttributeInput],
   "invoice_id": "xyz789",
   "invoice_item_id": "xyz789"
 }
 
    
-                    
-
    back to top @@ -53294,21 +52182,17 @@
    Possible Types
    Example
    - - - 
    {
+                  
    {
   "custom_attributes": [CustomAttribute],
   "discounts": [Discount],
-  "id": 4,
+  "id": "4",
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_invoiced": 987.65
+  "product_sku": "xyz789",
+  "quantity_invoiced": 123.45
 }
 
    
-                    
-
    back to top @@ -53347,12 +52231,8 @@
    Fields
    Example
    - - - 
    {"invoice": Invoice}
+                  
    {"invoice": Invoice}
 
    
-                    
-
    back to top @@ -53426,9 +52306,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "base_grand_total": Money,
   "discounts": [Discount],
   "grand_total": Money,
@@ -53439,8 +52317,6 @@ 
    Example
    
   "total_tax": Money
 }
 
    
-                    
-
    back to top @@ -53479,12 +52355,8 @@
    Fields
    Example
    - - - 
    {"is_email_available": true}
+                  
    {"is_email_available": false}
 
    
-                    
-
    back to top @@ -53523,12 +52395,8 @@
    Fields
    Example
    - - - 
    {"is_email_available": true}
+                  
    {"is_email_available": true}
 
    
-                    
-
    back to top @@ -53567,12 +52435,8 @@
    Fields
    Example
    - - - 
    {"is_role_name_available": true}
+                  
    {"is_role_name_available": false}
 
    
-                    
-
    back to top @@ -53611,12 +52475,8 @@
    Fields
    Example
    - - - 
    {"is_email_available": false}
+                  
    {"is_email_available": false}
 
    
-                    
-
    back to top @@ -53655,12 +52515,98 @@
    Fields
    Example
    - - - 
    {"is_email_available": false}
+                  
    {"is_email_available": true}
+
    
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    IsOperatorInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + type - IsOperatorType + +
    + value - Boolean + +
    +
    +
    +
    +
    +
    Example
    + 
    {"type": "UNKNOWN_ISOPERATOR_TYPE", "value": true}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    IsOperatorType

    +
    +
    +
    +
    Values
    + + + + + + + + + + + + + + + + + +
    Enum ValueDescription
    +

    UNKNOWN_ISOPERATOR_TYPE

    +     		+
    +

    IS

    +     		+
    +
    +
    +
    +
    +
    Example
    + 
    "UNKNOWN_ISOPERATOR_TYPE"
    - -
    back to top @@ -53697,6 +52643,11 @@
    Fields
    ID of the user who submitted a note. + + creator_name - String + + Name of the creator. + creator_type - Int @@ -53724,19 +52675,16 @@
    Fields
    Example
    - - - 
    {
-  "created_at": "xyz789",
+                  
    {
+  "created_at": "abc123",
   "creator_id": 987,
+  "creator_name": "xyz789",
   "creator_type": 987,
   "negotiable_quote_item_uid": 4,
-  "note": "abc123",
-  "note_uid": 4
+  "note": "xyz789",
+  "note_uid": "4"
 }
 
    
-                    
-
    back to top @@ -53785,16 +52733,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "label": "abc123",
   "uid": 4,
   "values": [ItemSelectedBundleOptionValue]
 }
 
    
-                    
-
    back to top @@ -53853,18 +52797,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "price": Money,
   "product_name": "abc123",
-  "product_sku": "xyz789",
+  "product_sku": "abc123",
   "quantity": 987.65,
   "uid": "4"
 }
 
    
-                    
-
    back to top @@ -53885,12 +52825,8 @@
    Description
    Example
    - - - 
    {}
+                  
    {}
 
    
-                    
-
    back to top @@ -53934,15 +52870,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "name": "xyz789",
   "value": "xyz789"
 }
 
    
-                    
-
    back to top @@ -53994,16 +52926,12 @@
    Fields
    Example
    - - - 
    {
-  "note": "abc123",
-  "quote_item_uid": 4,
+                  
    {
+  "note": "xyz789",
+  "quote_item_uid": "4",
   "quote_uid": 4
 }
 
    
-                    
-
    back to top @@ -54089,17 +53017,78 @@
    Possible Types
    Example
    - - - 
    {
+                  
    {
   "disabled": false,
   "label": "xyz789",
-  "position": 987,
-  "url": "xyz789"
+  "position": 123,
+  "url": "abc123"
 }
 
    
-                    
-                  
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    MediaResourceType

    +
    +
    +
    +
    Description
    +

    Enumeration of media resource types

    +
    +
    +
    Values
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Enum ValueDescription
    +

    NEGOTIABLE_QUOTE_ATTACHMENT

    +     		Negotiable quote comment file attachment
    +

    CUSTOMER_ATTRIBUTE_FILE

    +     		Customer file resource type
    +

    CUSTOMER_ATTRIBUTE_IMAGE

    +     		Customer image resource type
    +

    CUSTOMER_ATTRIBUTE_ADDRESS_FILE

    +     		Customer file resource type for customer address
    +

    CUSTOMER_ATTRIBUTE_ADDRESS_IMAGE

    +     		Customer image resource type for customer address
    +
    +
    +
    +
    +
    Example
    + 
    "NEGOTIABLE_QUOTE_ATTACHMENT"
+
    back to top @@ -54134,12 +53123,8 @@
    Fields
    Example
    - - - 
    {"type": "xyz789"}
+                  
    {"type": "xyz789"}
 
    
-                    
-
    back to top @@ -54179,15 +53164,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "layout": "abc123",
   "logo": MessageStyleLogo
 }
 
    
-                    
-
    back to top @@ -54231,12 +53212,8 @@
    Fields
    Example
    - - - 
    {"currency": "AFN", "value": 987.65}
+                  
    {"currency": "AFN", "value": 987.65}
 
    
-                    
-
    back to top @@ -54285,16 +53262,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "gift_registry": GiftRegistry,
   "status": false,
   "user_errors": [GiftRegistryItemsUserError]
 }
 
    
-                    
-
    back to top @@ -54334,12 +53307,8 @@
    Fields
    Example
    - - - 
    {"requisitionListItemUids": ["4"]}
+                  
    {"requisitionListItemUids": [4]}
 
    
-                    
-
    back to top @@ -54383,15 +53352,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "destination_requisition_list": RequisitionList,
   "source_requisition_list": RequisitionList
 }
 
    
-                    
-
    back to top @@ -54443,12 +53408,12 @@
    Fields
    Example
    - - - 
    {"quote_item_uid": 4, "quote_uid": 4, "requisition_list_uid": 4}
+                  
    {
+  "quote_item_uid": "4",
+  "quote_uid": 4,
+  "requisition_list_uid": "4"
+}
 
    
-                    
-
    back to top @@ -54487,12 +53452,8 @@
    Fields
    Example
    - - - 
    {"quote": NegotiableQuote}
+                  
    {"quote": NegotiableQuote}
 
    
-                    
-
    back to top @@ -54541,16 +53502,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "destination_wishlist": Wishlist,
   "source_wishlist": Wishlist,
   "user_errors": [WishListUserInputError]
 }
 
    
-                    
-
    back to top @@ -54612,6 +53569,11 @@
    Fields
    The email address of the company user. + + expiration_date - String! + + The expiration period of the negotiable quote. + history - [NegotiableQuoteHistoryEntry] @@ -54632,11 +53594,21 @@
    Fields
    The title assigned to the negotiable quote. + + order - CustomerOrder + + The order created from the negotiable quote. + prices - CartPrices A set of subtotals and totals applied to the negotiable quote. + + sales_rep_name - String! + + The first and last name of the sales representative. + selected_payment_method - SelectedPaymentMethod @@ -54652,6 +53624,16 @@
    Fields
    The status of the negotiable quote. + + template_id - ID + + The unique ID of a NegotiableQuoteTemplate object. + + + template_name - String + + The title assigned to the negotiable quote template. + total_quantity - Float! @@ -54674,31 +53656,32 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "available_payment_methods": [AvailablePaymentMethod],
   "billing_address": NegotiableQuoteBillingAddress,
   "buyer": NegotiableQuoteUser,
   "comments": [NegotiableQuoteComment],
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "custom_attributes": [CustomAttribute],
-  "email": "xyz789",
+  "email": "abc123",
+  "expiration_date": "xyz789",
   "history": [NegotiableQuoteHistoryEntry],
   "is_virtual": false,
   "items": [CartItemInterface],
-  "name": "xyz789",
+  "name": "abc123",
+  "order": CustomerOrder,
   "prices": CartPrices,
+  "sales_rep_name": "abc123",
   "selected_payment_method": SelectedPaymentMethod,
   "shipping_addresses": [NegotiableQuoteShippingAddress],
   "status": "SUBMITTED",
+  "template_id": "4",
+  "template_name": "abc123",
   "total_quantity": 123.45,
   "uid": "4",
-  "updated_at": "abc123"
+  "updated_at": "xyz789"
 }
 
    
-                    
-
    back to top @@ -54742,15 +53725,11 @@
    Fields
    Example
    - - - 
    {
-  "code": "abc123",
+                  
    {
+  "code": "xyz789",
   "label": "xyz789"
 }
 
    
-                    
-
    back to top @@ -54795,6 +53774,18 @@
    Fields
    The country code and label for the billing or shipping address. + + + custom_attributes - [AttributeValueInput] + + The custom attribute values of the billing or shipping negotiable quote address. + + + + fax - String + + The fax number of the customer. + firstname - String! @@ -54807,12 +53798,24 @@
    Fields
    The last name of the company user. + + + middlename - String + + The middle name of the person associated with the billing/shipping address. + postcode - String The ZIP or postal code of the billing or shipping address. + + + prefix - String + + An honorific, such as Dr., Mr., or Mrs. + region - String @@ -54837,12 +53840,24 @@
    Fields
    An array containing the street for the billing or shipping address. + + + suffix - String + + A value such as Sr., Jr., or III. + telephone - String The telephone number for the billing or shipping address. + + + vat_id - String + + The customer's Tax/VAT number (for corporate customers). +
    @@ -54850,24 +53865,26 @@
    Fields
    Example
    - - - 
    {
-  "city": "xyz789",
+                  
    {
+  "city": "abc123",
   "company": "xyz789",
-  "country_code": "xyz789",
-  "firstname": "abc123",
-  "lastname": "xyz789",
-  "postcode": "abc123",
-  "region": "xyz789",
+  "country_code": "abc123",
+  "custom_attributes": [AttributeValueInput],
+  "fax": "xyz789",
+  "firstname": "xyz789",
+  "lastname": "abc123",
+  "middlename": "abc123",
+  "postcode": "xyz789",
+  "prefix": "abc123",
+  "region": "abc123",
   "region_id": 987,
-  "save_in_address_book": true,
+  "save_in_address_book": false,
   "street": ["abc123"],
-  "telephone": "xyz789"
+  "suffix": "xyz789",
+  "telephone": "abc123",
+  "vat_id": "abc123"
 }
 
    
-                    
-
    back to top @@ -54905,6 +53922,21 @@
    Fields
    The company's country. + + custom_attributes - [AttributeValueInterface] + + The custom attribute values of the billing or shipping negotiable quote address. + + + customer_address_uid - ID + + The unique ID from the customer's address book that uniquely identifies the address. + + + fax - String + + The fax number of the customer. + firstname - String! @@ -54915,11 +53947,21 @@
    Fields
    The last name of the company user. + + middlename - String + + The middle name of the person associated with the billing/shipping address. + postcode - String The company's ZIP or postal code. + + prefix - String + + An honorific, such as Dr., Mr., or Mrs. + region - NegotiableQuoteAddressRegion @@ -54930,11 +53972,26 @@
    Fields
    An array of strings that define the street number and name. + + suffix - String + + A value such as Sr., Jr., or III. + telephone - String The customer's telephone number. + + uid - ID! + + The unique identifier of the negotiable quote address. + + + vat_id - String + + The customer's Tax/VAT number (for corporate customers). + @@ -54964,22 +54021,26 @@
    Possible Types
    Example
    - - - 
    {
-  "city": "xyz789",
+                  
    {
+  "city": "abc123",
   "company": "abc123",
   "country": NegotiableQuoteAddressCountry,
+  "custom_attributes": [AttributeValueInterface],
+  "customer_address_uid": "4",
+  "fax": "xyz789",
   "firstname": "abc123",
   "lastname": "xyz789",
+  "middlename": "abc123",
   "postcode": "xyz789",
+  "prefix": "xyz789",
   "region": NegotiableQuoteAddressRegion,
-  "street": ["abc123"],
-  "telephone": "xyz789"
+  "street": ["xyz789"],
+  "suffix": "xyz789",
+  "telephone": "xyz789",
+  "uid": 4,
+  "vat_id": "xyz789"
 }
 
    
-                    
-
    back to top @@ -55028,16 +54089,12 @@
    Fields
    Example
    - - - 
    {
-  "code": "xyz789",
-  "label": "abc123",
+                  
    {
+  "code": "abc123",
+  "label": "xyz789",
   "region_id": 123
 }
 
    
-                    
-
    back to top @@ -55075,6 +54132,21 @@
    Fields
    The company's country. + + custom_attributes - [AttributeValueInterface] + + The custom attribute values of the billing or shipping negotiable quote address. + + + customer_address_uid - ID + + The unique ID from the customer's address book that uniquely identifies the address. + + + fax - String + + The fax number of the customer. + firstname - String! @@ -55085,11 +54157,21 @@
    Fields
    The last name of the company user. + + middlename - String + + The middle name of the person associated with the billing/shipping address. + postcode - String The company's ZIP or postal code. + + prefix - String + + An honorific, such as Dr., Mr., or Mrs. + region - NegotiableQuoteAddressRegion @@ -55100,11 +54182,26 @@
    Fields
    An array of strings that define the street number and name. + + suffix - String + + A value such as Sr., Jr., or III. + telephone - String The customer's telephone number. + + uid - ID! + + The unique identifier of the negotiable quote address. + + + vat_id - String + + The customer's Tax/VAT number (for corporate customers). + @@ -55112,22 +54209,26 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "city": "abc123",
   "company": "xyz789",
   "country": NegotiableQuoteAddressCountry,
+  "custom_attributes": [AttributeValueInterface],
+  "customer_address_uid": 4,
+  "fax": "abc123",
   "firstname": "abc123",
   "lastname": "abc123",
+  "middlename": "xyz789",
   "postcode": "abc123",
+  "prefix": "abc123",
   "region": NegotiableQuoteAddressRegion,
-  "street": ["xyz789"],
-  "telephone": "abc123"
+  "street": ["abc123"],
+  "suffix": "abc123",
+  "telephone": "xyz789",
+  "uid": "4",
+  "vat_id": "xyz789"
 }
 
    
-                    
-
    back to top @@ -55185,17 +54286,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "address": NegotiableQuoteAddressInput,
-  "customer_address_uid": "4",
+  "customer_address_uid": 4,
   "same_as_shipping": false,
-  "use_for_shipping": true
+  "use_for_shipping": false
 }
 
    
-                    
-
    back to top @@ -55222,6 +54319,11 @@
    Fields
    + + attachments - [NegotiableQuoteCommentAttachment]! + + Negotiable quote comment file attachments. + author - NegotiableQuoteUser! @@ -55254,18 +54356,104 @@
    Fields
    Example
    - - - 
    {
+                  
    {
+  "attachments": [NegotiableQuoteCommentAttachment],
   "author": NegotiableQuoteUser,
-  "created_at": "abc123",
+  "created_at": "xyz789",
   "creator_type": "BUYER",
-  "text": "xyz789",
+  "text": "abc123",
   "uid": 4
 }
 
    
-                    
-                  
+
    +
    + back to top + +
    +
    +
    + Types +
    +

    NegotiableQuoteCommentAttachment

    +
    +
    +
    +
    Description
    +

    Negotiable quote comment file attachment.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    name - String! + Negotiable quote comment attachment file name.
    url - String! + Negotiable quote comment attachment file url.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "name": "xyz789",
+  "url": "xyz789"
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    NegotiableQuoteCommentAttachmentInput

    +
    +
    +
    +
    Description
    +

    Negotiable quote comment file attachment.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + key - String! + Negotiable quote comment attachment file key.
    +
    +
    +
    +
    +
    Example
    + 
    {"key": "abc123"}
+
    back to top @@ -55309,12 +54497,8 @@
    Values
    Example
    - - - 
    "BUYER"
+                  
    "BUYER"
 
    
-                    
-
    back to top @@ -55341,6 +54525,12 @@
    Fields
    + + + attachments - [NegotiableQuoteCommentAttachmentInput] + + Negotiable quote comment file attachments. + comment - String! @@ -55354,12 +54544,11 @@
    Fields
    Example
    - - - 
    {"comment": "abc123"}
+                  
    {
+  "attachments": [NegotiableQuoteCommentAttachmentInput],
+  "comment": "abc123"
+}
 
    
-                    
-
    back to top @@ -55408,16 +54597,12 @@
    Fields
    Example
    - - - 
    {
-  "new_value": "xyz789",
-  "old_value": "abc123",
+                  
    {
+  "new_value": "abc123",
+  "old_value": "xyz789",
   "title": "abc123"
 }
 
    
-                    
-
    back to top @@ -55463,15 +54648,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "ids": FilterEqualTypeInput,
   "name": FilterMatchTypeInput
 }
 
    
-                    
-
    back to top @@ -55535,9 +54716,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "comment_added": NegotiableQuoteHistoryCommentChange,
   "custom_changes": NegotiableQuoteCustomLogChange,
   "expiration": NegotiableQuoteHistoryExpirationChange,
@@ -55546,8 +54725,6 @@ 
    Example
    
   "total": NegotiableQuoteHistoryTotalChange
 }
 
    
-                    
-
    back to top @@ -55586,12 +54763,8 @@
    Fields
    Example
    - - - 
    {"comment": "xyz789"}
+                  
    {"comment": "xyz789"}
 
    
-                    
-
    back to top @@ -55638,6 +54811,11 @@
    Fields
    Timestamp indicating when the negotiable quote entry was created. + + item_note - HistoryItemNoteData + + Item note data that is added to the negotiable quote history object. + uid - ID! @@ -55650,18 +54828,15 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "author": NegotiableQuoteUser,
   "change_type": "CREATED",
   "changes": NegotiableQuoteHistoryChanges,
-  "created_at": "xyz789",
-  "uid": "4"
+  "created_at": "abc123",
+  "item_note": HistoryItemNoteData,
+  "uid": 4
 }
 
    
-                    
-
    back to top @@ -55719,12 +54894,8 @@
    Values
    Example
    - - - 
    "CREATED"
+                  
    "CREATED"
 
    
-                    
-
    back to top @@ -55768,15 +54939,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "new_expiration": "abc123",
   "old_expiration": "xyz789"
 }
 
    
-                    
-
    back to top @@ -55821,15 +54988,11 @@
    Fields
    Example
    - - - 
    {
-  "products_removed_from_catalog": ["4"],
+                  
    {
+  "products_removed_from_catalog": [4],
   "products_removed_from_quote": [ProductInterface]
 }
 
    
-                    
-
    back to top @@ -55873,12 +55036,8 @@
    Fields
    Example
    - - - 
    {"new_status": "SUBMITTED", "old_status": "SUBMITTED"}
+                  
    {"new_status": "SUBMITTED", "old_status": "SUBMITTED"}
 
    
-                    
-
    back to top @@ -55917,12 +55076,8 @@
    Fields
    Example
    - - - 
    {"changes": [NegotiableQuoteHistoryStatusChange]}
+                  
    {"changes": [NegotiableQuoteHistoryStatusChange]}
 
    
-                    
-
    back to top @@ -55966,15 +55121,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "new_price": Money,
   "old_price": Money
 }
 
    
-                    
-
    back to top @@ -56013,12 +55164,8 @@
    Fields
    Example
    - - - 
    {"message": "abc123"}
+                  
    {"message": "xyz789"}
 
    
-                    
-
    back to top @@ -56064,12 +55211,8 @@
    Fields
    Example
    - - - 
    {"quantity": 987.65, "quote_item_uid": 4}
+                  
    {"quantity": 987.65, "quote_item_uid": 4}
 
    
-                    
-
    back to top @@ -56115,15 +55258,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "code": "abc123",
-  "purchase_order_number": "abc123"
+  "purchase_order_number": "xyz789"
 }
 
    
-                    
-
    back to top @@ -56177,17 +55316,13 @@
    Fields
    Example
    - - - 
    {
-  "document_identifier": "abc123",
-  "document_name": "abc123",
+                  
    {
+  "document_identifier": "xyz789",
+  "document_name": "xyz789",
   "link_id": 4,
-  "reference_document_url": "abc123"
+  "reference_document_url": "xyz789"
 }
 
    
-                    
-
    back to top @@ -56230,6 +55365,21 @@
    Fields
    The company's country. + + custom_attributes - [AttributeValueInterface] + + The custom attribute values of the billing or shipping negotiable quote address. + + + customer_address_uid - ID + + The unique ID from the customer's address book that uniquely identifies the address. + + + fax - String + + The fax number of the customer. + firstname - String! @@ -56240,11 +55390,21 @@
    Fields
    The last name of the company user. + + middlename - String + + The middle name of the person associated with the billing/shipping address. + postcode - String The company's ZIP or postal code. + + prefix - String + + An honorific, such as Dr., Mr., or Mrs. + region - NegotiableQuoteAddressRegion @@ -56260,11 +55420,26 @@
    Fields
    An array of strings that define the street number and name. + + suffix - String + + A value such as Sr., Jr., or III. + telephone - String The customer's telephone number. + + uid - ID! + + The unique identifier of the negotiable quote address. + + + vat_id - String + + The customer's Tax/VAT number (for corporate customers). +
    @@ -56272,24 +55447,28 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "available_shipping_methods": [AvailableShippingMethod],
-  "city": "xyz789",
+  "city": "abc123",
   "company": "xyz789",
   "country": NegotiableQuoteAddressCountry,
+  "custom_attributes": [AttributeValueInterface],
+  "customer_address_uid": "4",
+  "fax": "abc123",
   "firstname": "abc123",
-  "lastname": "abc123",
-  "postcode": "abc123",
+  "lastname": "xyz789",
+  "middlename": "xyz789",
+  "postcode": "xyz789",
+  "prefix": "abc123",
   "region": NegotiableQuoteAddressRegion,
   "selected_shipping_method": SelectedShippingMethod,
-  "street": ["abc123"],
-  "telephone": "abc123"
+  "street": ["xyz789"],
+  "suffix": "xyz789",
+  "telephone": "xyz789",
+  "uid": 4,
+  "vat_id": "xyz789"
 }
 
    
-                    
-
    back to top @@ -56341,16 +55520,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "address": NegotiableQuoteAddressInput,
   "customer_address_uid": "4",
-  "customer_notes": "xyz789"
+  "customer_notes": "abc123"
 }
 
    
-                    
-
    back to top @@ -56396,12 +55571,8 @@
    Fields
    Example
    - - - 
    {"sort_direction": "ASC", "sort_field": "QUOTE_NAME"}
+                  
    {"sort_direction": "ASC", "sort_field": "QUOTE_NAME"}
 
    
-                    
-
    back to top @@ -56449,12 +55620,8 @@
    Values
    Example
    - - - 
    "QUOTE_NAME"
+                  
    "QUOTE_NAME"
 
    
-                    
-
    back to top @@ -56547,12 +55714,8 @@
    Values
    Example
    - - - 
    "SUBMITTED"
+                  
    "SUBMITTED"
 
    
-                    
-
    back to top @@ -56589,6 +55752,11 @@
    Fields
    A list of comments made by the buyer and seller. + + created_at - String! + + Timestamp indicating when the negotiable quote template was created. + expiration_date - String! @@ -56599,6 +55767,12 @@
    Fields
    A list of status and price changes for the negotiable quote template. + + historyV2 - [NegotiableQuoteTemplateHistoryEntry] + + + + is_min_max_qty_used - Boolean! @@ -56644,6 +55818,11 @@
    Fields
    A list of reference document links for the negotiable quote template. + + sales_rep_name - String! + + The first and last name of the sales representative. + shipping_addresses - [NegotiableQuoteShippingAddress]! @@ -56664,6 +55843,16 @@
    Fields
    The total number of items in the negotiable quote template. + + uid - ID! + + The unique ID of a NegotiableQuoteTemplate object. + + + updated_at - String! + + Timestamp indicating when the negotiable quote template was updated. + @@ -56671,32 +55860,33 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "buyer": NegotiableQuoteUser,
   "comments": [NegotiableQuoteComment],
+  "created_at": "xyz789",
   "expiration_date": "xyz789",
   "history": [NegotiableQuoteHistoryEntry],
+  "historyV2": [NegotiableQuoteTemplateHistoryEntry],
   "is_min_max_qty_used": true,
-  "is_virtual": false,
+  "is_virtual": true,
   "items": [CartItemInterface],
-  "max_order_commitment": 123,
-  "min_order_commitment": 987,
-  "name": "abc123",
+  "max_order_commitment": 987,
+  "min_order_commitment": 123,
+  "name": "xyz789",
   "notifications": [QuoteTemplateNotificationMessage],
   "prices": CartPrices,
   "reference_document_links": [
     NegotiableQuoteReferenceDocumentLink
   ],
+  "sales_rep_name": "abc123",
   "shipping_addresses": [NegotiableQuoteShippingAddress],
-  "status": "xyz789",
-  "template_id": 4,
-  "total_quantity": 987.65
+  "status": "abc123",
+  "template_id": "4",
+  "total_quantity": 123.45,
+  "uid": "4",
+  "updated_at": "xyz789"
 }
 
    
-                    
-
    back to top @@ -56742,15 +55932,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "state": FilterEqualTypeInput,
   "status": FilterEqualTypeInput
 }
 
    
-                    
-
    back to top @@ -56787,6 +55973,11 @@
    Fields
    Company name the quote template is assigned to + + created_at - String! + + Timestamp indicating when the negotiable quote template was created. + expiration_date - String! @@ -56797,6 +55988,11 @@
    Fields
    Indicates whether the minimum and maximum quantity settings are used. + + last_ordered_at - String! + + Timestamp indicating when the last negotiable quote template order was placed. + last_shared_at - String! @@ -56827,6 +56023,11 @@
    Fields
    The number of orders placed for the negotiable quote template. + + prices - CartPrices + + A set of subtotals and totals applied to the negotiable quote template. + sales_rep_name - String! @@ -56852,6 +56053,16 @@
    Fields
    The unique ID of a NegotiableQuoteTemplate object. + + uid - ID! + + The unique ID of a NegotiableQuoteTemplate object. + + + updated_at - String! + + Timestamp indicating when the negotiable quote template was updated. + @@ -56859,28 +56070,255 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "activated_at": "xyz789",
-  "company_name": "xyz789",
+  "company_name": "abc123",
+  "created_at": "xyz789",
   "expiration_date": "xyz789",
   "is_min_max_qty_used": false,
+  "last_ordered_at": "abc123",
   "last_shared_at": "xyz789",
   "max_order_commitment": 123,
-  "min_negotiated_grand_total": 123.45,
+  "min_negotiated_grand_total": 987.65,
   "min_order_commitment": 987,
-  "name": "abc123",
+  "name": "xyz789",
   "orders_placed": 123,
+  "prices": CartPrices,
   "sales_rep_name": "xyz789",
   "state": "abc123",
   "status": "xyz789",
   "submitted_by": "abc123",
-  "template_id": 4
+  "template_id": 4,
+  "uid": 4,
+  "updated_at": "abc123"
+}
+
    
+
    +
    + back to top + +
    +
    +
    + Types +
    +

    NegotiableQuoteTemplateHistoryChanges

    +
    +
    +
    +
    Description
    +

    Contains a list of changes to a negotiable quote template.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    comment_added - NegotiableQuoteHistoryCommentChange + The comment provided with a change in the negotiable quote history.
    custom_changes - NegotiableQuoteCustomLogChange + Lists log entries added by third-party extensions.
    expiration - NegotiableQuoteHistoryExpirationChange + The expiration date of the negotiable quote before and after a change in the quote history.
    products_removed - NegotiableQuoteHistoryProductsRemovedChange + Lists products that were removed as a result of a change in the quote history.
    statuses - NegotiableQuoteTemplateHistoryStatusesChange + The status before and after a change in the negotiable quote template history.
    total - NegotiableQuoteHistoryTotalChange + The total amount of the negotiable quote before and after a change in the quote history.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "comment_added": NegotiableQuoteHistoryCommentChange,
+  "custom_changes": NegotiableQuoteCustomLogChange,
+  "expiration": NegotiableQuoteHistoryExpirationChange,
+  "products_removed": NegotiableQuoteHistoryProductsRemovedChange,
+  "statuses": NegotiableQuoteTemplateHistoryStatusesChange,
+  "total": NegotiableQuoteHistoryTotalChange
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    NegotiableQuoteTemplateHistoryEntry

    +
    +
    +
    +
    Description
    +

    Contains details about a change for a negotiable quote template.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    author - NegotiableQuoteUser! + The person who made a change in the status of the negotiable quote.
    change_type - NegotiableQuoteHistoryEntryChangeType! + An enum that specifies the reason for a status change in the negotiable quote history entry.
    changes - NegotiableQuoteTemplateHistoryChanges + The set of changes in the negotiable quote template.
    created_at - String! + Timestamp indicating when the negotiable quote entry was created.
    uid - ID! + The unique ID of a NegotiableQuoteHistoryEntry object.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "author": NegotiableQuoteUser,
+  "change_type": "CREATED",
+  "changes": NegotiableQuoteTemplateHistoryChanges,
+  "created_at": "abc123",
+  "uid": "4"
 }
    - - +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    NegotiableQuoteTemplateHistoryStatusChange

    +
    +
    +
    +
    Description
    +

    Lists a new status change applied to a negotiable quote template and the previous status.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    new_status - String! + The updated status.
    old_status - String + The previous status. The value will be null for the first history entry in a negotiable quote.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "new_status": "xyz789",
+  "old_status": "xyz789"
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    NegotiableQuoteTemplateHistoryStatusesChange

    +
    +
    +
    +
    Description
    +

    Contains a list of status changes that occurred for the negotiable quote template.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Field NameDescription
    changes - [NegotiableQuoteTemplateHistoryStatusChange]! + A list of status changes.
    +
    +
    +
    +
    +
    Example
    + 
    {"changes": [NegotiableQuoteTemplateHistoryStatusChange]}
+
    back to top @@ -56938,17 +56376,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "item_id": "4",
-  "max_qty": 987.65,
-  "min_qty": 123.45,
-  "quantity": 987.65
+  "max_qty": 123.45,
+  "min_qty": 987.65,
+  "quantity": 123.45
 }
 
    
-                    
-
    back to top @@ -57006,17 +56440,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "document_identifier": "abc123",
-  "document_name": "abc123",
-  "link_id": "4",
-  "reference_document_url": "xyz789"
+  "document_name": "xyz789",
+  "link_id": 4,
+  "reference_document_url": "abc123"
 }
 
    
-                    
-
    back to top @@ -57068,16 +56498,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "address": NegotiableQuoteAddressInput,
-  "customer_address_uid": 4,
+  "customer_address_uid": "4",
   "customer_notes": "abc123"
 }
 
    
-                    
-
    back to top @@ -57123,12 +56549,8 @@
    Fields
    Example
    - - - 
    {"sort_direction": "ASC", "sort_field": "TEMPLATE_ID"}
+                  
    {"sort_direction": "ASC", "sort_field": "TEMPLATE_ID"}
 
    
-                    
-
    back to top @@ -57170,12 +56592,8 @@
    Values
    Example
    - - - 
    "TEMPLATE_ID"
+                  
    "TEMPLATE_ID"
 
    
-                    
-
    back to top @@ -57229,17 +56647,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "items": [NegotiableQuoteTemplateGridItem],
   "page_info": SearchResultPageInfo,
   "sort_fields": SortFields,
-  "total_count": 123
+  "total_count": 987
 }
 
    
-                    
-
    back to top @@ -57291,12 +56705,8 @@
    Possible Types
    Example
    - - - 
    {"quote_uid": 4}
+                  
    {"quote_uid": 4}
 
    
-                    
-
    back to top @@ -57335,12 +56745,8 @@
    Fields
    Example
    - - - 
    {"quote_uid": "4"}
+                  
    {"quote_uid": 4}
 
    
-                    
-
    back to top @@ -57384,15 +56790,11 @@
    Fields
    Example
    - - - 
    {
-  "firstname": "xyz789",
+                  
    {
+  "firstname": "abc123",
   "lastname": "abc123"
 }
 
    
-                    
-
    back to top @@ -57446,17 +56848,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "items": [NegotiableQuote],
   "page_info": SearchResultPageInfo,
   "sort_fields": SortFields,
   "total_count": 987
 }
 
    
-                    
-
    back to top @@ -57500,12 +56898,101 @@
    Fields
    Example
    - - - 
    {"message": "xyz789", "uid": 4}
+                  
    {
+  "message": "abc123",
+  "uid": "4"
+}
+
    
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    NumericOperatorInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + type - NumericOperatorType + +
    +
    +
    +
    +
    +
    Example
    + 
    {"type": "UNKNOWN_NUMERIC_OPERATOR"}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    NumericOperatorType

    +
    +
    +
    +
    Values
    + + + + + + + + + + + + + + + + + + + + + +
    Enum ValueDescription
    +

    UNKNOWN_NUMERIC_OPERATOR

    +     		+
    +

    GREATER_THAN_CURRENT

    +     		+
    +

    LESS_THAN_CURRENT

    +     		+
    +
    +
    +
    +
    +
    Example
    + 
    "UNKNOWN_NUMERIC_OPERATOR"
    - -
    back to top @@ -57545,15 +57032,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "backend_integration_url": "xyz789",
   "custom_config": [CustomConfigKeyValue]
 }
 
    
-                    
-
    back to top @@ -57593,12 +57076,80 @@
    Fields
    Example
    - - - 
    {"template_id": "4"}
+                  
    {"template_id": "4"}
+
    
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    OperatorInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + rangeOperator - RangeOperatorInput + +
    + customOperator - CustomOperatorInput + +
    + isOperator - IsOperatorInput + +
    + numericOperator - NumericOperatorInput + +
    + stringOperator - StringOperatorInput + +
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "rangeOperator": RangeOperatorInput,
+  "customOperator": CustomOperatorInput,
+  "isOperator": IsOperatorInput,
+  "numericOperator": NumericOperatorInput,
+  "stringOperator": StringOperatorInput
+}
    - -
    back to top @@ -57637,12 +57188,8 @@
    Fields
    Example
    - - - 
    {"order_number": "xyz789"}
+                  
    {"order_number": "xyz789"}
 
    
-                    
-
    back to top @@ -57697,12 +57244,8 @@
    Values
    Example
    - - - 
    "REORDER"
+                  
    "REORDER"
 
    
-                    
-
    back to top @@ -57829,29 +57372,25 @@
    attributeCodes
    Example
    - - - 
    {
+                  
    {
   "city": "abc123",
   "company": "xyz789",
   "country_code": "AF",
   "custom_attributesV2": [AttributeValueInterface],
   "fax": "xyz789",
-  "firstname": "abc123",
-  "lastname": "xyz789",
+  "firstname": "xyz789",
+  "lastname": "abc123",
   "middlename": "xyz789",
   "postcode": "xyz789",
   "prefix": "abc123",
-  "region": "abc123",
+  "region": "xyz789",
   "region_id": "4",
   "street": ["abc123"],
   "suffix": "abc123",
   "telephone": "abc123",
-  "vat_id": "abc123"
+  "vat_id": "xyz789"
 }
 
    
-                    
-
    back to top @@ -57906,18 +57445,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "firstname": "abc123",
   "lastname": "abc123",
-  "middlename": "xyz789",
-  "prefix": "abc123",
+  "middlename": "abc123",
+  "prefix": "xyz789",
   "suffix": "xyz789"
 }
 
    
-                    
-
    back to top @@ -57981,7 +57516,7 @@
    Fields
    Contains details about the price of the item, including taxes and discounts. - product - ProductInterface! + product - ProductInterface The ProductInterface object, which contains details about the base product Product information is part of a composable Catalog Service. @@ -58063,9 +57598,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "custom_attributes": [CustomAttribute],
   "discounts": [Discount],
   "eligible_for_return": false,
@@ -58075,24 +57608,22 @@ 
    Example
    
   "id": 4,
   "prices": OrderItemPrices,
   "product": ProductInterface,
-  "product_name": "abc123",
+  "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "abc123",
   "product_type": "abc123",
-  "product_url_key": "xyz789",
-  "quantity_canceled": 987.65,
-  "quantity_invoiced": 987.65,
-  "quantity_ordered": 987.65,
+  "product_url_key": "abc123",
+  "quantity_canceled": 123.45,
+  "quantity_invoiced": 123.45,
+  "quantity_ordered": 123.45,
   "quantity_refunded": 987.65,
-  "quantity_return_requested": 987.65,
-  "quantity_returned": 123.45,
+  "quantity_return_requested": 123.45,
+  "quantity_returned": 987.65,
   "quantity_shipped": 123.45,
   "selected_options": [OrderItemOption],
-  "status": "xyz789"
+  "status": "abc123"
 }
 
    
-                    
-
    back to top @@ -58160,7 +57691,7 @@
    Fields
    Contains details about the price of the item, including taxes and discounts. - product - ProductInterface! + product - ProductInterface The ProductInterface object, which contains details about the base product Product information is part of a composable Catalog Service. @@ -58279,12 +57810,10 @@
    Possible Types
    Example
    - - - 
    {
+                  
    {
   "custom_attributes": [CustomAttribute],
   "discounts": [Discount],
-  "eligible_for_return": false,
+  "eligible_for_return": true,
   "entered_options": [OrderItemOption],
   "gift_message": GiftMessage,
   "gift_wrapping": GiftWrapping,
@@ -58293,22 +57822,20 @@ 
    Example
    
   "product": ProductInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
-  "product_sku": "abc123",
+  "product_sku": "xyz789",
   "product_type": "xyz789",
   "product_url_key": "abc123",
-  "quantity_canceled": 123.45,
-  "quantity_invoiced": 123.45,
+  "quantity_canceled": 987.65,
+  "quantity_invoiced": 987.65,
   "quantity_ordered": 123.45,
-  "quantity_refunded": 123.45,
-  "quantity_return_requested": 123.45,
+  "quantity_refunded": 987.65,
+  "quantity_return_requested": 987.65,
   "quantity_returned": 123.45,
   "quantity_shipped": 987.65,
   "selected_options": [OrderItemOption],
-  "status": "xyz789"
+  "status": "abc123"
 }
 
    
-                    
-
    back to top @@ -58352,15 +57879,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "label": "abc123",
-  "value": "xyz789"
+  "value": "abc123"
 }
 
    
-                    
-
    back to top @@ -58446,9 +57969,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "discounts": [Discount],
   "fixed_product_taxes": [FixedProductTax],
   "original_price": Money,
@@ -58462,8 +57983,6 @@ 
    Example
    
   "total_item_discount": Money
 }
 
    
-                    
-
    back to top @@ -58512,16 +58031,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "additional_data": [KeyValue],
-  "name": "abc123",
-  "type": "abc123"
+  "name": "xyz789",
+  "type": "xyz789"
 }
 
    
-                    
-
    back to top @@ -58580,18 +58095,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "comments": [SalesCommentItem],
-  "id": 4,
+  "id": "4",
   "items": [ShipmentItemInterface],
-  "number": "xyz789",
+  "number": "abc123",
   "tracking": [ShipmentTracking]
 }
 
    
-                    
-
    back to top @@ -58631,12 +58142,8 @@
    Fields
    Example
    - - - 
    {"token": "xyz789"}
+                  
    {"token": "xyz789"}
 
    
-                    
-
    back to top @@ -58684,6 +58191,11 @@
    Fields
    The final total amount, including shipping, discounts, and taxes. + + grand_total_excl_tax - Money! + + The grand total of the order, excluding taxes. + shipping_handling - ShippingHandling @@ -58736,13 +58248,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "base_grand_total": Money,
   "discounts": [Discount],
   "gift_options": GiftOptionsPrices,
   "grand_total": Money,
+  "grand_total_excl_tax": Money,
   "shipping_handling": ShippingHandling,
   "subtotal_excl_tax": Money,
   "subtotal_incl_tax": Money,
@@ -58754,8 +58265,6 @@ 
    Example
    
   "total_tax": Money
 }
 
    
-                    
-
    back to top @@ -58832,12 +58341,8 @@
    Values
    Example
    - - - 
    "CMS"
+                  
    "CMS"
 
    
-                    
-
    back to top @@ -58883,15 +58388,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "key": "xyz789",
   "value": "xyz789"
 }
 
    
-                    
-
    back to top @@ -58965,6 +58466,11 @@
    Possible Types

    ApplePayConfig

    + + +

    FastlaneConfig

    + +

    GooglePayConfig

    @@ -58987,9 +58493,7 @@
    Possible Types
    Example
    - - - 
    {
+                  
    {
   "code": "abc123",
   "is_visible": true,
   "payment_intent": "xyz789",
@@ -58998,8 +58502,6 @@ 
    Example
    
   "title": "abc123"
 }
 
    
-                    
-
    back to top @@ -59031,6 +58533,11 @@
    Fields
    ApplePay payment method configuration + + fastlane - FastlaneConfig + + Fastlane payment method configuration + google_pay - GooglePayConfig @@ -59053,17 +58560,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "apple_pay": ApplePayConfig,
+  "fastlane": FastlaneConfig,
   "google_pay": GooglePayConfig,
   "hosted_fields": HostedFieldsConfig,
   "smart_buttons": SmartButtonsConfig
 }
 
    
-                    
-
    back to top @@ -59132,12 +58636,8 @@
    Values
    Example
    - - - 
    "PRODUCT_DETAIL"
+                  
    "PRODUCT_DETAIL"
 
    
-                    
-
    back to top @@ -59182,6 +58682,12 @@
    Fields
    Required input for Apple Pay button + + + payment_services_paypal_fastlane - FastlaneMethodInput + + Required input for fastlane + payment_services_paypal_google_pay - GooglePayMethodInput @@ -59219,12 +58725,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "additional_data": [PaymentAttributeInput],
   "code": "xyz789",
   "payment_services_paypal_apple_pay": ApplePayMethodInput,
+  "payment_services_paypal_fastlane": FastlaneMethodInput,
   "payment_services_paypal_google_pay": GooglePayMethodInput,
   "payment_services_paypal_hosted_fields": HostedFieldsInput,
   "payment_services_paypal_smart_buttons": SmartButtonMethodInput,
@@ -59232,8 +58737,6 @@ 
    Example
    
   "purchase_order_number": "xyz789"
 }
 
    
-                    
-
    back to top @@ -59287,17 +58790,13 @@
    Fields
    Example
    - - - 
    {
-  "id": "abc123",
+                  
    {
+  "id": "xyz789",
   "mp_order_id": "abc123",
   "payment_source_details": PaymentSourceDetails,
   "status": "abc123"
 }
 
    
-                    
-
    back to top @@ -59337,15 +58836,11 @@
    Fields
    Example
    - - - 
    {
-  "code": "xyz789",
+                  
    {
+  "code": "abc123",
   "params": [SDKParams]
 }
 
    
-                    
-
    back to top @@ -59380,12 +58875,8 @@
    Fields
    Example
    - - - 
    {"card": Card}
+                  
    {"card": Card}
 
    
-                    
-
    back to top @@ -59425,12 +58916,8 @@
    Fields
    Example
    - - - 
    {"card": CardPaymentSourceInput}
+                  
    {"card": CardPaymentSourceInput}
 
    
-                    
-
    back to top @@ -59469,12 +58956,8 @@
    Fields
    Example
    - - - 
    {"card": CardPaymentSourceOutput}
+                  
    {"card": CardPaymentSourceOutput}
 
    
-                    
-
    back to top @@ -59528,17 +59011,13 @@
    Fields
    Example
    - - - 
    {
-  "details": "abc123",
+                  
    {
+  "details": "xyz789",
   "payment_method_code": "abc123",
   "public_hash": "abc123",
   "type": "card"
 }
 
    
-                    
-
    back to top @@ -59584,12 +59063,8 @@
    Values
    Example
    - - - 
    "card"
+                  
    "card"
 
    
-                    
-
    back to top @@ -59665,12 +59140,8 @@
    Possible Types
    Example
    - - - 
    {"weight": 987.65}
+                  
    {"weight": 123.45}
 
    
-                    
-
    back to top @@ -59794,28 +59265,24 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "city": "abc123",
   "contact_name": "xyz789",
   "country_id": "xyz789",
-  "description": "xyz789",
-  "email": "abc123",
+  "description": "abc123",
+  "email": "xyz789",
   "fax": "xyz789",
-  "latitude": 123.45,
-  "longitude": 123.45,
+  "latitude": 987.65,
+  "longitude": 987.65,
   "name": "abc123",
-  "phone": "xyz789",
-  "pickup_location_code": "abc123",
-  "postcode": "xyz789",
+  "phone": "abc123",
+  "pickup_location_code": "xyz789",
+  "postcode": "abc123",
   "region": "abc123",
-  "region_id": 123,
-  "street": "xyz789"
+  "region_id": 987,
+  "street": "abc123"
 }
 
    
-                    
-
    back to top @@ -59897,9 +59364,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "city": FilterTypeInput,
   "country_id": FilterTypeInput,
   "name": FilterTypeInput,
@@ -59910,8 +59375,6 @@ 
    Example
    
   "street": FilterTypeInput
 }
 
    
-                    
-
    back to top @@ -60041,9 +59504,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "city": "ASC",
   "contact_name": "ASC",
   "country_id": "ASC",
@@ -60062,8 +59523,6 @@ 
    Example
    
   "street": "ASC"
 }
 
    
-                    
-
    back to top @@ -60112,16 +59571,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "items": [PickupLocation],
   "page_info": SearchResultPageInfo,
-  "total_count": 123
+  "total_count": 987
 }
 
    
-                    
-
    back to top @@ -60161,12 +59616,8 @@
    Fields
    Example
    - - - 
    {"quote_uid": 4}
+                  
    {"quote_uid": 4}
 
    
-                    
-
    back to top @@ -60205,12 +59656,56 @@
    Fields
    Example
    - - - 
    {"order": Order}
+                  
    {"order": Order}
+
    
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    PlaceNegotiableQuoteOrderOutputV2

    +
    +
    +
    +
    Description
    +

    An output object that returns the generated order.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    errors - [PlaceOrderError] + An array of place negotiable quote order errors.
    order - CustomerOrder + Full order information.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "errors": [PlaceOrderError],
+  "order": CustomerOrder
+}
    - -
    back to top @@ -60254,15 +59749,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "code": "CART_NOT_FOUND",
   "message": "xyz789"
 }
 
    
-                    
-
    back to top @@ -60327,12 +59818,8 @@
    Values
    Example
    - - - 
    "CART_NOT_FOUND"
+                  
    "CART_NOT_FOUND"
 
    
-                    
-
    back to top @@ -60372,12 +59859,8 @@
    Fields
    Example
    - - - 
    {"purchase_order_uid": "4"}
+                  
    {"purchase_order_uid": "4"}
 
    
-                    
-
    back to top @@ -60416,12 +59899,8 @@
    Fields
    Example
    - - - 
    {"order": CustomerOrder}
+                  
    {"order": CustomerOrder}
 
    
-                    
-
    back to top @@ -60461,12 +59940,8 @@
    Fields
    Example
    - - - 
    {"cart_id": "abc123"}
+                  
    {"cart_id": "xyz789"}
 
    
-                    
-
    back to top @@ -60510,15 +59985,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "errors": [PlaceOrderError],
   "orderV2": CustomerOrder
 }
 
    
-                    
-
    back to top @@ -60558,12 +60029,8 @@
    Fields
    Example
    - - - 
    {"cart_id": "xyz789"}
+                  
    {"cart_id": "abc123"}
 
    
-                    
-
    back to top @@ -60602,12 +60069,8 @@
    Fields
    Example
    - - - 
    {"purchase_order": PurchaseOrder}
+                  
    {"purchase_order": PurchaseOrder}
 
    
-                    
-
    back to top @@ -60651,15 +60114,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "adjustments": [PriceAdjustment],
   "amount": ProductViewMoney
 }
 
    
-                    
-
    back to top @@ -60703,12 +60162,8 @@
    Fields
    Example
    - - - 
    {"amount": 987.65, "code": "xyz789"}
+                  
    {"amount": 987.65, "code": "xyz789"}
 
    
-                    
-
    back to top @@ -60757,16 +60212,12 @@
    Fields
    Example
    - - - 
    {
-  "discount_percentage": 987.65,
-  "main_final_price": 123.45,
+                  
    {
+  "discount_percentage": 123.45,
+  "main_final_price": 987.65,
   "main_price": 987.65
 }
 
    
-                    
-
    back to top @@ -60810,15 +60261,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "maximum_price": ProductPrice,
   "minimum_price": ProductPrice
 }
 
    
-                    
-
    back to top @@ -60873,12 +60320,8 @@
    Values
    Example
    - - - 
    "FIXED"
+                  
    "FIXED"
 
    
-                    
-
    back to top @@ -60926,12 +60369,8 @@
    Values
    Example
    - - - 
    "PRICE_RANGE"
+                  
    "PRICE_RANGE"
 
    
-                    
-
    back to top @@ -60975,15 +60414,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "code": "abc123",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
    
-                    
-
    back to top @@ -61027,15 +60462,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "errors": [AttributeMetadataError],
   "items": [AttributeValueInterface]
 }
 
    
-                    
-
    back to top @@ -61079,12 +60510,8 @@
    Fields
    Example
    - - - 
    {"amount_off": 987.65, "percent_off": 123.45}
+                  
    {"amount_off": 123.45, "percent_off": 123.45}
 
    
-                    
-
    back to top @@ -61138,17 +60565,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "disabled": false,
-  "label": "abc123",
+  "label": "xyz789",
   "position": 123,
-  "url": "abc123"
+  "url": "xyz789"
 }
 
    
-                    
-
    back to top @@ -61190,12 +60613,8 @@
    Values
    Example
    - - - 
    "ITSELF"
+                  
    "ITSELF"
 
    
-                    
-
    back to top @@ -61235,12 +60654,8 @@
    Fields
    Example
    - - - 
    {"sku": "abc123"}
+                  
    {"sku": "xyz789"}
 
    
-                    
-
    back to top @@ -61529,9 +60944,7 @@
    Possible Types
    Example
    - - - 
    {
+                  
    {
   "canonical_url": "abc123",
   "categories": [CategoryInterface],
   "country_of_manufacture": "xyz789",
@@ -61539,42 +60952,40 @@ 
    Example
    
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
   "gift_message_available": false,
-  "gift_wrapping_available": false,
+  "gift_wrapping_available": true,
   "gift_wrapping_price": Money,
   "image": ProductImage,
   "is_returnable": "abc123",
-  "manufacturer": 987,
+  "manufacturer": 123,
   "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
   "meta_description": "abc123",
-  "meta_keyword": "abc123",
+  "meta_keyword": "xyz789",
   "meta_title": "xyz789",
   "min_sale_qty": 123.45,
   "name": "xyz789",
   "new_from_date": "abc123",
   "new_to_date": "abc123",
   "only_x_left_in_stock": 123.45,
-  "options_container": "abc123",
+  "options_container": "xyz789",
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
   "quantity": 123.45,
   "related_products": [ProductInterface],
   "short_description": ComplexTextValue,
-  "sku": "xyz789",
+  "sku": "abc123",
   "small_image": ProductImage,
-  "special_price": 123.45,
+  "special_price": 987.65,
   "special_to_date": "xyz789",
   "stock_status": "IN_STOCK",
-  "swatch_image": "abc123",
+  "swatch_image": "xyz789",
   "thumbnail": ProductImage,
   "uid": "4",
   "upsell_products": [ProductInterface],
-  "url_key": "abc123"
+  "url_key": "xyz789"
 }
 
    
-                    
-
    back to top @@ -61633,18 +61044,14 @@
    Fields
    Example
    - - - 
    {
-  "link_type": "abc123",
-  "linked_product_sku": "abc123",
-  "linked_product_type": "xyz789",
+                  
    {
+  "link_type": "xyz789",
+  "linked_product_sku": "xyz789",
+  "linked_product_type": "abc123",
   "position": 987,
   "sku": "abc123"
 }
 
    
-                    
-
    back to top @@ -61720,18 +61127,14 @@
    Possible Types
    Example
    - - - 
    {
-  "link_type": "xyz789",
-  "linked_product_sku": "abc123",
+                  
    {
+  "link_type": "abc123",
+  "linked_product_sku": "xyz789",
   "linked_product_type": "abc123",
   "position": 987,
   "sku": "abc123"
 }
 
    
-                    
-
    back to top @@ -61780,16 +61183,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "asset_id": "abc123",
-  "media_type": "abc123",
+  "media_type": "xyz789",
   "media_url": "abc123"
 }
 
    
-                    
-
    back to top @@ -61838,16 +61237,12 @@
    Fields
    Example
    - - - 
    {
-  "media_type": "xyz789",
-  "video_asset_id": "abc123",
-  "video_media_url": "abc123"
+                  
    {
+  "media_type": "abc123",
+  "video_asset_id": "xyz789",
+  "video_media_url": "xyz789"
 }
 
    
-                    
-
    back to top @@ -61911,19 +61306,15 @@
    Fields
    Example
    - - - 
    {
-  "media_type": "abc123",
-  "video_description": "xyz789",
+                  
    {
+  "media_type": "xyz789",
+  "video_description": "abc123",
   "video_metadata": "abc123",
   "video_provider": "xyz789",
-  "video_title": "abc123",
-  "video_url": "xyz789"
+  "video_title": "xyz789",
+  "video_url": "abc123"
 }
 
    
-                    
-
    back to top @@ -61977,17 +61368,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "discount": ProductDiscount,
   "final_price": Money,
   "fixed_product_taxes": [FixedProductTax],
   "regular_price": Money
 }
 
    
-                    
-
    back to top @@ -62036,16 +61423,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "applied_query_rule": AppliedQueryRule,
   "highlights": [Highlight],
   "productView": ProductView
 }
 
    
-                    
-
    back to top @@ -62102,6 +61485,11 @@
    Fields
    The total number of products returned that matched the query + + warnings - [ProductSearchWarning] + + An array of warning messages for validation issues (e.g., sort parameter ignored due to missing categoryPath) +
    @@ -62109,19 +61497,16 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "facets": [Aggregation],
   "items": [ProductSearchItem],
   "page_info": SearchResultPageInfo,
   "related_terms": ["xyz789"],
-  "suggestions": ["xyz789"],
-  "total_count": 123
+  "suggestions": ["abc123"],
+  "total_count": 987,
+  "warnings": [ProductSearchWarning]
 }
 
    
-                    
-
    back to top @@ -62167,12 +61552,56 @@
    Fields
    Example
    - - - 
    {"attribute": "abc123", "direction": "ASC"}
+                  
    {"attribute": "xyz789", "direction": "ASC"}
+
    
+
    +
    + back to top + +
    +
    +
    + Types +
    +

    ProductSearchWarning

    +
    +
    +
    +
    Description
    +

    Structured warning with code and message for easier client handling

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    code - String! + Error code for programmatic handling (e.g., EMPTY_CATEGORY_PATH)
    message - String! + Human-readable message describing the warning
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "code": "abc123",
+  "message": "abc123"
+}
    - -
    back to top @@ -62220,12 +61649,8 @@
    Values
    Example
    - - - 
    "IN_STOCK"
+                  
    "IN_STOCK"
 
    
-                    
-
    back to top @@ -62284,18 +61709,14 @@
    Fields
    Example
    - - - 
    {
-  "disabled": false,
-  "label": "abc123",
+                  
    {
+  "disabled": true,
+  "label": "xyz789",
   "position": 123,
   "url": "abc123",
   "video_content": ProductMediaGalleryEntriesVideoContent
 }
 
    
-                    
-
    back to top @@ -62343,7 +61764,7 @@
    Fields
    attributes - [ProductViewAttribute] - A list of merchant-defined attributes designated for the storefront. + A list of merchant-defined attributes designated for the storefront. They can be filtered by roles and names. @@ -62354,6 +61775,10 @@
    Arguments
    roles - [String]
    +
    +
    names - [String] +
    +
    @@ -62467,6 +61892,24 @@
    linkTypes + + categories - [CategoryProductView!] + + A list of categories in which the product is present. + + + +
    +
    Arguments
    +
    +
    +
    family - String +
    +
    +
    +
    + + queryType - String @@ -62506,35 +61949,32 @@
    Possible Types
    Example
    - - - 
    {
-  "addToCartAllowed": false,
+                  
    {
+  "addToCartAllowed": true,
   "inStock": false,
   "lowStock": true,
   "attributes": [ProductViewAttribute],
   "description": "xyz789",
-  "id": 4,
+  "id": "4",
   "images": [ProductViewImage],
   "videos": [ProductViewVideo],
   "lastModifiedAt": "2007-12-03T10:15:30Z",
-  "metaDescription": "xyz789",
+  "metaDescription": "abc123",
   "metaKeyword": "xyz789",
-  "metaTitle": "abc123",
-  "name": "xyz789",
-  "shortDescription": "abc123",
+  "metaTitle": "xyz789",
+  "name": "abc123",
+  "shortDescription": "xyz789",
   "inputOptions": [ProductViewInputOption],
-  "sku": "abc123",
-  "externalId": "xyz789",
-  "url": "xyz789",
+  "sku": "xyz789",
+  "externalId": "abc123",
+  "url": "abc123",
   "urlKey": "abc123",
   "links": [ProductViewLink],
+  "categories": [CategoryProductView],
   "queryType": "abc123",
   "visibility": "xyz789"
 }
 
    
-                    
-
    back to top @@ -62588,17 +62028,13 @@
    Fields
    Example
    - - - 
    {
-  "label": "xyz789",
-  "name": "xyz789",
-  "roles": ["xyz789"],
+                  
    {
+  "label": "abc123",
+  "name": "abc123",
+  "roles": ["abc123"],
   "value": {}
 }
 
    
-                    
-
    back to top @@ -63822,12 +63258,8 @@
    Values
    Example
    - - - 
    "AED"
+                  
    "AED"
 
    
-                    
-
    back to top @@ -63876,16 +63308,12 @@
    Fields
    Example
    - - - 
    {
-  "label": "abc123",
+                  
    {
+  "label": "xyz789",
   "roles": ["xyz789"],
   "url": "xyz789"
 }
 
    
-                    
-
    back to top @@ -63972,14 +63400,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "id": "4",
-  "title": "xyz789",
-  "required": false,
+  "title": "abc123",
+  "required": true,
   "type": "abc123",
-  "markupAmount": 123.45,
+  "markupAmount": 987.65,
   "suffix": "xyz789",
   "sortOrder": 987,
   "range": ProductViewInputOptionRange,
@@ -63987,8 +63413,6 @@ 
    Example
    
   "fileExtensions": "abc123"
 }
 
    
-                    
-
    back to top @@ -64030,12 +63454,8 @@
    Fields
    Example
    - - - 
    {"width": 987, "height": 123}
+                  
    {"width": 987, "height": 123}
 
    
-                    
-
    back to top @@ -64077,12 +63497,8 @@
    Fields
    Example
    - - - 
    {"from": 987.65, "to": 123.45}
+                  
    {"from": 123.45, "to": 987.65}
 
    
-                    
-
    back to top @@ -64126,15 +63542,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "product": ProductView,
-  "linkTypes": ["abc123"]
+  "linkTypes": ["xyz789"]
 }
 
    
-                    
-
    back to top @@ -64178,12 +63590,8 @@
    Fields
    Example
    - - - 
    {"currency": "AED", "value": 987.65}
+                  
    {"currency": "AED", "value": 123.45}
 
    
-                    
-
    back to top @@ -64242,18 +63650,14 @@
    Fields
    Example
    - - - 
    {
-  "id": 4,
+                  
    {
+  "id": "4",
   "multi": true,
-  "required": true,
-  "title": "abc123",
+  "required": false,
+  "title": "xyz789",
   "values": [ProductViewOptionValue]
 }
 
    
-                    
-
    back to top @@ -64329,16 +63733,12 @@
    Possible Types
    Example
    - - - 
    {
+                  
    {
   "id": "4",
   "title": "abc123",
-  "inStock": false
+  "inStock": true
 }
 
    
-                    
-
    back to top @@ -64387,16 +63787,12 @@
    Fields
    Example
    - - - 
    {
-  "id": "4",
-  "title": "xyz789",
-  "inStock": false
+                  
    {
+  "id": 4,
+  "title": "abc123",
+  "inStock": true
 }
 
    
-                    
-
    back to top @@ -64460,19 +63856,15 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "id": "4",
   "isDefault": true,
   "product": SimpleProductView,
   "quantity": 987.65,
-  "title": "abc123",
+  "title": "xyz789",
   "inStock": false
 }
 
    
-                    
-
    back to top @@ -64531,18 +63923,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "id": 4,
-  "title": "abc123",
+  "title": "xyz789",
   "type": "TEXT",
-  "value": "abc123",
+  "value": "xyz789",
   "inStock": true
 }
 
    
-                    
-
    back to top @@ -64579,6 +63967,11 @@
    Fields
    Base product price specified by the merchant. + + tiers - [ProductViewTierPrice] + + Volume based pricing + roles - [String] @@ -64591,16 +63984,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "final": Price,
   "regular": Price,
+  "tiers": [ProductViewTierPrice],
   "roles": ["xyz789"]
 }
 
    
-                    
-
    back to top @@ -64644,15 +64034,175 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "maximum": ProductViewPrice,
   "minimum": ProductViewPrice
 }
 
    
-                    
-                  
+
    +
    + back to top + +
    +
    +
    + Types +
    +

    ProductViewTierCondition

    +
    +
    +
    +
    Types
    + + + + + + + + + + + + + + +
    Union Types
    +

    ProductViewTierRangeCondition

    +
    +

    ProductViewTierExactMatchCondition

    +
    +
    +
    +
    +
    +
    Example
    + 
    ProductViewTierRangeCondition
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    ProductViewTierExactMatchCondition

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Field NameDescription
    in - [Float] + +
    +
    +
    +
    +
    +
    Example
    + 
    {"in": [123.45]}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    ProductViewTierPrice

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    tier - Price + Volume based price
    quantity - [ProductViewTierCondition!]! + Condition to active price
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "tier": Price,
+  "quantity": [ProductViewTierRangeCondition]
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    ProductViewTierRangeCondition

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    gte - Float + +
    lt - Float + +
    +
    +
    +
    +
    +
    Example
    + 
    {"gte": 987.65, "lt": 987.65}
+
    back to top @@ -64692,15 +64242,11 @@
    Fields
    Example
    - - - 
    {
-  "selections": ["xyz789"],
+                  
    {
+  "selections": ["abc123"],
   "product": ProductView
 }
 
    
-                    
-
    back to top @@ -64740,15 +64286,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "variants": [ProductViewVariant],
   "cursor": "xyz789"
 }
 
    
-                    
-
    back to top @@ -64802,17 +64344,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "preview": ProductViewImage,
-  "url": "xyz789",
-  "description": "abc123",
-  "title": "abc123"
+  "url": "abc123",
+  "description": "xyz789",
+  "title": "xyz789"
 }
 
    
-                    
-
    back to top @@ -64860,15 +64398,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "date": "2007-12-03T10:15:30Z",
   "items": ["abc123"]
 }
 
    
-                    
-
    back to top @@ -64896,7 +64430,7 @@
    Fields
    - approval_flow - [PurchaseOrderRuleApprovalFlow]! + approval_flow - [PurchaseOrderRuleApprovalFlow] The approval flows for each applied rules. @@ -64962,13 +64496,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "approval_flow": [PurchaseOrderRuleApprovalFlow],
   "available_actions": ["REJECT"],
   "comments": [PurchaseOrderComment],
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "created_by": Customer,
   "history_log": [PurchaseOrderHistoryItem],
   "number": "abc123",
@@ -64976,11 +64508,9 @@ 
    Example
    
   "quote": Cart,
   "status": "PENDING",
   "uid": 4,
-  "updated_at": "xyz789"
+  "updated_at": "abc123"
 }
 
    
-                    
-
    back to top @@ -65045,12 +64575,8 @@
    Values
    Example
    - - - 
    "REJECT"
+                  
    "REJECT"
 
    
-                    
-
    back to top @@ -65094,12 +64620,8 @@
    Fields
    Example
    - - - 
    {"message": "xyz789", "type": "NOT_FOUND"}
+                  
    {"message": "xyz789", "type": "NOT_FOUND"}
 
    
-                    
-
    back to top @@ -65158,18 +64680,14 @@
    Fields
    Example
    - - - 
    {
-  "message": "xyz789",
-  "name": "abc123",
+                  
    {
+  "message": "abc123",
+  "name": "xyz789",
   "role": "xyz789",
   "status": "PENDING",
-  "updated_at": "abc123"
+  "updated_at": "xyz789"
 }
 
    
-                    
-
    back to top @@ -65220,12 +64738,8 @@
    Values
    Example
    - - - 
    "PENDING"
+                  
    "PENDING"
 
    
-                    
-
    back to top @@ -65309,23 +64823,19 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "applies_to_roles": [CompanyRole],
   "approver_roles": [CompanyRole],
   "condition": PurchaseOrderApprovalRuleConditionInterface,
   "created_at": "xyz789",
-  "created_by": "xyz789",
+  "created_by": "abc123",
   "description": "abc123",
   "name": "abc123",
   "status": "ENABLED",
   "uid": "4",
-  "updated_at": "abc123"
+  "updated_at": "xyz789"
 }
 
    
-                    
-
    back to top @@ -65374,16 +64884,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "amount": Money,
   "attribute": "GRAND_TOTAL",
   "operator": "MORE_THAN"
 }
 
    
-                    
-
    back to top @@ -65449,12 +64955,8 @@
    Possible Types
    Example
    - - - 
    {"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"}
+                  
    {"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"}
 
    
-                    
-
    back to top @@ -65512,12 +65014,8 @@
    Values
    Example
    - - - 
    "MORE_THAN"
+                  
    "MORE_THAN"
 
    
-                    
-
    back to top @@ -65566,12 +65064,8 @@
    Fields
    Example
    - - - 
    {"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987}
+                  
    {"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987}
 
    
-                    
-
    back to top @@ -65641,19 +65135,15 @@
    Fields
    Example
    - - - 
    {
-  "applies_to": ["4"],
-  "approvers": [4],
+                  
    {
+  "applies_to": [4],
+  "approvers": ["4"],
   "condition": CreatePurchaseOrderApprovalRuleConditionInput,
   "description": "xyz789",
   "name": "abc123",
   "status": "ENABLED"
 }
 
    
-                    
-
    back to top @@ -65702,16 +65192,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "available_applies_to": [CompanyRole],
   "available_condition_currencies": [AvailableCurrency],
   "available_requires_approval_from": [CompanyRole]
 }
 
    
-                    
-
    back to top @@ -65755,12 +65241,8 @@
    Values
    Example
    - - - 
    "ENABLED"
+                  
    "ENABLED"
 
    
-                    
-
    back to top @@ -65811,12 +65293,8 @@
    Values
    Example
    - - - 
    "GRAND_TOTAL"
+                  
    "GRAND_TOTAL"
 
    
-                    
-
    back to top @@ -65865,16 +65343,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "items": [PurchaseOrderApprovalRule],
   "page_info": SearchResultPageInfo,
   "total_count": 123
 }
 
    
-                    
-
    back to top @@ -65928,17 +65402,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "author": Customer,
   "created_at": "abc123",
   "text": "xyz789",
   "uid": "4"
 }
 
    
-                    
-
    back to top @@ -66003,12 +65473,8 @@
    Values
    Example
    - - - 
    "NOT_FOUND"
+                  
    "NOT_FOUND"
 
    
-                    
-
    back to top @@ -66062,17 +65528,13 @@
    Fields
    Example
    - - - 
    {
-  "activity": "abc123",
+                  
    {
+  "activity": "xyz789",
   "created_at": "xyz789",
-  "message": "xyz789",
+  "message": "abc123",
   "uid": "4"
 }
 
    
-                    
-
    back to top @@ -66116,15 +65578,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "events": [PurchaseOrderApprovalFlowEvent],
-  "rule_name": "xyz789"
+  "rule_name": "abc123"
 }
 
    
-                    
-
    back to top @@ -66217,12 +65675,8 @@
    Values
    Example
    - - - 
    "PENDING"
+                  
    "PENDING"
 
    
-                    
-
    back to top @@ -66271,16 +65725,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "items": [PurchaseOrder],
   "page_info": SearchResultPageInfo,
   "total_count": 987
 }
 
    
-                    
-
    back to top @@ -66320,12 +65770,8 @@
    Fields
    Example
    - - - 
    {"purchase_order_uids": [4]}
+                  
    {"purchase_order_uids": ["4"]}
 
    
-                    
-
    back to top @@ -66369,15 +65815,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "errors": [PurchaseOrderActionError],
   "purchase_orders": [PurchaseOrder]
 }
 
    
-                    
-
    back to top @@ -66416,6 +65858,12 @@
    Fields
    Filter by the creation date of the purchase order. + + + my_approvals - Boolean + + Include purchase orders that are pending approval by the customer or eligible for their approval but have already been dealt with. + require_my_approval - Boolean @@ -66435,17 +65883,14 @@
    Fields
    Example
    - - - 
    {
-  "company_purchase_orders": false,
+                  
    {
+  "company_purchase_orders": true,
   "created_date": FilterRangeTypeInput,
+  "my_approvals": true,
   "require_my_approval": false,
   "status": "PENDING"
 }
 
    
-                    
-
    back to top @@ -66487,15 +65932,11 @@
    Fields
    Example
    - - - 
    {
-  "customerGroup": "xyz789",
+                  
    {
+  "customerGroup": "abc123",
   "userViewHistory": [ViewHistoryInput]
 }
 
    
-                    
-
    back to top @@ -66541,12 +65982,58 @@
    Fields
    Example
    - - - 
    {"field": "ITEM_ID", "order": "ASC"}
+                  
    {"field": "ITEM_ID", "order": "ASC"}
+
    
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    QuoteTemplateExpirationDateInput

    +
    +
    +
    +
    Description
    +

    Sets quote template expiration date.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + expiration_date - String! + The expiration period of the negotiable quote template.
    + template_id - ID! + The unique ID of a NegotiableQuoteTemplate object.
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "expiration_date": "abc123",
+  "template_id": 4
+}
    - -
    back to top @@ -66575,7 +66062,13 @@
    Fields
    - item_id - ID! + item_id - ID + + The unique ID of a CartLineItem object. + + + + item_uid - ID The unique ID of a CartLineItem object. @@ -66598,16 +66091,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "item_id": "4",
+  "item_uid": "4",
   "note": "abc123",
   "templateId": "4"
 }
 
    
-                    
-
    back to top @@ -66651,15 +66141,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "message": "abc123",
-  "type": "xyz789"
+  "type": "abc123"
 }
 
    
-                    
-
    back to top @@ -66713,17 +66199,162 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "count": 987,
-  "from": 123.45,
+  "from": 987.65,
   "title": "xyz789",
-  "to": 123.45
+  "to": 987.65
 }
 
    
-                    
-                  
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    RangeOperatorInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + type - RangeType + +
    + value - RangeValueInput + +
    +
    +
    +
    +
    +
    Example
    + 
    {"type": "UNKNOWN_RANGE_TYPE", "value": RangeValueInput}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    RangeType

    +
    +
    +
    +
    Values
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Enum ValueDescription
    +

    UNKNOWN_RANGE_TYPE

    +     		+
    +

    STATIC

    +     		+
    +

    PERCENTAGE

    +     		+
    +

    DYNAMIC

    +     		+
    +
    +
    +
    +
    +
    Example
    + 
    "UNKNOWN_RANGE_TYPE"
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    RangeValueInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + from - Float + +
    + to - Float + +
    +
    +
    +
    +
    +
    Example
    + 
    {"from": 123.45, "to": 987.65}
+
    back to top @@ -66763,15 +66394,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "configurations": ReCaptchaConfiguration,
   "is_enabled": false
 }
 
    
-                    
-
    back to top @@ -66846,21 +66473,17 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "badge_position": "abc123",
   "language_code": "abc123",
   "minimum_score": 987.65,
   "re_captcha_type": "INVISIBLE",
-  "technical_failure_message": "xyz789",
-  "theme": "xyz789",
+  "technical_failure_message": "abc123",
+  "theme": "abc123",
   "validation_failure_message": "abc123",
-  "website_key": "xyz789"
+  "website_key": "abc123"
 }
 
    
-                    
-
    back to top @@ -66934,21 +66557,17 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "badge_position": "xyz789",
-  "failure_message": "xyz789",
+  "failure_message": "abc123",
   "forms": ["PLACE_ORDER"],
-  "is_enabled": true,
+  "is_enabled": false,
   "language_code": "xyz789",
-  "minimum_score": 987.65,
-  "theme": "xyz789",
+  "minimum_score": 123.45,
+  "theme": "abc123",
   "website_key": "abc123"
 }
 
    
-                    
-
    back to top @@ -67055,12 +66674,8 @@
    Values
    Example
    - - - 
    "PLACE_ORDER"
+                  
    "PLACE_ORDER"
 
    
-                    
-
    back to top @@ -67104,6 +66719,13 @@
    Values
    + + +

    RECAPTCHA_ENTERPRISE

    + + + +
    @@ -67111,12 +66733,8 @@
    Values
    Example
    - - - 
    "INVISIBLE"
+                  
    "INVISIBLE"
 
    
-                    
-
    back to top @@ -67190,21 +66808,17 @@
    Fields
    Example
    - - - 
    {
-  "displayOrder": 987,
+                  
    {
+  "displayOrder": 123,
   "pageType": "xyz789",
   "productsView": [ProductView],
-  "storefrontLabel": "xyz789",
+  "storefrontLabel": "abc123",
   "totalProducts": 987,
-  "typeId": "abc123",
+  "typeId": "xyz789",
   "unitId": "abc123",
   "unitName": "xyz789"
 }
 
    
-                    
-
    back to top @@ -67248,12 +66862,8 @@
    Fields
    Example
    - - - 
    {"results": [RecommendationUnit], "totalResults": 123}
+                  
    {"results": [RecommendationUnit], "totalResults": 123}
 
    
-                    
-
    back to top @@ -67298,16 +66908,12 @@
    Fields
    Example
    - - - 
    {
-  "code": "abc123",
+                  
    {
+  "code": "xyz789",
   "id": 987,
-  "name": "abc123"
+  "name": "xyz789"
 }
 
    
-                    
-
    back to top @@ -67347,12 +66953,8 @@
    Fields
    Example
    - - - 
    {"cart_id": "abc123"}
+                  
    {"cart_id": "xyz789"}
 
    
-                    
-
    back to top @@ -67391,12 +66993,8 @@
    Fields
    Example
    - - - 
    {"cart": Cart}
+                  
    {"cart": Cart}
 
    
-                    
-
    back to top @@ -67442,15 +67040,11 @@
    Fields
    Example
    - - - 
    {
-  "cart_id": "xyz789",
-  "coupon_codes": ["xyz789"]
+                  
    {
+  "cart_id": "abc123",
+  "coupon_codes": ["abc123"]
 }
 
    
-                    
-
    back to top @@ -67496,15 +67090,11 @@
    Fields
    Example
    - - - 
    {
-  "cart_id": "xyz789",
-  "gift_card_code": "abc123"
+                  
    {
+  "cart_id": "abc123",
+  "gift_card_code": "xyz789"
 }
 
    
-                    
-
    back to top @@ -67543,12 +67133,8 @@
    Fields
    Example
    - - - 
    {"cart": Cart}
+                  
    {"cart": Cart}
 
    
-                    
-
    back to top @@ -67587,12 +67173,8 @@
    Fields
    Example
    - - - 
    {"gift_registry": GiftRegistry}
+                  
    {"gift_registry": GiftRegistry}
 
    
-                    
-
    back to top @@ -67631,12 +67213,8 @@
    Fields
    Example
    - - - 
    {"success": false}
+                  
    {"success": false}
 
    
-                    
-
    back to top @@ -67675,12 +67253,8 @@
    Fields
    Example
    - - - 
    {"gift_registry": GiftRegistry}
+                  
    {"gift_registry": GiftRegistry}
 
    
-                    
-
    back to top @@ -67726,12 +67300,8 @@
    Fields
    Example
    - - - 
    {"cart_id": "abc123", "cart_item_uid": 4}
+                  
    {"cart_id": "abc123", "cart_item_uid": 4}
 
    
-                    
-
    back to top @@ -67770,12 +67340,8 @@
    Fields
    Example
    - - - 
    {"cart": Cart}
+                  
    {"cart": Cart}
 
    
-                    
-
    back to top @@ -67821,12 +67387,8 @@
    Fields
    Example
    - - - 
    {"quote_item_uids": [4], "quote_uid": 4}
+                  
    {"quote_item_uids": [4], "quote_uid": "4"}
 
    
-                    
-
    back to top @@ -67865,12 +67427,8 @@
    Fields
    Example
    - - - 
    {"quote": NegotiableQuote}
+                  
    {"quote": NegotiableQuote}
 
    
-                    
-
    back to top @@ -67916,12 +67474,8 @@
    Fields
    Example
    - - - 
    {"item_uids": [4], "template_id": 4}
+                  
    {"item_uids": [4], "template_id": "4"}
 
    
-                    
-
    back to top @@ -67967,12 +67521,8 @@
    Fields
    Example
    - - - 
    {"products": ["4"], "uid": 4}
+                  
    {"products": ["4"], "uid": 4}
 
    
-                    
-
    back to top @@ -68016,15 +67566,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "user_errors": [WishListUserInputError],
   "wishlist": Wishlist
 }
 
    
-                    
-
    back to top @@ -68064,12 +67610,8 @@
    Fields
    Example
    - - - 
    {"return_shipping_tracking_uid": 4}
+                  
    {"return_shipping_tracking_uid": "4"}
 
    
-                    
-
    back to top @@ -68108,12 +67650,8 @@
    Fields
    Example
    - - - 
    {"return": Return}
+                  
    {"return": Return}
 
    
-                    
-
    back to top @@ -68152,12 +67690,8 @@
    Fields
    Example
    - - - 
    {"cart": Cart}
+                  
    {"cart": Cart}
 
    
-                    
-
    back to top @@ -68197,12 +67731,8 @@
    Fields
    Example
    - - - 
    {"cart_id": "xyz789"}
+                  
    {"cart_id": "abc123"}
 
    
-                    
-
    back to top @@ -68241,12 +67771,8 @@
    Fields
    Example
    - - - 
    {"cart": Cart}
+                  
    {"cart": Cart}
 
    
-                    
-
    back to top @@ -68298,16 +67824,12 @@
    Fields
    Example
    - - - 
    {
-  "quote_comment": "abc123",
-  "quote_name": "xyz789",
-  "quote_uid": "4"
+                  
    {
+  "quote_comment": "xyz789",
+  "quote_name": "abc123",
+  "quote_uid": 4
 }
 
    
-                    
-
    back to top @@ -68346,12 +67868,8 @@
    Fields
    Example
    - - - 
    {"quote": NegotiableQuote}
+                  
    {"quote": NegotiableQuote}
 
    
-                    
-
    back to top @@ -68395,15 +67913,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "cart": Cart,
   "userInputErrors": [CheckoutUserInputError]
 }
 
    
-                    
-
    back to top @@ -68461,17 +67975,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "comment_text": "xyz789",
-  "contact_email": "xyz789",
+  "contact_email": "abc123",
   "items": [RequestReturnItemInput],
-  "token": "xyz789"
+  "token": "abc123"
 }
 
    
-                    
-
    back to top @@ -68529,17 +68039,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "cart_id": "4",
   "comment": NegotiableQuoteCommentInput,
   "is_draft": false,
   "quote_name": "abc123"
 }
 
    
-                    
-
    back to top @@ -68578,12 +68084,8 @@
    Fields
    Example
    - - - 
    {"quote": NegotiableQuote}
+                  
    {"quote": NegotiableQuote}
 
    
-                    
-
    back to top @@ -68623,12 +68125,8 @@
    Fields
    Example
    - - - 
    {"cart_id": "4"}
+                  
    {"cart_id": "4"}
 
    
-                    
-
    back to top @@ -68686,17 +68184,13 @@
    Fields
    Example
    - - - 
    {
-  "comment_text": "abc123",
-  "contact_email": "xyz789",
+                  
    {
+  "comment_text": "xyz789",
+  "contact_email": "abc123",
   "items": [RequestReturnItemInput],
-  "order_uid": 4
+  "order_uid": "4"
 }
 
    
-                    
-
    back to top @@ -68754,21 +68248,17 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "entered_custom_attributes": [
     EnteredCustomAttributeInput
   ],
   "order_item_uid": "4",
-  "quantity_to_return": 123.45,
+  "quantity_to_return": 987.65,
   "selected_custom_attributes": [
     SelectedCustomAttributeInput
   ]
 }
 
    
-                    
-
    back to top @@ -68831,15 +68321,11 @@
    currentPage
    Example
    - - - 
    {
+                  
    {
   "return": Return,
   "returns": Returns
 }
 
    
-                    
-
    back to top @@ -68922,19 +68408,15 @@
    pageSize
    Example
    - - - 
    {
-  "description": "xyz789",
+                  
    {
+  "description": "abc123",
   "items": RequistionListItems,
   "items_count": 987,
   "name": "xyz789",
-  "uid": 4,
+  "uid": "4",
   "updated_at": "abc123"
 }
 
    
-                    
-
    back to top @@ -68980,15 +68462,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "name": FilterMatchTypeInput,
   "uids": FilterEqualTypeInput
 }
 
    
-                    
-
    back to top @@ -69085,17 +68563,13 @@
    Possible Types
    Example
    - - - 
    {
+                  
    {
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
-  "quantity": 123.45,
+  "quantity": 987.65,
   "uid": 4
 }
 
    
-                    
-
    back to top @@ -69159,18 +68633,104 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "entered_options": [EnteredOptionInput],
   "parent_sku": "abc123",
-  "quantity": 987.65,
+  "quantity": 123.45,
   "selected_options": ["abc123"],
   "sku": "abc123"
 }
 
    
-                    
-                  
+
    +
    + back to top + +
    +
    +
    + Types +
    +

    RequisitionListSortInput

    +
    +
    +
    +
    Description
    +

    Defines the field to use to sort a list of requisition lists.

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + sort_direction - SortEnum + Whether to return results in ascending or descending order.
    + sort_field - RequisitionListSortableField! + The specified sort field.
    +
    +
    +
    +
    +
    Example
    + 
    {"sort_direction": "ASC", "sort_field": "NAME"}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    RequisitionListSortableField

    +
    +
    +
    +
    Values
    + + + + + + + + + + + + + + + + + +
    Enum ValueDescription
    +

    NAME

    +     		Sorts requisition lists by requisition list name.
    +

    UPDATED_AT

    +     		Sorts requisition lists by the date they were last updated.
    +
    +
    +
    +
    +
    Example
    + 
    "NAME"
+
    back to top @@ -69207,6 +68767,11 @@
    Fields
    Pagination metadata. + + sort_fields - SortFields + + Contains the default sort field and all available sort fields. + total_count - Int @@ -69219,16 +68784,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "items": [RequisitionList],
   "page_info": SearchResultPageInfo,
+  "sort_fields": SortFields,
   "total_count": 987
 }
 
    
-                    
-
    back to top @@ -69277,16 +68839,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "items": [RequisitionListItemInterface],
   "page_info": SearchResultPageInfo,
   "total_pages": 987
 }
 
    
-                    
-
    back to top @@ -69370,23 +68928,19 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "available_shipping_carriers": [ReturnShippingCarrier],
   "comments": [ReturnComment],
-  "created_at": "xyz789",
+  "created_at": "abc123",
   "customer": ReturnCustomer,
   "items": [ReturnItem],
   "number": "xyz789",
   "order": CustomerOrder,
   "shipping": ReturnShipping,
   "status": "PENDING",
-  "uid": "4"
+  "uid": 4
 }
 
    
-                    
-
    back to top @@ -69440,17 +68994,13 @@
    Fields
    Example
    - - - 
    {
-  "author_name": "xyz789",
-  "created_at": "xyz789",
-  "text": "xyz789",
-  "uid": "4"
+                  
    {
+  "author_name": "abc123",
+  "created_at": "abc123",
+  "text": "abc123",
+  "uid": 4
 }
 
    
-                    
-
    back to top @@ -69499,16 +69049,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "email": "abc123",
   "firstname": "xyz789",
-  "lastname": "abc123"
+  "lastname": "xyz789"
 }
 
    
-                    
-
    back to top @@ -69572,19 +69118,15 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "custom_attributesV2": [AttributeValueInterface],
   "order_item": OrderItemInterface,
   "quantity": 123.45,
-  "request_quantity": 123.45,
+  "request_quantity": 987.65,
   "status": "PENDING",
   "uid": 4
 }
 
    
-                    
-
    back to top @@ -69683,26 +69225,22 @@
    Fields
    Example
    - - - 
    {
-  "code": "4",
-  "default_value": "xyz789",
+                  
    {
+  "code": 4,
+  "default_value": "abc123",
   "entity_type": "CATALOG_PRODUCT",
-  "frontend_class": "abc123",
+  "frontend_class": "xyz789",
   "frontend_input": "BOOLEAN",
   "input_filter": "NONE",
   "is_required": false,
-  "is_unique": false,
+  "is_unique": true,
   "label": "xyz789",
   "multiline_count": 987,
   "options": [CustomAttributeOptionInterface],
-  "sort_order": 987,
+  "sort_order": 123,
   "validate_rules": [ValidationRule]
 }
 
    
-                    
-
    back to top @@ -69774,12 +69312,8 @@
    Values
    Example
    - - - 
    "PENDING"
+                  
    "PENDING"
 
    
-                    
-
    back to top @@ -69836,15 +69370,11 @@
    uid
    Example
    - - - 
    {
+                  
    {
   "address": ReturnShippingAddress,
   "tracking": [ReturnShippingTracking]
 }
 
    
-                    
-
    back to top @@ -69913,20 +69443,16 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "city": "xyz789",
   "contact_name": "xyz789",
   "country": Country,
   "postcode": "abc123",
   "region": Region,
-  "street": ["abc123"],
+  "street": ["xyz789"],
   "telephone": "abc123"
 }
 
    
-                    
-
    back to top @@ -69970,15 +69496,8 @@
    Fields
    Example
    - - - 
    {
-  "label": "xyz789",
-  "uid": "4"
-}
+                  
    {"label": "abc123", "uid": 4}
 
    
-                    
-
    back to top @@ -70032,17 +69551,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "carrier": ReturnShippingCarrier,
   "status": ReturnShippingTrackingStatus,
   "tracking_number": "xyz789",
   "uid": "4"
 }
 
    
-                    
-
    back to top @@ -70086,12 +69601,8 @@
    Fields
    Example
    - - - 
    {"text": "xyz789", "type": "INFORMATION"}
+                  
    {"text": "xyz789", "type": "INFORMATION"}
 
    
-                    
-
    back to top @@ -70135,12 +69646,8 @@
    Values
    Example
    - - - 
    "INFORMATION"
+                  
    "INFORMATION"
 
    
-                    
-
    back to top @@ -70261,12 +69768,8 @@
    Values
    Example
    - - - 
    "PENDING"
+                  
    "PENDING"
 
    
-                    
-
    back to top @@ -70315,16 +69818,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "items": [Return],
   "page_info": SearchResultPageInfo,
   "total_count": 123
 }
 
    
-                    
-
    back to top @@ -70363,12 +69862,8 @@
    Fields
    Example
    - - - 
    {"result": true}
+                  
    {"result": true}
 
    
-                    
-
    back to top @@ -70422,17 +69917,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "balance": RewardPointsAmount,
   "balance_history": [RewardPointsBalanceHistoryItem],
   "exchange_rates": RewardPointsExchangeRates,
   "subscription_status": RewardPointsSubscriptionStatus
 }
 
    
-                    
-
    back to top @@ -70472,12 +69963,8 @@
    Fields
    Example
    - - - 
    {"money": Money, "points": 987.65}
+                  
    {"money": Money, "points": 987.65}
 
    
-                    
-
    back to top @@ -70531,17 +70018,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "balance": RewardPointsAmount,
-  "change_reason": "xyz789",
+  "change_reason": "abc123",
   "date": "abc123",
-  "points_change": 123.45
+  "points_change": 987.65
 }
 
    
-                    
-
    back to top @@ -70585,15 +70068,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "earning": RewardPointsRate,
   "redemption": RewardPointsRate
 }
 
    
-                    
-
    back to top @@ -70637,12 +70116,8 @@
    Fields
    Example
    - - - 
    {"currency_amount": 987.65, "points": 123.45}
+                  
    {"currency_amount": 123.45, "points": 123.45}
 
    
-                    
-
    back to top @@ -70686,15 +70161,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "balance_updates": "SUBSCRIBED",
   "points_expiration_notifications": "SUBSCRIBED"
 }
 
    
-                    
-
    back to top @@ -70738,12 +70209,8 @@
    Values
    Example
    - - - 
    "SUBSCRIBED"
+                  
    "SUBSCRIBED"
 
    
-                    
-
    back to top @@ -70787,15 +70254,11 @@
    Fields
    Example
    - - - 
    {
-  "name": "xyz789",
+                  
    {
+  "name": "abc123",
   "value": "xyz789"
 }
 
    
-                    
-
    back to top @@ -70839,15 +70302,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "message": "abc123",
-  "timestamp": "abc123"
+  "timestamp": "xyz789"
 }
 
    
-                    
-
    back to top @@ -70896,12 +70355,12 @@
    Fields
    Example
    - - - 
    {"count": 123, "id": 4, "title": "xyz789"}
+                  
    {
+  "count": 123,
+  "id": "4",
+  "title": "abc123"
+}
 
    
-                    
-
    back to top @@ -70956,12 +70415,8 @@
    Values
    Example
    - - - 
    "GLOBAL"
+                  
    "GLOBAL"
 
    
-                    
-
    back to top @@ -71031,19 +70486,15 @@
    Fields
    Example
    - - - 
    {
-  "attribute": "abc123",
-  "contains": "abc123",
+                  
    {
+  "attribute": "xyz789",
+  "contains": "xyz789",
   "eq": "xyz789",
   "in": ["abc123"],
   "range": SearchRangeInput,
   "startsWith": "abc123"
 }
 
    
-                    
-
    back to top @@ -71089,12 +70540,8 @@
    Fields
    Example
    - - - 
    {"from": 123.45, "to": 123.45}
+                  
    {"from": 987.65, "to": 123.45}
 
    
-                    
-
    back to top @@ -71143,12 +70590,8 @@
    Fields
    Example
    - - - 
    {"current_page": 987, "page_size": 987, "total_pages": 123}
+                  
    {"current_page": 987, "page_size": 123, "total_pages": 987}
 
    
-                    
-
    back to top @@ -71202,17 +70645,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "label": "xyz789",
-  "type": "xyz789",
-  "uid": 4,
+  "type": "abc123",
+  "uid": "4",
   "values": [SelectedBundleOptionValue]
 }
 
    
-                    
-
    back to top @@ -71271,18 +70710,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "label": "xyz789",
   "original_price": Money,
   "priceV2": Money,
   "quantity": 123.45,
-  "uid": "4"
+  "uid": 4
 }
 
    
-                    
-
    back to top @@ -71336,17 +70771,13 @@
    Fields
    Example
    - - - 
    {
-  "configurable_product_option_uid": 4,
-  "configurable_product_option_value_uid": "4",
+                  
    {
+  "configurable_product_option_uid": "4",
+  "configurable_product_option_value_uid": 4,
   "option_label": "abc123",
-  "value_label": "xyz789"
+  "value_label": "abc123"
 }
 
    
-                    
-
    back to top @@ -71392,15 +70823,11 @@
    Fields
    Example
    - - - 
    {
-  "attribute_code": "abc123",
-  "value": "abc123"
+                  
    {
+  "attribute_code": "xyz789",
+  "value": "xyz789"
 }
 
    
-                    
-
    back to top @@ -71464,19 +70891,15 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "customizable_option_uid": "4",
-  "is_required": true,
+  "is_required": false,
   "label": "xyz789",
   "sort_order": 987,
   "type": "abc123",
   "values": [SelectedCustomizableOptionValue]
 }
 
    
-                    
-
    back to top @@ -71530,17 +70953,13 @@
    Fields
    Example
    - - - 
    {
-  "customizable_option_value_uid": "4",
+                  
    {
+  "customizable_option_value_uid": 4,
   "label": "abc123",
   "price": CartItemSelectedOptionValuePrice,
   "value": "abc123"
 }
 
    
-                    
-
    back to top @@ -71594,17 +71013,13 @@
    Fields
    Example
    - - - 
    {
-  "code": "xyz789",
+                  
    {
+  "code": "abc123",
   "oope_payment_method_config": OopePaymentMethodConfig,
   "purchase_order_number": "abc123",
   "title": "xyz789"
 }
 
    
-                    
-
    back to top @@ -71678,21 +71093,17 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "additional_data": [ShippingAdditionalData],
   "amount": Money,
   "carrier_code": "xyz789",
-  "carrier_title": "xyz789",
+  "carrier_title": "abc123",
   "method_code": "abc123",
   "method_title": "abc123",
   "price_excl_tax": Money,
   "price_incl_tax": Money
 }
 
    
-                    
-
    back to top @@ -71738,15 +71149,8 @@
    Fields
    Example
    - - - 
    {
-  "comment": NegotiableQuoteCommentInput,
-  "quote_uid": "4"
-}
+                  
    {"comment": NegotiableQuoteCommentInput, "quote_uid": 4}
 
    
-                    
-
    back to top @@ -71785,12 +71189,8 @@
    Fields
    Example
    - - - 
    {"quote": NegotiableQuote}
+                  
    {"quote": NegotiableQuote}
 
    
-                    
-
    back to top @@ -71836,15 +71236,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "billing_address": BillingAddressInput,
   "cart_id": "xyz789"
 }
 
    
-                    
-
    back to top @@ -71883,12 +71279,53 @@
    Fields
    Example
    - - - 
    {"cart": Cart}
+                  
    {"cart": Cart}
+
    
+
    +
    + back to top + +
    +
    +
    + Types +
    +

    SetCartAsInactiveOutput

    +
    +
    +
    +
    Description
    +

    Sets the cart as inactive

    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Field NameDescription
    error - String + The error message returned after failing to set the cart as inactive
    success - Boolean! + Indicates whether the cart was set as inactive
    +
    +
    +
    +
    +
    Example
    + 
    {"error": "xyz789", "success": true}
    - -
    back to top @@ -71934,15 +71371,8 @@
    Fields
    Example
    - - - 
    {
-  "custom_attributes": [CustomAttributeInput],
-  "id": "4"
-}
+                  
    {"custom_attributes": [CustomAttributeInput], "id": 4}
 
    
-                    
-
    back to top @@ -71981,12 +71411,8 @@
    Fields
    Example
    - - - 
    {"company": Company}
+                  
    {"company": Company}
 
    
-                    
-
    back to top @@ -72032,15 +71458,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "custom_attributes": [CustomAttributeInput],
   "quote_uid": 4
 }
 
    
-                    
-
    back to top @@ -72079,12 +71501,8 @@
    Fields
    Example
    - - - 
    {"quote": NegotiableQuote}
+                  
    {"quote": NegotiableQuote}
 
    
-                    
-
    back to top @@ -72148,18 +71566,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "cart_id": "abc123",
   "gift_message": GiftMessageInput,
   "gift_receipt_included": false,
-  "gift_wrapping_id": 4,
+  "gift_wrapping_id": "4",
   "printed_card_included": false
 }
 
    
-                    
-
    back to top @@ -72198,12 +71612,8 @@
    Fields
    Example
    - - - 
    {"cart": Cart}
+                  
    {"cart": Cart}
 
    
-                    
-
    back to top @@ -72249,15 +71659,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "cart_id": "xyz789",
-  "email": "abc123"
+  "email": "xyz789"
 }
 
    
-                    
-
    back to top @@ -72296,12 +71702,8 @@
    Fields
    Example
    - - - 
    {"cart": Cart}
+                  
    {"cart": Cart}
 
    
-                    
-
    back to top @@ -72340,12 +71742,8 @@
    Fields
    Example
    - - - 
    {"quote": NegotiableQuote}
+                  
    {"quote": NegotiableQuote}
 
    
-                    
-
    back to top @@ -72391,15 +71789,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "billing_address": NegotiableQuoteBillingAddressInput,
   "quote_uid": 4
 }
 
    
-                    
-
    back to top @@ -72438,12 +71832,8 @@
    Fields
    Example
    - - - 
    {"quote": NegotiableQuote}
+                  
    {"quote": NegotiableQuote}
 
    
-                    
-
    back to top @@ -72489,15 +71879,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "payment_method": NegotiableQuotePaymentMethodInput,
-  "quote_uid": 4
+  "quote_uid": "4"
 }
 
    
-                    
-
    back to top @@ -72536,12 +71922,8 @@
    Fields
    Example
    - - - 
    {"quote": NegotiableQuote}
+                  
    {"quote": NegotiableQuote}
 
    
-                    
-
    back to top @@ -72587,17 +71969,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "quote_uid": 4,
   "shipping_addresses": [
     NegotiableQuoteShippingAddressInput
   ]
 }
 
    
-                    
-
    back to top @@ -72636,12 +72014,8 @@
    Fields
    Example
    - - - 
    {"quote": NegotiableQuote}
+                  
    {"quote": NegotiableQuote}
 
    
-                    
-
    back to top @@ -72687,15 +72061,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "quote_uid": 4,
   "shipping_methods": [ShippingMethodInput]
 }
 
    
-                    
-
    back to top @@ -72734,12 +72104,8 @@
    Fields
    Example
    - - - 
    {"quote": NegotiableQuote}
+                  
    {"quote": NegotiableQuote}
 
    
-                    
-
    back to top @@ -72785,15 +72151,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "shipping_address": NegotiableQuoteTemplateShippingAddressInput,
-  "template_id": "4"
+  "template_id": 4
 }
 
    
-                    
-
    back to top @@ -72839,15 +72201,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "cart_id": "xyz789",
   "payment_method": PaymentMethodInput
 }
 
    
-                    
-
    back to top @@ -72886,12 +72244,8 @@
    Fields
    Example
    - - - 
    {"cart": Cart}
+                  
    {"cart": Cart}
 
    
-                    
-
    back to top @@ -72937,15 +72291,11 @@
    Fields
    Example
    - - - 
    {
-  "cart_id": "xyz789",
+                  
    {
+  "cart_id": "abc123",
   "shipping_addresses": [ShippingAddressInput]
 }
 
    
-                    
-
    back to top @@ -72984,12 +72334,8 @@
    Fields
    Example
    - - - 
    {"cart": Cart}
+                  
    {"cart": Cart}
 
    
-                    
-
    back to top @@ -73035,15 +72381,11 @@
    Fields
    Example
    - - - 
    {
-  "cart_id": "xyz789",
+                  
    {
+  "cart_id": "abc123",
   "shipping_methods": [ShippingMethodInput]
 }
 
    
-                    
-
    back to top @@ -73082,12 +72424,8 @@
    Fields
    Example
    - - - 
    {"cart": Cart}
+                  
    {"cart": Cart}
 
    
-                    
-
    back to top @@ -73133,15 +72471,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "email": "abc123",
-  "name": "abc123"
+  "name": "xyz789"
 }
 
    
-                    
-
    back to top @@ -73180,12 +72514,8 @@
    Fields
    Example
    - - - 
    {"is_shared": true}
+                  
    {"is_shared": true}
 
    
-                    
-
    back to top @@ -73231,15 +72561,11 @@
    Fields
    Example
    - - - 
    {
-  "message": "xyz789",
-  "name": "xyz789"
+                  
    {
+  "message": "abc123",
+  "name": "abc123"
 }
 
    
-                    
-
    back to top @@ -73287,12 +72613,8 @@
    Values
    Example
    - - - 
    "TOGETHER"
+                  
    "TOGETHER"
 
    
-                    
-
    back to top @@ -73352,19 +72674,15 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "id": "4",
   "order_item": OrderItemInterface,
   "product_name": "xyz789",
   "product_sale_price": Money,
   "product_sku": "abc123",
-  "quantity_shipped": 987.65
+  "quantity_shipped": 123.45
 }
 
    
-                    
-
    back to top @@ -73455,19 +72773,15 @@
    Possible Types
    Example
    - - - 
    {
+                  
    {
   "id": "4",
   "order_item": OrderItemInterface,
   "product_name": "abc123",
   "product_sale_price": Money,
-  "product_sku": "abc123",
-  "quantity_shipped": 987.65
+  "product_sku": "xyz789",
+  "quantity_shipped": 123.45
 }
 
    
-                    
-
    back to top @@ -73516,16 +72830,12 @@
    Fields
    Example
    - - - 
    {
-  "carrier": "abc123",
-  "number": "xyz789",
+                  
    {
+  "carrier": "xyz789",
+  "number": "abc123",
   "title": "abc123"
 }
 
    
-                    
-
    back to top @@ -73571,15 +72881,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "key": "abc123",
-  "value": "abc123"
+  "value": "xyz789"
 }
 
    
-                    
-
    back to top @@ -73618,6 +72924,12 @@
    Fields
    An ID from the customer's address book that uniquely identifies the address to be used for shipping. + + + customer_address_uid - ID + + The unique ID from the customer's address book that uniquely identifies the address to be used for shipping. + customer_notes - String @@ -73637,17 +72949,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "address": CartAddressInput,
-  "customer_address_id": 123,
-  "customer_notes": "abc123",
+  "customer_address_id": 987,
+  "customer_address_uid": 4,
+  "customer_notes": "xyz789",
   "pickup_location_code": "xyz789"
 }
 
    
-                    
-
    back to top @@ -73704,6 +73013,11 @@
    Fields
    The custom attribute values of the billing or shipping address. + + customer_address_uid - ID + + The unique ID from the customer's address book that uniquely identifies the address. + customer_notes - String @@ -73720,9 +73034,10 @@
    Fields
    The first name of the customer or guest. - id - Int + id - Int + + Id of the customer address. Use customer_address_uid instead. - Id of the customer address. lastname - String! @@ -73781,9 +73096,9 @@
    Fields
    The telephone number for the billing or shipping address. - uid - String! + uid - ID! - The unique id of the customer address. + The unique id of the customer cart address. vat_id - String @@ -73797,36 +73112,33 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "available_shipping_methods": [AvailableShippingMethod],
   "cart_items_v2": [CartItemInterface],
   "city": "abc123",
-  "company": "xyz789",
+  "company": "abc123",
   "country": CartAddressCountry,
   "custom_attributes": [AttributeValueInterface],
-  "customer_notes": "xyz789",
+  "customer_address_uid": "4",
+  "customer_notes": "abc123",
   "fax": "abc123",
   "firstname": "abc123",
   "id": 987,
   "lastname": "abc123",
-  "middlename": "abc123",
+  "middlename": "xyz789",
   "pickup_location_code": "abc123",
-  "postcode": "xyz789",
-  "prefix": "abc123",
+  "postcode": "abc123",
+  "prefix": "xyz789",
   "region": CartAddressRegion,
-  "same_as_billing": true,
+  "same_as_billing": false,
   "selected_shipping_method": SelectedShippingMethod,
-  "street": ["xyz789"],
+  "street": ["abc123"],
   "suffix": "xyz789",
   "telephone": "xyz789",
-  "uid": "abc123",
+  "uid": 4,
   "vat_id": "xyz789"
 }
 
    
-                    
-
    back to top @@ -73865,12 +73177,8 @@
    Fields
    Example
    - - - 
    {"amount": Money}
+                  
    {"amount": Money}
 
    
-                    
-
    back to top @@ -73929,9 +73237,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "amount_excluding_tax": Money,
   "amount_including_tax": Money,
   "discounts": [ShippingDiscount],
@@ -73939,8 +73245,6 @@ 
    Example
    
   "total_amount": Money
 }
 
    
-                    
-
    back to top @@ -73986,15 +73290,11 @@
    Fields
    Example
    - - - 
    {
-  "carrier_code": "abc123",
-  "method_code": "xyz789"
+                  
    {
+  "carrier_code": "xyz789",
+  "method_code": "abc123"
 }
 
    
-                    
-
    back to top @@ -74114,9 +73414,7 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "available_gift_wrapping": [GiftWrapping],
   "custom_attributes": [CustomAttribute],
   "customizable_options": [SelectedCustomizableOption],
@@ -74136,8 +73434,6 @@ 
    Example
    
   "uid": "4"
 }
 
    
-                    
-
    back to top @@ -74389,10 +73685,8 @@
    filters
    Example
    - - - 
    {
-  "canonical_url": "abc123",
+                  
    {
+  "canonical_url": "xyz789",
   "categories": [CategoryInterface],
   "country_of_manufacture": "xyz789",
   "crosssell_products": [ProductInterface],
@@ -74403,15 +73697,15 @@ 
    Example
    
   "gift_wrapping_price": Money,
   "image": ProductImage,
   "is_returnable": "xyz789",
-  "manufacturer": 123,
+  "manufacturer": 987,
   "max_sale_qty": 987.65,
   "media_gallery": [MediaGalleryInterface],
-  "meta_description": "abc123",
+  "meta_description": "xyz789",
   "meta_keyword": "abc123",
   "meta_title": "xyz789",
   "min_sale_qty": 123.45,
-  "name": "abc123",
-  "new_from_date": "xyz789",
+  "name": "xyz789",
+  "new_from_date": "abc123",
   "new_to_date": "abc123",
   "only_x_left_in_stock": 123.45,
   "options": [CustomizableOptionInterface],
@@ -74419,24 +73713,22 @@ 
    Example
    
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "quantity": 987.65,
+  "quantity": 123.45,
   "related_products": [ProductInterface],
   "short_description": ComplexTextValue,
-  "sku": "abc123",
+  "sku": "xyz789",
   "small_image": ProductImage,
-  "special_price": 987.65,
+  "special_price": 123.45,
   "special_to_date": "xyz789",
   "stock_status": "IN_STOCK",
-  "swatch_image": "abc123",
+  "swatch_image": "xyz789",
   "thumbnail": ProductImage,
   "uid": 4,
   "upsell_products": [ProductInterface],
   "url_key": "xyz789",
-  "weight": 987.65
+  "weight": 123.45
 }
 
    
-                    
-
    back to top @@ -74484,7 +73776,7 @@
    Fields
    attributes - [ProductViewAttribute] - A list of merchant-defined attributes designated for the storefront. + A list of merchant-defined attributes designated for the storefront. They can be filtered by names and roles. @@ -74495,6 +73787,10 @@
    Arguments
    roles - [String]
    +
    +
    names - [String] +
    +
    @@ -74613,6 +73909,24 @@
    linkTypes + + categories - [CategoryProductView!] + + A list of categories in which the product is present. + + + +
    +
    Arguments
    +
    +
    +
    family - String +
    +
    +
    +
    + + queryType - String @@ -74630,11 +73944,9 @@
    linkTypes
    Example
    - - - 
    {
-  "addToCartAllowed": false,
-  "inStock": true,
+                  
    {
+  "addToCartAllowed": true,
+  "inStock": false,
   "lowStock": true,
   "attributes": [ProductViewAttribute],
   "description": "abc123",
@@ -74648,18 +73960,17 @@ 
    Example
    
   "metaTitle": "xyz789",
   "name": "abc123",
   "price": ProductViewPrice,
-  "shortDescription": "xyz789",
+  "shortDescription": "abc123",
   "sku": "xyz789",
-  "externalId": "xyz789",
+  "externalId": "abc123",
   "url": "abc123",
   "urlKey": "abc123",
   "links": [ProductViewLink],
+  "categories": [CategoryProductView],
   "queryType": "xyz789",
   "visibility": "xyz789"
 }
 
    
-                    
-
    back to top @@ -74714,17 +74025,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
   "quantity": 123.45,
-  "uid": "4"
+  "uid": 4
 }
 
    
-                    
-
    back to top @@ -74789,19 +74096,15 @@
    Fields
    Example
    - - - 
    {
-  "added_at": "xyz789",
+                  
    {
+  "added_at": "abc123",
   "customizable_options": [SelectedCustomizableOption],
   "description": "xyz789",
-  "id": "4",
+  "id": 4,
   "product": ProductInterface,
   "quantity": 123.45
 }
 
    
-                    
-
    back to top @@ -74853,16 +74156,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "payment_source": "abc123",
-  "payments_order_id": "abc123",
-  "paypal_order_id": "abc123"
+  "payments_order_id": "xyz789",
+  "paypal_order_id": "xyz789"
 }
 
    
-                    
-
    back to top @@ -74885,6 +74184,11 @@
    Fields
    + + app_switch_when_available - Boolean + + Indicated whether to use App Switch on enabled mobile devices + button_styles - ButtonStyles @@ -74942,23 +74246,20 @@
    Fields
    Example
    - - - 
    {
+                  
    {
+  "app_switch_when_available": true,
   "button_styles": ButtonStyles,
-  "code": "xyz789",
-  "display_message": false,
+  "code": "abc123",
+  "display_message": true,
   "display_venmo": true,
   "is_visible": false,
   "message_styles": MessageStyles,
   "payment_intent": "xyz789",
   "sdk_params": [SDKParams],
-  "sort_order": "abc123",
+  "sort_order": "xyz789",
   "title": "xyz789"
 }
 
    
-                    
-
    back to top @@ -75006,12 +74307,8 @@
    Values
    Example
    - - - 
    "ASC"
+                  
    "ASC"
 
    
-                    
-
    back to top @@ -75055,15 +74352,11 @@
    Fields
    Example
    - - - 
    {
-  "label": "abc123",
+                  
    {
+  "label": "xyz789",
   "value": "abc123"
 }
 
    
-                    
-
    back to top @@ -75107,15 +74400,11 @@
    Fields
    Example
    - - - 
    {
-  "default": "xyz789",
+                  
    {
+  "default": "abc123",
   "options": [SortField]
 }
 
    
-                    
-
    back to top @@ -75380,12 +74669,8 @@
    Values
    Example
    - - - 
    "ITEM_ID"
+                  
    "ITEM_ID"
 
    
-                    
-
    back to top @@ -75439,17 +74724,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "attribute": "xyz789",
   "frontendInput": "abc123",
-  "label": "xyz789",
-  "numeric": true
+  "label": "abc123",
+  "numeric": false
 }
 
    
-                    
-
    back to top @@ -75498,16 +74779,12 @@
    Fields
    Example
    - - - 
    {
-  "max": 123.45,
+                  
    {
+  "max": 987.65,
   "min": 123.45,
-  "title": "xyz789"
+  "title": "abc123"
 }
 
    
-                    
-
    back to top @@ -75534,6 +74811,11 @@
    Fields
    + + allow_company_registration - Boolean! + + Indicates if company registration is allowed + allow_gift_receipt - String @@ -75604,6 +74886,11 @@
    Fields
    Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No). + + cart_merge_preference - String! + + Configuration data from checkout/cart/cart_merge_preference + cart_printed_card - String @@ -75679,6 +74966,16 @@
    Fields
    The title of the Check/Money Order payment method displayed on the storefront. + + company_credit_enabled - Boolean! + + Indicates if company credit is enabled. + + + company_enabled - Boolean! + + Indicates if B2B company functionality is enabled + configurable_product_image - ProductImageThumbnail! @@ -76014,6 +75311,16 @@
    Fields
    Indicates whether quick order functionality is enabled. + + quote_minimum_amount - Float + + Minimum order total for quote request. + + + quote_minimum_amount_message - String + + A message that will be shown in the cart when the subtotal (after discount) is lower than the minimum allowed amount. + required_character_classes_number - String @@ -76206,146 +75513,148 @@
    Fields
    Example
    - - - 
    {
+                  
    {
+  "allow_company_registration": true,
   "allow_gift_receipt": "abc123",
-  "allow_gift_wrapping_on_order": "abc123",
-  "allow_gift_wrapping_on_order_items": "xyz789",
-  "allow_items": "abc123",
+  "allow_gift_wrapping_on_order": "xyz789",
+  "allow_gift_wrapping_on_order_items": "abc123",
+  "allow_items": "xyz789",
   "allow_order": "abc123",
   "allow_printed_card": "xyz789",
   "autocomplete_on_storefront": false,
-  "base_currency_code": "xyz789",
+  "base_currency_code": "abc123",
   "base_link_url": "xyz789",
   "base_media_url": "xyz789",
   "base_static_url": "abc123",
   "base_url": "abc123",
   "cart_expires_in_days": 123,
-  "cart_gift_wrapping": "xyz789",
-  "cart_printed_card": "abc123",
-  "cart_summary_display_quantity": 987,
-  "catalog_default_sort_by": "xyz789",
+  "cart_gift_wrapping": "abc123",
+  "cart_merge_preference": "abc123",
+  "cart_printed_card": "xyz789",
+  "cart_summary_display_quantity": 123,
+  "catalog_default_sort_by": "abc123",
   "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
   "category_url_suffix": "abc123",
-  "check_money_order_enable_for_specific_countries": false,
-  "check_money_order_enabled": true,
-  "check_money_order_make_check_payable_to": "abc123",
+  "check_money_order_enable_for_specific_countries": true,
+  "check_money_order_enabled": false,
+  "check_money_order_make_check_payable_to": "xyz789",
   "check_money_order_max_order_total": "abc123",
-  "check_money_order_min_order_total": "abc123",
-  "check_money_order_new_order_status": "xyz789",
-  "check_money_order_payment_from_specific_countries": "xyz789",
+  "check_money_order_min_order_total": "xyz789",
+  "check_money_order_new_order_status": "abc123",
+  "check_money_order_payment_from_specific_countries": "abc123",
   "check_money_order_send_check_to": "abc123",
   "check_money_order_sort_order": 123,
-  "check_money_order_title": "abc123",
+  "check_money_order_title": "xyz789",
+  "company_credit_enabled": true,
+  "company_enabled": false,
   "configurable_product_image": "ITSELF",
-  "configurable_thumbnail_source": "abc123",
+  "configurable_thumbnail_source": "xyz789",
   "contact_enabled": true,
   "countries_with_required_region": "abc123",
-  "create_account_confirmation": false,
+  "create_account_confirmation": true,
   "customer_access_token_lifetime": 123.45,
   "default_country": "xyz789",
   "default_display_currency_code": "abc123",
-  "display_product_prices_in_catalog": 987,
+  "display_product_prices_in_catalog": 123,
   "display_shipping_prices": 987,
   "display_state_if_optional": false,
   "enable_multiple_wishlists": "abc123",
-  "fixed_product_taxes_apply_tax_to_fpt": false,
-  "fixed_product_taxes_display_prices_in_emails": 987,
+  "fixed_product_taxes_apply_tax_to_fpt": true,
+  "fixed_product_taxes_display_prices_in_emails": 123,
   "fixed_product_taxes_display_prices_in_product_lists": 123,
   "fixed_product_taxes_display_prices_in_sales_modules": 123,
   "fixed_product_taxes_display_prices_on_product_view_page": 123,
-  "fixed_product_taxes_enable": true,
+  "fixed_product_taxes_enable": false,
   "fixed_product_taxes_include_fpt_in_subtotal": true,
   "graphql_share_customer_group": false,
-  "grid_per_page": 987,
+  "grid_per_page": 123,
   "grid_per_page_values": "xyz789",
   "grouped_product_image": "ITSELF",
-  "is_checkout_agreements_enabled": false,
+  "is_checkout_agreements_enabled": true,
   "is_default_store": true,
   "is_default_store_group": false,
   "is_guest_checkout_enabled": true,
   "is_negotiable_quote_active": false,
-  "is_one_page_checkout_enabled": false,
+  "is_one_page_checkout_enabled": true,
   "is_requisition_list_active": "xyz789",
   "list_mode": "abc123",
-  "list_per_page": 123,
-  "list_per_page_values": "xyz789",
+  "list_per_page": 987,
+  "list_per_page_values": "abc123",
   "locale": "abc123",
-  "magento_reward_general_is_enabled": "abc123",
-  "magento_reward_general_is_enabled_on_front": "abc123",
-  "magento_reward_general_min_points_balance": "xyz789",
-  "magento_reward_general_publish_history": "abc123",
+  "magento_reward_general_is_enabled": "xyz789",
+  "magento_reward_general_is_enabled_on_front": "xyz789",
+  "magento_reward_general_min_points_balance": "abc123",
+  "magento_reward_general_publish_history": "xyz789",
   "magento_reward_points_invitation_customer": "abc123",
-  "magento_reward_points_invitation_customer_limit": "xyz789",
-  "magento_reward_points_invitation_order": "abc123",
-  "magento_reward_points_invitation_order_limit": "abc123",
+  "magento_reward_points_invitation_customer_limit": "abc123",
+  "magento_reward_points_invitation_order": "xyz789",
+  "magento_reward_points_invitation_order_limit": "xyz789",
   "magento_reward_points_newsletter": "xyz789",
-  "magento_reward_points_order": "abc123",
-  "magento_reward_points_register": "abc123",
+  "magento_reward_points_order": "xyz789",
+  "magento_reward_points_register": "xyz789",
   "magento_reward_points_review": "xyz789",
   "magento_reward_points_review_limit": "abc123",
   "magento_wishlist_general_is_enabled": "abc123",
-  "max_items_in_order_summary": 123,
+  "max_items_in_order_summary": 987,
   "maximum_number_of_wishlists": "xyz789",
-  "minicart_display": false,
+  "minicart_display": true,
   "minicart_max_items": 123,
-  "minimum_password_length": "xyz789",
-  "newsletter_enabled": true,
-  "optional_zip_countries": "abc123",
+  "minimum_password_length": "abc123",
+  "newsletter_enabled": false,
+  "optional_zip_countries": "xyz789",
   "order_cancellation_enabled": true,
   "order_cancellation_reasons": [CancellationReason],
-  "orders_invoices_credit_memos_display_full_summary": true,
-  "orders_invoices_credit_memos_display_grandtotal": true,
-  "orders_invoices_credit_memos_display_price": 123,
-  "orders_invoices_credit_memos_display_shipping_amount": 987,
-  "orders_invoices_credit_memos_display_subtotal": 987,
+  "orders_invoices_credit_memos_display_full_summary": false,
+  "orders_invoices_credit_memos_display_grandtotal": false,
+  "orders_invoices_credit_memos_display_price": 987,
+  "orders_invoices_credit_memos_display_shipping_amount": 123,
+  "orders_invoices_credit_memos_display_subtotal": 123,
   "orders_invoices_credit_memos_display_zero_tax": false,
   "printed_card_priceV2": Money,
   "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
   "product_url_suffix": "abc123",
-  "quickorder_active": false,
+  "quickorder_active": true,
+  "quote_minimum_amount": 987.65,
+  "quote_minimum_amount_message": "xyz789",
   "required_character_classes_number": "xyz789",
-  "returns_enabled": "xyz789",
-  "root_category_uid": 4,
+  "returns_enabled": "abc123",
+  "root_category_uid": "4",
   "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
   "sales_gift_wrapping": "abc123",
-  "sales_printed_card": "abc123",
-  "secure_base_link_url": "xyz789",
+  "sales_printed_card": "xyz789",
+  "secure_base_link_url": "abc123",
   "secure_base_media_url": "abc123",
   "secure_base_static_url": "abc123",
   "secure_base_url": "abc123",
   "share_active_segments": true,
   "share_applied_cart_rule": true,
-  "shopping_cart_display_full_summary": true,
+  "shopping_cart_display_full_summary": false,
   "shopping_cart_display_grand_total": true,
-  "shopping_cart_display_price": 987,
+  "shopping_cart_display_price": 123,
   "shopping_cart_display_shipping": 123,
-  "shopping_cart_display_subtotal": 987,
+  "shopping_cart_display_subtotal": 123,
   "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
-  "shopping_cart_display_zero_tax": false,
+  "shopping_cart_display_zero_tax": true,
   "store_code": "4",
-  "store_group_code": "4",
+  "store_group_code": 4,
   "store_group_name": "abc123",
-  "store_name": "abc123",
-  "store_sort_order": 123,
+  "store_name": "xyz789",
+  "store_sort_order": 987,
   "timezone": "abc123",
-  "title_separator": "abc123",
-  "use_store_in_url": true,
-  "website_code": 4,
-  "website_name": "xyz789",
-  "weight_unit": "abc123",
+  "title_separator": "xyz789",
+  "use_store_in_url": false,
+  "website_code": "4",
+  "website_name": "abc123",
+  "weight_unit": "xyz789",
   "zero_subtotal_enable_for_specific_countries": true,
   "zero_subtotal_enabled": true,
   "zero_subtotal_new_order_status": "abc123",
   "zero_subtotal_payment_action": "abc123",
-  "zero_subtotal_payment_from_specific_countries": "xyz789",
-  "zero_subtotal_sort_order": 987,
+  "zero_subtotal_payment_from_specific_countries": "abc123",
+  "zero_subtotal_sort_order": 123,
   "zero_subtotal_title": "xyz789"
 }
 
    
-                    
-
    back to top @@ -76366,12 +75675,98 @@
    Description
    Example
    - - - 
    "abc123"
+                  
    "abc123"
+
    
+
    +
    + back to top + +
    +
    +
    + Types +
    +

    StringOperatorInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + +
    Input FieldDescription
    + type - StringOperatorType + +
    +
    +
    +
    +
    +
    Example
    + 
    {"type": "UNKNOWN_STRING_OPERATOR"}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    StringOperatorType

    +
    +
    +
    +
    Values
    + + + + + + + + + + + + + + + + + + + + + +
    Enum ValueDescription
    +

    UNKNOWN_STRING_OPERATOR

    +     		+
    +

    SAME_AS_CURRENT

    +     		+
    +

    ALL_EXCEPT_CURRENT

    +     		+
    +
    +
    +
    +
    +
    Example
    + 
    "UNKNOWN_STRING_OPERATOR"
    - -
    back to top @@ -76398,6 +75793,12 @@
    Fields
    + + + attachments - [NegotiableQuoteCommentAttachmentInput] + + Negotiable quote template comment file attachments. + comment - String @@ -76441,21 +75842,18 @@
    Fields
    Example
    - - - 
    {
+                  
    {
+  "attachments": [NegotiableQuoteCommentAttachmentInput],
   "comment": "xyz789",
-  "max_order_commitment": 987,
-  "min_order_commitment": 123,
+  "max_order_commitment": 123,
+  "min_order_commitment": 987,
   "name": "abc123",
   "reference_document_links": [
     NegotiableQuoteTemplateReferenceDocumentLinkInput
   ],
-  "template_id": "4"
+  "template_id": 4
 }
 
    
-                    
-
    back to top @@ -76494,12 +75892,8 @@
    Fields
    Example
    - - - 
    {"status": "NOT_ACTIVE"}
+                  
    {"status": "NOT_ACTIVE"}
 
    
-                    
-
    back to top @@ -76561,12 +75955,8 @@
    Values
    Example
    - - - 
    "NOT_ACTIVE"
+                  
    "NOT_ACTIVE"
 
    
-                    
-
    back to top @@ -76610,12 +76000,8 @@
    Fields
    Example
    - - - 
    {"depth": 123, "startLevel": 987}
+                  
    {"depth": 123, "startLevel": 987}
 
    
-                    
-
    back to top @@ -76677,12 +76063,8 @@
    Possible Types
    Example
    - - - 
    {"value": "xyz789"}
+                  
    {"value": "abc123"}
 
    
-                    
-
    back to top @@ -76842,12 +76224,8 @@
    Values
    Example
    - - - 
    "BOOLEAN"
+                  
    "BOOLEAN"
 
    
-                    
-
    back to top @@ -76905,12 +76283,8 @@
    Values
    Example
    - - - 
    "TEXT"
+                  
    "TEXT"
 
    
-                    
-
    back to top @@ -76956,15 +76330,11 @@
    Fields
    Example
    - - - 
    {
-  "cartId": "abc123",
-  "id": "abc123"
+                  
    {
+  "cartId": "xyz789",
+  "id": "xyz789"
 }
 
    
-                    
-
    back to top @@ -77013,16 +76383,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "amount": Money,
-  "rate": 123.45,
+  "rate": 987.65,
   "title": "xyz789"
 }
 
    
-                    
-
    back to top @@ -77073,12 +76439,8 @@
    Values
    Example
    - - - 
    "DISPLAY_EXCLUDING_TAX"
+                  
    "DISPLAY_EXCLUDING_TAX"
 
    
-                    
-
    back to top @@ -77113,12 +76475,8 @@
    Fields
    Example
    - - - 
    {"value": "xyz789"}
+                  
    {"value": "abc123"}
 
    
-                    
-
    back to top @@ -77173,12 +76531,8 @@
    Values
    Example
    - - - 
    "OFF"
+                  
    "OFF"
 
    
-                    
-
    back to top @@ -77227,16 +76581,108 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "discount": ProductDiscount,
   "final_price": Money,
-  "quantity": 123.45
+  "quantity": 987.65
+}
+
    
+
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    UnitConfigInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + unitName - String + +
    + storefrontLabel - String + +
    + pagePlacement - String + +
    + displayNumber - Int + +
    + pageType - String + +
    + unitStatus - String + +
    + typeId - String + +
    + filterRules - [FilterRuleInput] + +
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "unitName": "abc123",
+  "storefrontLabel": "abc123",
+  "pagePlacement": "abc123",
+  "displayNumber": 123,
+  "pageType": "abc123",
+  "unitStatus": "abc123",
+  "typeId": "xyz789",
+  "filterRules": [FilterRuleInput]
 }
    - -
    back to top @@ -77282,15 +76728,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "cart_id": "xyz789",
   "cart_items": [CartItemUpdateInput]
 }
 
    
-                    
-
    back to top @@ -77334,15 +76776,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "cart": Cart,
   "errors": [CartUserInputError]
 }
 
    
-                    
-
    back to top @@ -77381,12 +76819,8 @@
    Fields
    Example
    - - - 
    {"company": Company}
+                  
    {"company": Company}
 
    
-                    
-
    back to top @@ -77425,12 +76859,8 @@
    Fields
    Example
    - - - 
    {"role": CompanyRole}
+                  
    {"role": CompanyRole}
 
    
-                    
-
    back to top @@ -77469,12 +76899,8 @@
    Fields
    Example
    - - - 
    {"company": Company}
+                  
    {"company": Company}
 
    
-                    
-
    back to top @@ -77513,12 +76939,8 @@
    Fields
    Example
    - - - 
    {"team": CompanyTeam}
+                  
    {"team": CompanyTeam}
 
    
-                    
-
    back to top @@ -77557,12 +76979,8 @@
    Fields
    Example
    - - - 
    {"user": Customer}
+                  
    {"user": Customer}
 
    
-                    
-
    back to top @@ -77632,21 +77050,17 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "dynamic_attributes": [
     GiftRegistryDynamicAttributeInput
   ],
   "event_name": "xyz789",
-  "message": "xyz789",
+  "message": "abc123",
   "privacy_settings": "PRIVATE",
   "shipping_address": GiftRegistryShippingAddressInput,
   "status": "ACTIVE"
 }
 
    
-                    
-
    back to top @@ -77698,16 +77112,12 @@
    Fields
    Example
    - - - 
    {
-  "gift_registry_item_uid": "4",
+                  
    {
+  "gift_registry_item_uid": 4,
   "note": "abc123",
   "quantity": 987.65
 }
 
    
-                    
-
    back to top @@ -77746,12 +77156,8 @@
    Fields
    Example
    - - - 
    {"gift_registry": GiftRegistry}
+                  
    {"gift_registry": GiftRegistry}
 
    
-                    
-
    back to top @@ -77790,12 +77196,8 @@
    Fields
    Example
    - - - 
    {"gift_registry": GiftRegistry}
+                  
    {"gift_registry": GiftRegistry}
 
    
-                    
-
    back to top @@ -77859,20 +77261,16 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "dynamic_attributes": [
     GiftRegistryDynamicAttributeInput
   ],
-  "email": "abc123",
-  "firstname": "abc123",
+  "email": "xyz789",
+  "firstname": "xyz789",
   "gift_registry_registrant_uid": 4,
-  "lastname": "xyz789"
+  "lastname": "abc123"
 }
 
    
-                    
-
    back to top @@ -77911,12 +77309,8 @@
    Fields
    Example
    - - - 
    {"gift_registry": GiftRegistry}
+                  
    {"gift_registry": GiftRegistry}
 
    
-                    
-
    back to top @@ -77955,12 +77349,8 @@
    Fields
    Example
    - - - 
    {"quote": NegotiableQuote}
+                  
    {"quote": NegotiableQuote}
 
    
-                    
-
    back to top @@ -78006,15 +77396,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "items": [NegotiableQuoteItemQuantityInput],
-  "quote_uid": "4"
+  "quote_uid": 4
 }
 
    
-                    
-
    back to top @@ -78053,12 +77439,8 @@
    Fields
    Example
    - - - 
    {"quote_template": NegotiableQuoteTemplate}
+                  
    {"quote_template": NegotiableQuoteTemplate}
 
    
-                    
-
    back to top @@ -78104,15 +77486,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "items": [NegotiableQuoteTemplateItemQuantityInput],
   "template_id": "4"
 }
 
    
-                    
-
    back to top @@ -78156,15 +77534,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "user_errors": [WishListUserInputError],
   "wishlist": Wishlist
 }
 
    
-                    
-
    back to top @@ -78240,20 +77614,16 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "applies_to": [4],
   "approvers": [4],
   "condition": CreatePurchaseOrderApprovalRuleConditionInput,
   "description": "abc123",
-  "name": "xyz789",
+  "name": "abc123",
   "status": "ENABLED",
-  "uid": "4"
+  "uid": 4
 }
 
    
-                    
-
    back to top @@ -78299,15 +77669,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "description": "abc123",
-  "name": "abc123"
+  "name": "xyz789"
 }
 
    
-                    
-
    back to top @@ -78365,17 +77731,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "entered_options": [EnteredOptionInput],
-  "item_id": 4,
+  "item_id": "4",
   "quantity": 123.45,
-  "selected_options": ["xyz789"]
+  "selected_options": ["abc123"]
 }
 
    
-                    
-
    back to top @@ -78414,12 +77776,8 @@
    Fields
    Example
    - - - 
    {"requisition_list": RequisitionList}
+                  
    {"requisition_list": RequisitionList}
 
    
-                    
-
    back to top @@ -78458,12 +77816,8 @@
    Fields
    Example
    - - - 
    {"requisition_list": RequisitionList}
+                  
    {"requisition_list": RequisitionList}
 
    
-                    
-
    back to top @@ -78512,16 +77866,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "name": "xyz789",
-  "uid": "4",
+  "uid": 4,
   "visibility": "PUBLIC"
 }
 
    
-                    
-
    back to top @@ -78573,16 +77923,12 @@
    Fields
    Example
    - - - 
    {
-  "currentPage": 987,
-  "pageSize": 123,
+                  
    {
+  "currentPage": 123,
+  "pageSize": 987,
   "sort": [CompaniesSortInput]
 }
 
    
-                    
-
    back to top @@ -78626,15 +77972,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "items": [CompanyBasicInfo],
   "page_info": SearchResultPageInfo
 }
 
    
-                    
-
    back to top @@ -78678,12 +78020,8 @@
    Fields
    Example
    - - - 
    {"message": "abc123", "type": "NOT_FOUND"}
+                  
    {"message": "xyz789", "type": "NOT_FOUND"}
 
    
-                    
-
    back to top @@ -78748,12 +78086,8 @@
    Values
    Example
    - - - 
    "NOT_FOUND"
+                  
    "NOT_FOUND"
 
    
-                    
-
    back to top @@ -78793,12 +78127,8 @@
    Fields
    Example
    - - - 
    {"purchase_order_uids": [4]}
+                  
    {"purchase_order_uids": [4]}
 
    
-                    
-
    back to top @@ -78842,15 +78172,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "errors": [ValidatePurchaseOrderError],
   "purchase_orders": [PurchaseOrder]
 }
 
    
-                    
-
    back to top @@ -78894,15 +78220,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "name": "DATE_RANGE_MAX",
   "value": "xyz789"
 }
 
    
-                    
-
    back to top @@ -78999,12 +78321,8 @@
    Values
    Example
    - - - 
    "DATE_RANGE_MAX"
+                  
    "DATE_RANGE_MAX"
 
    
-                    
-
    back to top @@ -79043,12 +78361,8 @@
    Fields
    Example
    - - - 
    {"credit_card": VaultCreditCardConfig}
+                  
    {"credit_card": VaultCreditCardConfig}
 
    
-                    
-
    back to top @@ -79093,16 +78407,12 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "is_vault_enabled": false,
   "sdk_params": [SDKParams],
   "three_ds_mode": "OFF"
 }
 
    
-                    
-
    back to top @@ -79160,17 +78470,13 @@
    Fields
    Example
    - - - 
    {
-  "payment_source": "xyz789",
-  "payments_order_id": "xyz789",
+                  
    {
+  "payment_source": "abc123",
+  "payments_order_id": "abc123",
   "paypal_order_id": "abc123",
   "public_hash": "abc123"
 }
 
    
-                    
-
    back to top @@ -79210,12 +78516,8 @@
    Fields
    Example
    - - - 
    {"payment_source": PaymentSourceInput}
+                  
    {"payment_source": PaymentSourceInput}
 
    
-                    
-
    back to top @@ -79263,15 +78565,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "date": "2007-12-03T10:15:30Z",
   "sku": "xyz789"
 }
 
    
-                    
-
    back to top @@ -79319,15 +78617,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "dateTime": "2007-12-03T10:15:30Z",
   "sku": "abc123"
 }
 
    
-                    
-
    back to top @@ -79432,17 +78726,15 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "custom_attributes": [CustomAttribute],
   "customizable_options": [SelectedCustomizableOption],
   "discount": [Discount],
   "errors": [CartItemError],
   "is_available": false,
-  "max_qty": 987.65,
-  "min_qty": 123.45,
-  "not_available_message": "abc123",
+  "max_qty": 123.45,
+  "min_qty": 987.65,
+  "not_available_message": "xyz789",
   "note_from_buyer": [ItemNote],
   "note_from_seller": [ItemNote],
   "prices": CartItemPrices,
@@ -79451,8 +78743,6 @@ 
    Example
    
   "uid": "4"
 }
 
    
-                    
-
    back to top @@ -79699,37 +78989,35 @@
    filters
    Example
    - - - 
    {
-  "canonical_url": "xyz789",
+                  
    {
+  "canonical_url": "abc123",
   "categories": [CategoryInterface],
-  "country_of_manufacture": "xyz789",
+  "country_of_manufacture": "abc123",
   "crosssell_products": [ProductInterface],
   "custom_attributesV2": ProductCustomAttributes,
   "description": ComplexTextValue,
   "gift_message_available": false,
-  "gift_wrapping_available": true,
+  "gift_wrapping_available": false,
   "gift_wrapping_price": Money,
   "image": ProductImage,
-  "is_returnable": "xyz789",
+  "is_returnable": "abc123",
   "manufacturer": 123,
   "max_sale_qty": 123.45,
   "media_gallery": [MediaGalleryInterface],
-  "meta_description": "abc123",
+  "meta_description": "xyz789",
   "meta_keyword": "abc123",
-  "meta_title": "xyz789",
-  "min_sale_qty": 987.65,
+  "meta_title": "abc123",
+  "min_sale_qty": 123.45,
   "name": "abc123",
-  "new_from_date": "abc123",
+  "new_from_date": "xyz789",
   "new_to_date": "xyz789",
-  "only_x_left_in_stock": 123.45,
+  "only_x_left_in_stock": 987.65,
   "options": [CustomizableOptionInterface],
-  "options_container": "abc123",
+  "options_container": "xyz789",
   "price_range": PriceRange,
   "price_tiers": [TierPrice],
   "product_links": [ProductLinksInterface],
-  "quantity": 987.65,
+  "quantity": 123.45,
   "related_products": [ProductInterface],
   "short_description": ComplexTextValue,
   "sku": "xyz789",
@@ -79737,15 +79025,13 @@ 
    Example
    
   "special_price": 123.45,
   "special_to_date": "xyz789",
   "stock_status": "IN_STOCK",
-  "swatch_image": "abc123",
+  "swatch_image": "xyz789",
   "thumbnail": ProductImage,
-  "uid": "4",
+  "uid": 4,
   "upsell_products": [ProductInterface],
-  "url_key": "xyz789"
+  "url_key": "abc123"
 }
 
    
-                    
-
    back to top @@ -79800,17 +79086,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "customizable_options": [SelectedCustomizableOption],
   "product": ProductInterface,
   "quantity": 987.65,
-  "uid": "4"
+  "uid": 4
 }
 
    
-                    
-
    back to top @@ -79875,19 +79157,15 @@
    Fields
    Example
    - - - 
    {
-  "added_at": "abc123",
+                  
    {
+  "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
   "description": "xyz789",
   "id": "4",
   "product": ProductInterface,
-  "quantity": 987.65
+  "quantity": 123.45
 }
 
    
-                    
-
    back to top @@ -79931,15 +79209,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "code": "PRODUCT_NOT_FOUND",
   "message": "abc123"
 }
 
    
-                    
-
    back to top @@ -79987,12 +79261,8 @@
    Values
    Example
    - - - 
    "PRODUCT_NOT_FOUND"
+                  
    "PRODUCT_NOT_FOUND"
 
    
-                    
-
    back to top @@ -80078,20 +79348,16 @@
    pageSize
    Example
    - - - 
    {
-  "id": "4",
-  "items_count": 987,
+                  
    {
+  "id": 4,
+  "items_count": 123,
   "items_v2": WishlistItems,
-  "name": "abc123",
-  "sharing_code": "xyz789",
+  "name": "xyz789",
+  "sharing_code": "abc123",
   "updated_at": "abc123",
   "visibility": "PUBLIC"
 }
 
    
-                    
-
    back to top @@ -80145,17 +79411,13 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "code": "PRODUCT_NOT_FOUND",
   "message": "abc123",
-  "wishlistId": "4",
+  "wishlistId": 4,
   "wishlistItemId": 4
 }
 
    
-                    
-
    back to top @@ -80210,6 +79472,13 @@
    Values
    + + +

    REQUIRED_PARAMETER_MISSING

    + + + + @@ -80217,12 +79486,8 @@
    Values
    Example
    - - - 
    "PRODUCT_NOT_FOUND"
+                  
    "PRODUCT_NOT_FOUND"
 
    
-                    
-
    back to top @@ -80268,15 +79533,8 @@
    Fields
    Example
    - - - 
    {
-  "quantity": 123.45,
-  "wishlist_item_id": "4"
-}
+                  
    {"quantity": 123.45, "wishlist_item_id": 4}
 
    
-                    
-
    back to top @@ -80340,18 +79598,14 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "entered_options": [EnteredOptionInput],
-  "parent_sku": "abc123",
+  "parent_sku": "xyz789",
   "quantity": 123.45,
   "selected_options": ["4"],
   "sku": "abc123"
 }
 
    
-                    
-
    back to top @@ -80463,19 +79717,15 @@
    Possible Types
    Example
    - - - 
    {
-  "added_at": "abc123",
+                  
    {
+  "added_at": "xyz789",
   "customizable_options": [SelectedCustomizableOption],
   "description": "abc123",
-  "id": "4",
+  "id": 4,
   "product": ProductInterface,
   "quantity": 123.45
 }
 
    
-                    
-
    back to top @@ -80521,12 +79771,8 @@
    Fields
    Example
    - - - 
    {"quantity": 123.45, "wishlist_item_id": 4}
+                  
    {"quantity": 987.65, "wishlist_item_id": 4}
 
    
-                    
-
    back to top @@ -80590,18 +79836,14 @@
    Fields
    Example
    - - - 
    {
-  "description": "abc123",
+                  
    {
+  "description": "xyz789",
   "entered_options": [EnteredOptionInput],
-  "quantity": 123.45,
-  "selected_options": [4],
-  "wishlist_item_id": 4
+  "quantity": 987.65,
+  "selected_options": ["4"],
+  "wishlist_item_id": "4"
 }
 
    
-                    
-
    back to top @@ -80645,15 +79887,11 @@
    Fields
    Example
    - - - 
    {
+                  
    {
   "items": [WishlistItemInterface],
   "page_info": SearchResultPageInfo
 }
 
    
-                    
-
    back to top @@ -80701,12 +79939,200 @@
    Values
    Example
    - - - 
    "PUBLIC"
+                  
    "PUBLIC"
+
    
+
    +
    + back to top + +
    +
    +
    + Types +
    +

    finishUploadInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + key - String! + The unique key identifier from the upload
    + media_resource_type - MediaResourceType! + The type of media resource being uploaded
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "key": "xyz789",
+  "media_resource_type": "NEGOTIABLE_QUOTE_ATTACHMENT"
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    finishUploadOutput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    key - String! + The unique key identifier
    message - String + Additional information about the confirmation
    success - Boolean! + Whether the confirmation was successful
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "key": "xyz789",
+  "message": "abc123",
+  "success": true
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    initiateUploadInput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + +
    Input FieldDescription
    + key - String! + The name of the file to be uploaded, cannot contain slashes
    + media_resource_type - MediaResourceType! + The type of media resource being uploaded
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "key": "abc123",
+  "media_resource_type": "NEGOTIABLE_QUOTE_ATTACHMENT"
+}
+
    +
    +
    + back to top +
    +
    +
    +
    + Types +
    +

    initiateUploadOutput

    +
    +
    +
    +
    Fields
    + + + + + + + + + + + + + + + + + + + + + +
    Field NameDescription
    expires_at - String! + The expiration timestamp of the URL
    key - String! + The unique key identifier for the upload
    upload_url - String! + The presigned URL for uploading the file
    +
    +
    +
    +
    +
    Example
    + 
    {
+  "expires_at": "xyz789",
+  "key": "xyz789",
+  "upload_url": "xyz789"
+}
    - -
    back to top diff --git a/yarn.lock b/yarn.lock index 0c8183880..90b8a434d 100644 --- a/yarn.lock +++ b/yarn.lock @@ -33,9 +33,9 @@ __metadata: languageName: node linkType: hard -"@adobe/gatsby-theme-aio@npm:4.15.3": - version: 4.15.3 - resolution: "@adobe/gatsby-theme-aio@npm:4.15.3" +"@adobe/gatsby-theme-aio@npm:4.15.5": + version: 4.15.5 + resolution: "@adobe/gatsby-theme-aio@npm:4.15.5" dependencies: "@adobe/focus-ring-polyfill": ^0.1.5 "@adobe/gatsby-source-github-file-contributors": ^0.3.1 @@ -131,7 +131,7 @@ __metadata: gatsby: ^4.22.0 react: ^17.0.2 react-dom: ^17.0.2 - checksum: b3d3ba8960bb3516bedd56f5da82a7d7f3b7b693496294ce914a32691c3c29b3036c415a1f03475b794172fb907f3a44565ffce27975bbc3c351b6bd8defee6c + checksum: 5184b9506d5aa9bacf8053db80529dbfd0524debece4b405dd993d949faa114fcb7b12cab7996c4962838c941b7c51913b8a4f38f47a4ce857cc13dd87710af8 languageName: node linkType: hard @@ -142,145 +142,154 @@ __metadata: languageName: node linkType: hard -"@algolia/cache-browser-local-storage@npm:4.14.2": - version: 4.14.2 - resolution: "@algolia/cache-browser-local-storage@npm:4.14.2" +"@algolia/cache-browser-local-storage@npm:4.25.3": + version: 4.25.3 + resolution: "@algolia/cache-browser-local-storage@npm:4.25.3" dependencies: - "@algolia/cache-common": 4.14.2 - checksum: e7d5f43ff01df5f21a2b5304b5d8f8ae25f2c6093e83e79556cb78ae07f342111ba77eba633b837b5b74a17293ea6a208acb1ade71782baafa9c2da7d58ee45c + "@algolia/cache-common": 4.25.3 + checksum: 8ac70c2e903c46cf0500ef11f7026746192c3332a9726beec60893f45ca26193043646d86dd0c51b6820d7c027ea3810474bad4b3043945084bf7c35aa7f8bcc languageName: node linkType: hard -"@algolia/cache-common@npm:4.14.2": - version: 4.14.2 - resolution: "@algolia/cache-common@npm:4.14.2" - checksum: 4fd04c714aee19f6eaaac4ae7e00e914a44473af9a84cf3c4260e436c6ea20f5590e05e9006d963372d84ce57268776811fcb929d79e0415b59d74779bd31ee7 +"@algolia/cache-common@npm:4.25.3": + version: 4.25.3 + resolution: "@algolia/cache-common@npm:4.25.3" + checksum: ca7634d9f82101ad08a01a5e2ab5ec454c18dc2e438ccdb0a2b45ab73a881d4fed95ef074b88a979a579a2cda22042b97ffb0d751f95c8e1b5a3e70f3ccf0434 languageName: node linkType: hard -"@algolia/cache-in-memory@npm:4.14.2": - version: 4.14.2 - resolution: "@algolia/cache-in-memory@npm:4.14.2" +"@algolia/cache-in-memory@npm:4.25.3": + version: 4.25.3 + resolution: "@algolia/cache-in-memory@npm:4.25.3" dependencies: - "@algolia/cache-common": 4.14.2 - checksum: d6981f812a368a38db21e52c98ec81a5c0eda5d896377f7bdcc04a0be1673ac9e184836d7973065fab84dc947a63fe959586468fc14b9a87e32f916959df6222 + "@algolia/cache-common": 4.25.3 + checksum: 2609e8c9858ef6e44784e33dbbe63e9a0447f1e333100eafc3b6e8f1c5bf1e32d9ee3f4fa5bf70b04be7d43e94ae4a2f756b188c0b02494e6c76e59cc6a86945 languageName: node linkType: hard -"@algolia/client-account@npm:4.14.2": - version: 4.14.2 - resolution: "@algolia/client-account@npm:4.14.2" +"@algolia/client-account@npm:4.25.3": + version: 4.25.3 + resolution: "@algolia/client-account@npm:4.25.3" dependencies: - "@algolia/client-common": 4.14.2 - "@algolia/client-search": 4.14.2 - "@algolia/transporter": 4.14.2 - checksum: 2e9eed5a4b8434775af87899bda8140d51eb2dd0cf08fc49370a4dc9541c220db9b241976dad14ae5d07a25f7ddafd9759a2eb462788f21a20f14e04968f98a4 + "@algolia/client-common": 4.25.3 + "@algolia/client-search": 4.25.3 + "@algolia/transporter": 4.25.3 + checksum: 6aff96f3fc0003b0fef1715df5230533f805f2bc29fd3295a4433f1254b6924113f44a8bbeb3007eab9930b87df40a084bc6c6f3c9ed34c71b3bf8a104f2b76e languageName: node linkType: hard -"@algolia/client-analytics@npm:4.14.2": - version: 4.14.2 - resolution: "@algolia/client-analytics@npm:4.14.2" +"@algolia/client-analytics@npm:4.25.3": + version: 4.25.3 + resolution: "@algolia/client-analytics@npm:4.25.3" dependencies: - "@algolia/client-common": 4.14.2 - "@algolia/client-search": 4.14.2 - "@algolia/requester-common": 4.14.2 - "@algolia/transporter": 4.14.2 - checksum: 61874e026c9d08dd628da443b5b34d1a3bb707a0283e727d94ee6d61057631039c5cf6303e6234cc6fbe84ff71c2758f952b664277715ca5761819aec73e7aad + "@algolia/client-common": 4.25.3 + "@algolia/client-search": 4.25.3 + "@algolia/requester-common": 4.25.3 + "@algolia/transporter": 4.25.3 + checksum: a887ec7b1b7a7eb4220c8cc33a9244821ba1016ce933991dc05b758248a92f8fbac1cdc0b68dfa09ef0e6ce8277c916549ad5f2b19d84ae11f614426cbd4f5bb languageName: node linkType: hard -"@algolia/client-common@npm:4.14.2": - version: 4.14.2 - resolution: "@algolia/client-common@npm:4.14.2" +"@algolia/client-common@npm:4.25.3": + version: 4.25.3 + resolution: "@algolia/client-common@npm:4.25.3" dependencies: - "@algolia/requester-common": 4.14.2 - "@algolia/transporter": 4.14.2 - checksum: da2be279ac51e1b43c02c6d2bbf0d9cc8b1cb3250ad10a803fca609bcfb8164a8adc21281b599fd8aa322c04deea77d2f07adcae1a363952559472e781e26c71 + "@algolia/requester-common": 4.25.3 + "@algolia/transporter": 4.25.3 + checksum: a3c128aa207206ccffee398e24df17dc4246f8e901123c885a001a5b4696a8222c6b5b2d96eb9b8763cf4d9a0a623aadc5900c67ea800a7ab8f14968b245cdfb languageName: node linkType: hard -"@algolia/client-personalization@npm:4.14.2": - version: 4.14.2 - resolution: "@algolia/client-personalization@npm:4.14.2" +"@algolia/client-personalization@npm:4.25.3": + version: 4.25.3 + resolution: "@algolia/client-personalization@npm:4.25.3" dependencies: - "@algolia/client-common": 4.14.2 - "@algolia/requester-common": 4.14.2 - "@algolia/transporter": 4.14.2 - checksum: 0dd25c84a40fe9853d14fadc3c8893e84bee370b5a3eb6730afe816afe1f92b970096d2dfb68073f606fa074fdeb66c3a73811d9a9a9774af5311f34d939fd72 + "@algolia/client-common": 4.25.3 + "@algolia/requester-common": 4.25.3 + "@algolia/transporter": 4.25.3 + checksum: 93c306cd4d1e672ac14f2ba4aa75274764a94c2415c738dad3ac5124fdd7fcfb070086f1a9b3e092770a35c74ccdd5b8d57f5f51ed9d8205927d0cdfe07bb92d languageName: node linkType: hard -"@algolia/client-search@npm:4.14.2": - version: 4.14.2 - resolution: "@algolia/client-search@npm:4.14.2" +"@algolia/client-search@npm:4.25.3": + version: 4.25.3 + resolution: "@algolia/client-search@npm:4.25.3" dependencies: - "@algolia/client-common": 4.14.2 - "@algolia/requester-common": 4.14.2 - "@algolia/transporter": 4.14.2 - checksum: 2695bc9e8c98badb601b915dbb075dd92996af350b0e4915a7a3b7825bd45f20815534debcfcb51bb7f682ba5d09f3c41918edb36e0a7f7bb154d3b205825f65 + "@algolia/client-common": 4.25.3 + "@algolia/requester-common": 4.25.3 + "@algolia/transporter": 4.25.3 + checksum: 1f557c11f14ee5f29518939b530358d7fc3d61ceb2998b8ab64bb00f8ec10e6d809843aac6f8e4da95e8aa2cad5e38860849ee03c4b081317e968a848e9b6965 languageName: node linkType: hard -"@algolia/logger-common@npm:4.14.2": - version: 4.14.2 - resolution: "@algolia/logger-common@npm:4.14.2" - checksum: a4000a98831d64c8d826ccece9f5f3a77bc000d93d74a7c6b51f186d3dfd96c0bb00934f70c69da8f3c4dfb9f30ce55ab59aca9ba79c3cc3e924597838a94429 +"@algolia/logger-common@npm:4.25.3": + version: 4.25.3 + resolution: "@algolia/logger-common@npm:4.25.3" + checksum: 4abeb7ee3cc694114dbfeb1d141aef31132c2877297ca1bb4a6b614a010e1972b9af339ea6755c0f15f07dff0416bcc0a3dc7df95604e2e7d150a472a3135001 languageName: node linkType: hard -"@algolia/logger-console@npm:4.14.2": - version: 4.14.2 - resolution: "@algolia/logger-console@npm:4.14.2" +"@algolia/logger-console@npm:4.25.3": + version: 4.25.3 + resolution: "@algolia/logger-console@npm:4.25.3" dependencies: - "@algolia/logger-common": 4.14.2 - checksum: 96c6209c7ef72cbc170b180f5b84c6523a5b6f4dea978c982577d2417eb19eb9c9ea3bc73089ced692a05bec141d66fd6d5401458d0aa162dbcace5017dbd127 + "@algolia/logger-common": 4.25.3 + checksum: c16fa88f865b812e75f32f83fc64c0a8615eecc532d9810a05be973e9a03619aad848e1f06c9701c469dd6f41dc56d15fecf65b23caffc693d11d24fa8200912 languageName: node linkType: hard -"@algolia/requester-browser-xhr@npm:4.14.2": - version: 4.14.2 - resolution: "@algolia/requester-browser-xhr@npm:4.14.2" +"@algolia/recommend@npm:4.25.3": + version: 4.25.3 + resolution: "@algolia/recommend@npm:4.25.3" dependencies: - "@algolia/requester-common": 4.14.2 - checksum: 7d8666e21cd0d15dc2e25f6917464c2f98cf73e0d2fced94cc6a3c4e97a990b8b93d9531bbf6f3b1ff2342b9ce9760d1dcb64dbbf61a5f2c31fe4f42541deef2 + "@algolia/cache-browser-local-storage": 4.25.3 + "@algolia/cache-common": 4.25.3 + "@algolia/cache-in-memory": 4.25.3 + "@algolia/client-common": 4.25.3 + "@algolia/client-search": 4.25.3 + "@algolia/logger-common": 4.25.3 + "@algolia/logger-console": 4.25.3 + "@algolia/requester-browser-xhr": 4.25.3 + "@algolia/requester-common": 4.25.3 + "@algolia/requester-node-http": 4.25.3 + "@algolia/transporter": 4.25.3 + checksum: d0cfd8e9e42566e7907363991a5364794ff4416321e6850056be4af4d325109b59b143de5470a058f8b575caefd0e2c11e7995c81e630af709cf854459383548 languageName: node linkType: hard -"@algolia/requester-common@npm:4.14.2": - version: 4.14.2 - resolution: "@algolia/requester-common@npm:4.14.2" - checksum: 7de4148a55db56fe2bf18c1359cccbc2f41031fe2bfbc945d75f143b854638c51e7ec2ef9c6dc69b38d5edb87cd096ce5d7087680da32825562db79026ea39cc +"@algolia/requester-browser-xhr@npm:4.25.3": + version: 4.25.3 + resolution: "@algolia/requester-browser-xhr@npm:4.25.3" + dependencies: + "@algolia/requester-common": 4.25.3 + checksum: 4ab763777f8c95d9d0e619cf1de0486657c781c06eb645ce0417d8ac9d7af3bc8c9c1ae83f91d18705374709eb33af5ad032956458665eb24e627b7cc77cf1b1 languageName: node linkType: hard -"@algolia/requester-node-http@npm:4.14.2": - version: 4.14.2 - resolution: "@algolia/requester-node-http@npm:4.14.2" - dependencies: - "@algolia/requester-common": 4.14.2 - checksum: 5f5fe8b040f73bd95c6bdb5b97396e078b629b2b4cd93fea671d545be375c79501c65296c34824f0ff8368b5b51edc7a6ad9e694b04223c1416dcda869c6f566 +"@algolia/requester-common@npm:4.25.3": + version: 4.25.3 + resolution: "@algolia/requester-common@npm:4.25.3" + checksum: 23fb0b35e38e76ccf7c0aaf4e77fc12bf11c980218b6679a256b6197460302b5812245342fd58c253410ac5c9d8fef4b553d94ed38ef5dbf7e86ad8a5d47fe2f languageName: node linkType: hard -"@algolia/transporter@npm:4.14.2": - version: 4.14.2 - resolution: "@algolia/transporter@npm:4.14.2" +"@algolia/requester-node-http@npm:4.25.3": + version: 4.25.3 + resolution: "@algolia/requester-node-http@npm:4.25.3" dependencies: - "@algolia/cache-common": 4.14.2 - "@algolia/logger-common": 4.14.2 - "@algolia/requester-common": 4.14.2 - checksum: 72c72013f3edb4d4484e7a43fb3c2555646ab04f422249514ed0309e20f41f5563f4c4dcf5623ca64c293624ecc74f87acaf2d9820e8c829cb5de067bdfe0257 + "@algolia/requester-common": 4.25.3 + checksum: cca62fbc6f8cff1c78c95b2a0337e0dcb1954c6537a863b4138ff46489a5a1381102698d63fea24f900290370fcd90f77cfb92e3ed80abd93cc45535897e0ec9 languageName: node linkType: hard -"@ampproject/remapping@npm:^2.1.0": - version: 2.2.0 - resolution: "@ampproject/remapping@npm:2.2.0" +"@algolia/transporter@npm:4.25.3": + version: 4.25.3 + resolution: "@algolia/transporter@npm:4.25.3" dependencies: - "@jridgewell/gen-mapping": ^0.1.0 - "@jridgewell/trace-mapping": ^0.3.9 - checksum: d74d170d06468913921d72430259424b7e4c826b5a7d39ff839a29d547efb97dc577caa8ba3fb5cf023624e9af9d09651afc3d4112a45e2050328abc9b3a2292 + "@algolia/cache-common": 4.25.3 + "@algolia/logger-common": 4.25.3 + "@algolia/requester-common": 4.25.3 + checksum: 8ad0097816d19d0bf76cdb351f66f92c6cb258396c060f2879c2acb758e47c5336725baeb267b95b993968f29a772f92f1d502beac94f50fceb3511c2e7d4ec5 languageName: node linkType: hard @@ -344,40 +353,21 @@ __metadata: languageName: node linkType: hard -"@babel/code-frame@npm:^7.0.0, @babel/code-frame@npm:^7.10.4, @babel/code-frame@npm:^7.14.0, @babel/code-frame@npm:^7.16.0, @babel/code-frame@npm:^7.18.6, @babel/code-frame@npm:^7.8.3": - version: 7.18.6 - resolution: "@babel/code-frame@npm:7.18.6" - dependencies: - "@babel/highlight": ^7.18.6 - checksum: 195e2be3172d7684bf95cff69ae3b7a15a9841ea9d27d3c843662d50cdd7d6470fd9c8e64be84d031117e4a4083486effba39f9aef6bbb2c89f7f21bcfba33ba - languageName: node - linkType: hard - -"@babel/code-frame@npm:^7.21.4, @babel/code-frame@npm:^7.24.7": - version: 7.24.7 - resolution: "@babel/code-frame@npm:7.24.7" +"@babel/code-frame@npm:^7.0.0, @babel/code-frame@npm:^7.10.4, @babel/code-frame@npm:^7.14.0, @babel/code-frame@npm:^7.16.0, @babel/code-frame@npm:^7.21.4, @babel/code-frame@npm:^7.27.1, @babel/code-frame@npm:^7.8.3": + version: 7.27.1 + resolution: "@babel/code-frame@npm:7.27.1" dependencies: - "@babel/highlight": ^7.24.7 - picocolors: ^1.0.0 - checksum: 830e62cd38775fdf84d612544251ce773d544a8e63df667728cc9e0126eeef14c6ebda79be0f0bc307e8318316b7f58c27ce86702e0a1f5c321d842eb38ffda4 - languageName: node - linkType: hard - -"@babel/code-frame@npm:^7.26.2": - version: 7.26.2 - resolution: "@babel/code-frame@npm:7.26.2" - dependencies: - "@babel/helper-validator-identifier": ^7.25.9 + "@babel/helper-validator-identifier": ^7.27.1 js-tokens: ^4.0.0 - picocolors: ^1.0.0 - checksum: db13f5c42d54b76c1480916485e6900748bbcb0014a8aca87f50a091f70ff4e0d0a6db63cade75eb41fcc3d2b6ba0a7f89e343def4f96f00269b41b8ab8dd7b8 + picocolors: ^1.1.1 + checksum: 5874edc5d37406c4a0bb14cf79c8e51ad412fb0423d176775ac14fc0259831be1bf95bdda9c2aa651126990505e09a9f0ed85deaa99893bc316d2682c5115bdc languageName: node linkType: hard -"@babel/compat-data@npm:^7.17.7, @babel/compat-data@npm:^7.20.0, @babel/compat-data@npm:^7.20.1": - version: 7.20.1 - resolution: "@babel/compat-data@npm:7.20.1" - checksum: 989b9b7a6fe43c547bb8329241bd0ba6983488b83d29cc59de35536272ee6bb4cc7487ba6c8a4bceebb3a57f8c5fea1434f80bbbe75202bc79bc1110f955ff25 +"@babel/compat-data@npm:^7.20.5, @babel/compat-data@npm:^7.27.2, @babel/compat-data@npm:^7.27.7, @babel/compat-data@npm:^7.28.5": + version: 7.28.5 + resolution: "@babel/compat-data@npm:7.28.5" + checksum: d7bcb3ee713752dc27b89800bfb39f9ac5f3edc46b4f5bb9906e1fe6b6110c7b245dd502602ea66f93790480c228605e9a601f27c07016f24b56772e97bedbdf languageName: node linkType: hard @@ -406,246 +396,168 @@ __metadata: linkType: hard "@babel/core@npm:^7.14.0, @babel/core@npm:^7.15.5": - version: 7.20.2 - resolution: "@babel/core@npm:7.20.2" - dependencies: - "@ampproject/remapping": ^2.1.0 - "@babel/code-frame": ^7.18.6 - "@babel/generator": ^7.20.2 - "@babel/helper-compilation-targets": ^7.20.0 - "@babel/helper-module-transforms": ^7.20.2 - "@babel/helpers": ^7.20.1 - "@babel/parser": ^7.20.2 - "@babel/template": ^7.18.10 - "@babel/traverse": ^7.20.1 - "@babel/types": ^7.20.2 - convert-source-map: ^1.7.0 + version: 7.28.5 + resolution: "@babel/core@npm:7.28.5" + dependencies: + "@babel/code-frame": ^7.27.1 + "@babel/generator": ^7.28.5 + "@babel/helper-compilation-targets": ^7.27.2 + "@babel/helper-module-transforms": ^7.28.3 + "@babel/helpers": ^7.28.4 + "@babel/parser": ^7.28.5 + "@babel/template": ^7.27.2 + "@babel/traverse": ^7.28.5 + "@babel/types": ^7.28.5 + "@jridgewell/remapping": ^2.3.5 + convert-source-map: ^2.0.0 debug: ^4.1.0 gensync: ^1.0.0-beta.2 - json5: ^2.2.1 - semver: ^6.3.0 - checksum: 98faaaef26103a276a30a141b951a93bc8418d100d1f668bf7a69d12f3e25df57958e8b6b9100d95663f720db62da85ade736f6629a5ebb1e640251a1b43c0e4 + json5: ^2.2.3 + semver: ^6.3.1 + checksum: 1ee35b20448f73e9d531091ad4f9e8198dc8f0cebb783263fbff1807342209882ddcaf419be04111326b6f0e494222f7055d71da316c437a6a784d230c11ab9f languageName: node linkType: hard "@babel/eslint-parser@npm:^7.15.4": - version: 7.19.1 - resolution: "@babel/eslint-parser@npm:7.19.1" + version: 7.28.5 + resolution: "@babel/eslint-parser@npm:7.28.5" dependencies: "@nicolo-ribaudo/eslint-scope-5-internals": 5.1.1-v1 eslint-visitor-keys: ^2.1.0 - semver: ^6.3.0 + semver: ^6.3.1 peerDependencies: - "@babel/core": ">=7.11.0" - eslint: ^7.5.0 || ^8.0.0 - checksum: 6d5360f62f25ed097250657deb1bc4c4f51a5f5f2fe456e98cda13727753fdf7a11a109b4cfa03ef0dd6ced3beaeb703b76193c1141e29434d1f91f1bac0517d - languageName: node - linkType: hard - -"@babel/generator@npm:^7.12.5, @babel/generator@npm:^7.14.0, @babel/generator@npm:^7.15.4, @babel/generator@npm:^7.16.8, @babel/generator@npm:^7.20.2": - version: 7.20.4 - resolution: "@babel/generator@npm:7.20.4" - dependencies: - "@babel/types": ^7.20.2 - "@jridgewell/gen-mapping": ^0.3.2 - jsesc: ^2.5.1 - checksum: 967b59f18e5ce999e5a741825bcecb2be4bbfc1824a92c21b47d0b5694e0eb09314a70f8b9142e9591c149c7fb83d51f73ae8fbd96d30a42666425889e51ceb1 + "@babel/core": ^7.11.0 + eslint: ^7.5.0 || ^8.0.0 || ^9.0.0 + checksum: 8daaf6f24d3f78c18bc4cf2bf1bedda3d829f330f385b85acf630adde3de7a703abf0d2615afea09244caa713dded01aa3c00f3637ea70568b2e8c547067fb99 languageName: node linkType: hard -"@babel/generator@npm:^7.24.8": - version: 7.24.10 - resolution: "@babel/generator@npm:7.24.10" +"@babel/generator@npm:^7.12.5, @babel/generator@npm:^7.14.0, @babel/generator@npm:^7.15.4, @babel/generator@npm:^7.16.8, @babel/generator@npm:^7.28.5": + version: 7.28.5 + resolution: "@babel/generator@npm:7.28.5" dependencies: - "@babel/types": ^7.24.9 - "@jridgewell/gen-mapping": ^0.3.5 - "@jridgewell/trace-mapping": ^0.3.25 - jsesc: ^2.5.1 - checksum: eb13806e9eb76932ea5205502a85ea650a991c7a6f757fbe859176f6d9b34b3da5a2c1f52a2c24fdbe0045a90438fe6889077e338cdd6c727619dee925af1ba6 + "@babel/parser": ^7.28.5 + "@babel/types": ^7.28.5 + "@jridgewell/gen-mapping": ^0.3.12 + "@jridgewell/trace-mapping": ^0.3.28 + jsesc: ^3.0.2 + checksum: 3e86fa0197bb33394a85a73dbbca92bb1b3f250a30294c7e327359c0978ad90f36f3d71c7f2965a3fc349cfa82becc8f87e7421c75796c8bc48dd9010dd866d1 languageName: node linkType: hard -"@babel/helper-annotate-as-pure@npm:^7.16.0, @babel/helper-annotate-as-pure@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/helper-annotate-as-pure@npm:7.18.6" +"@babel/helper-annotate-as-pure@npm:^7.22.5, @babel/helper-annotate-as-pure@npm:^7.27.1, @babel/helper-annotate-as-pure@npm:^7.27.3": + version: 7.27.3 + resolution: "@babel/helper-annotate-as-pure@npm:7.27.3" dependencies: - "@babel/types": ^7.18.6 - checksum: 88ccd15ced475ef2243fdd3b2916a29ea54c5db3cd0cfabf9d1d29ff6e63b7f7cd1c27264137d7a40ac2e978b9b9a542c332e78f40eb72abe737a7400788fc1b + "@babel/types": ^7.27.3 + checksum: 63863a5c936ef82b546ca289c9d1b18fabfc24da5c4ee382830b124e2e79b68d626207febc8d4bffc720f50b2ee65691d7d12cc0308679dee2cd6bdc926b7190 languageName: node linkType: hard -"@babel/helper-builder-binary-assignment-operator-visitor@npm:^7.18.6": - version: 7.18.9 - resolution: "@babel/helper-builder-binary-assignment-operator-visitor@npm:7.18.9" +"@babel/helper-compilation-targets@npm:^7.20.7, @babel/helper-compilation-targets@npm:^7.27.1, @babel/helper-compilation-targets@npm:^7.27.2": + version: 7.27.2 + resolution: "@babel/helper-compilation-targets@npm:7.27.2" dependencies: - "@babel/helper-explode-assignable-expression": ^7.18.6 - "@babel/types": ^7.18.9 - checksum: b4bc214cb56329daff6cc18a7f7a26aeafb55a1242e5362f3d47fe3808421f8c7cd91fff95d6b9b7ccb67e14e5a67d944e49dbe026942bfcbfda19b1c72a8e72 + "@babel/compat-data": ^7.27.2 + "@babel/helper-validator-option": ^7.27.1 + browserslist: ^4.24.0 + lru-cache: ^5.1.1 + semver: ^6.3.1 + checksum: 7b95328237de85d7af1dea010a4daa28e79f961dda48b652860d5893ce9b136fc8b9ea1f126d8e0a24963b09ba5c6631dcb907b4ce109b04452d34a6ae979807 languageName: node linkType: hard -"@babel/helper-compilation-targets@npm:^7.17.7, @babel/helper-compilation-targets@npm:^7.18.9, @babel/helper-compilation-targets@npm:^7.20.0": - version: 7.20.0 - resolution: "@babel/helper-compilation-targets@npm:7.20.0" +"@babel/helper-create-class-features-plugin@npm:^7.18.6, @babel/helper-create-class-features-plugin@npm:^7.27.1, @babel/helper-create-class-features-plugin@npm:^7.28.3, @babel/helper-create-class-features-plugin@npm:^7.28.5": + version: 7.28.5 + resolution: "@babel/helper-create-class-features-plugin@npm:7.28.5" dependencies: - "@babel/compat-data": ^7.20.0 - "@babel/helper-validator-option": ^7.18.6 - browserslist: ^4.21.3 - semver: ^6.3.0 + "@babel/helper-annotate-as-pure": ^7.27.3 + "@babel/helper-member-expression-to-functions": ^7.28.5 + "@babel/helper-optimise-call-expression": ^7.27.1 + "@babel/helper-replace-supers": ^7.27.1 + "@babel/helper-skip-transparent-expression-wrappers": ^7.27.1 + "@babel/traverse": ^7.28.5 + semver: ^6.3.1 peerDependencies: "@babel/core": ^7.0.0 - checksum: bc183f2109648849c8fde0b3c5cf08adf2f7ad6dc617b546fd20f34c8ef574ee5ee293c8d1bd0ed0221212e8f5907cdc2c42097870f1dcc769a654107d82c95b + checksum: 98f94a27bcde0cf0b847c41e1307057a1caddd131fb5fa0b1566e0c15ccc20b0ebab9667d782bffcd3eac9262226b18e86dcf30ab0f4dc5d14b1e1bf243aba49 languageName: node linkType: hard -"@babel/helper-create-class-features-plugin@npm:^7.18.6, @babel/helper-create-class-features-plugin@npm:^7.20.2": - version: 7.20.2 - resolution: "@babel/helper-create-class-features-plugin@npm:7.20.2" +"@babel/helper-create-regexp-features-plugin@npm:^7.18.6, @babel/helper-create-regexp-features-plugin@npm:^7.27.1": + version: 7.28.5 + resolution: "@babel/helper-create-regexp-features-plugin@npm:7.28.5" dependencies: - "@babel/helper-annotate-as-pure": ^7.18.6 - "@babel/helper-environment-visitor": ^7.18.9 - "@babel/helper-function-name": ^7.19.0 - "@babel/helper-member-expression-to-functions": ^7.18.9 - "@babel/helper-optimise-call-expression": ^7.18.6 - "@babel/helper-replace-supers": ^7.19.1 - "@babel/helper-split-export-declaration": ^7.18.6 + "@babel/helper-annotate-as-pure": ^7.27.3 + regexpu-core: ^6.3.1 + semver: ^6.3.1 peerDependencies: "@babel/core": ^7.0.0 - checksum: e89a8841db3f6340996f395fc372ee4bec361230eb9345b763314f768e68421d43461918fdedfb9a69b71f1d0433439f3e318d1b1b9ba04fbd7aac1c84959e37 + checksum: de202103e6ff8cd8da0d62eb269fcceb29857f3fa16173f0ff38188fd514e9ad4901aef1d590ff8ba25381644b42eaf70ad9ba91fda59fe7aa6a5e694cdde267 languageName: node linkType: hard -"@babel/helper-create-regexp-features-plugin@npm:^7.18.6, @babel/helper-create-regexp-features-plugin@npm:^7.19.0": - version: 7.19.0 - resolution: "@babel/helper-create-regexp-features-plugin@npm:7.19.0" - dependencies: - "@babel/helper-annotate-as-pure": ^7.18.6 - regexpu-core: ^5.1.0 - peerDependencies: - "@babel/core": ^7.0.0 - checksum: 811cc90afe9fc25a74ed37fc0c1361a4a91b0b940235dd3958e3f03b366d40a903b40fc93b51bcb93be774aba573219f8f215664bea1d1301f58797ca6854f3f - languageName: node - linkType: hard - -"@babel/helper-define-polyfill-provider@npm:^0.3.3": - version: 0.3.3 - resolution: "@babel/helper-define-polyfill-provider@npm:0.3.3" +"@babel/helper-define-polyfill-provider@npm:^0.6.5": + version: 0.6.5 + resolution: "@babel/helper-define-polyfill-provider@npm:0.6.5" dependencies: - "@babel/helper-compilation-targets": ^7.17.7 - "@babel/helper-plugin-utils": ^7.16.7 - debug: ^4.1.1 + "@babel/helper-compilation-targets": ^7.27.2 + "@babel/helper-plugin-utils": ^7.27.1 + debug: ^4.4.1 lodash.debounce: ^4.0.8 - resolve: ^1.14.2 - semver: ^6.1.2 + resolve: ^1.22.10 peerDependencies: - "@babel/core": ^7.4.0-0 - checksum: 8e3fe75513302e34f6d92bd67b53890e8545e6c5bca8fe757b9979f09d68d7e259f6daea90dc9e01e332c4f8781bda31c5fe551c82a277f9bc0bec007aed497c - languageName: node - linkType: hard - -"@babel/helper-environment-visitor@npm:^7.18.9": - version: 7.18.9 - resolution: "@babel/helper-environment-visitor@npm:7.18.9" - checksum: b25101f6162ddca2d12da73942c08ad203d7668e06663df685634a8fde54a98bc015f6f62938e8554457a592a024108d45b8f3e651fd6dcdb877275b73cc4420 - languageName: node - linkType: hard - -"@babel/helper-environment-visitor@npm:^7.24.7": - version: 7.24.7 - resolution: "@babel/helper-environment-visitor@npm:7.24.7" - dependencies: - "@babel/types": ^7.24.7 - checksum: 079d86e65701b29ebc10baf6ed548d17c19b808a07aa6885cc141b690a78581b180ee92b580d755361dc3b16adf975b2d2058b8ce6c86675fcaf43cf22f2f7c6 - languageName: node - linkType: hard - -"@babel/helper-explode-assignable-expression@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/helper-explode-assignable-expression@npm:7.18.6" - dependencies: - "@babel/types": ^7.18.6 - checksum: 225cfcc3376a8799023d15dc95000609e9d4e7547b29528c7f7111a0e05493ffb12c15d70d379a0bb32d42752f340233c4115bded6d299bc0c3ab7a12be3d30f - languageName: node - linkType: hard - -"@babel/helper-function-name@npm:^7.18.9, @babel/helper-function-name@npm:^7.19.0": - version: 7.19.0 - resolution: "@babel/helper-function-name@npm:7.19.0" - dependencies: - "@babel/template": ^7.18.10 - "@babel/types": ^7.19.0 - checksum: eac1f5db428ba546270c2b8d750c24eb528b8fcfe50c81de2e0bdebf0e20f24bec688d4331533b782e4a907fad435244621ca2193cfcf80a86731299840e0f6e - languageName: node - linkType: hard - -"@babel/helper-function-name@npm:^7.24.7": - version: 7.24.7 - resolution: "@babel/helper-function-name@npm:7.24.7" - dependencies: - "@babel/template": ^7.24.7 - "@babel/types": ^7.24.7 - checksum: 142ee08922074dfdc0ff358e09ef9f07adf3671ab6eef4fca74dcf7a551f1a43717e7efa358c9e28d7eea84c28d7f177b7a58c70452fc312ae3b1893c5dab2a4 - languageName: node - linkType: hard - -"@babel/helper-hoist-variables@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/helper-hoist-variables@npm:7.18.6" - dependencies: - "@babel/types": ^7.18.6 - checksum: fd9c35bb435fda802bf9ff7b6f2df06308a21277c6dec2120a35b09f9de68f68a33972e2c15505c1a1a04b36ec64c9ace97d4a9e26d6097b76b4396b7c5fa20f + "@babel/core": ^7.4.0 || ^8.0.0-0 <8.0.0 + checksum: 9fd3b09b209c8ed0d3d8bc1f494f1368b9e1f6e46195af4ce948630fe97d7dafde4882eedace270b319bf6555ddf35e220c77505f6d634f621766cdccbba0aae languageName: node linkType: hard -"@babel/helper-hoist-variables@npm:^7.24.7": - version: 7.24.7 - resolution: "@babel/helper-hoist-variables@npm:7.24.7" - dependencies: - "@babel/types": ^7.24.7 - checksum: 6cfdcf2289cd12185dcdbdf2435fa8d3447b797ac75851166de9fc8503e2fd0021db6baf8dfbecad3753e582c08e6a3f805c8d00cbed756060a877d705bd8d8d +"@babel/helper-globals@npm:^7.28.0": + version: 7.28.0 + resolution: "@babel/helper-globals@npm:7.28.0" + checksum: d8d7b91c12dad1ee747968af0cb73baf91053b2bcf78634da2c2c4991fb45ede9bd0c8f9b5f3254881242bc0921218fcb7c28ae885477c25177147e978ce4397 languageName: node linkType: hard -"@babel/helper-member-expression-to-functions@npm:^7.18.9": - version: 7.18.9 - resolution: "@babel/helper-member-expression-to-functions@npm:7.18.9" +"@babel/helper-member-expression-to-functions@npm:^7.27.1, @babel/helper-member-expression-to-functions@npm:^7.28.5": + version: 7.28.5 + resolution: "@babel/helper-member-expression-to-functions@npm:7.28.5" dependencies: - "@babel/types": ^7.18.9 - checksum: fcf8184e3b55051c4286b2cbedf0eccc781d0f3c9b5cbaba582eca19bf0e8d87806cdb7efc8554fcb969ceaf2b187d5ea748d40022d06ec7739fbb18c1b19a7a + "@babel/traverse": ^7.28.5 + "@babel/types": ^7.28.5 + checksum: 447d385233bae2eea713df1785f819b5a5ca272950740da123c42d23f491045120f0fbbb5609c091f7a9bbd40f289a442846dde0cb1bf0c59440fa093690cf7c languageName: node linkType: hard -"@babel/helper-module-imports@npm:^7.0.0, @babel/helper-module-imports@npm:^7.0.0-beta.49, @babel/helper-module-imports@npm:^7.16.0, @babel/helper-module-imports@npm:^7.16.7, @babel/helper-module-imports@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/helper-module-imports@npm:7.18.6" +"@babel/helper-module-imports@npm:^7.0.0, @babel/helper-module-imports@npm:^7.0.0-beta.49, @babel/helper-module-imports@npm:^7.16.7, @babel/helper-module-imports@npm:^7.22.5, @babel/helper-module-imports@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/helper-module-imports@npm:7.27.1" dependencies: - "@babel/types": ^7.18.6 - checksum: f393f8a3b3304b1b7a288a38c10989de754f01d29caf62ce7c4e5835daf0a27b81f3ac687d9d2780d39685aae7b55267324b512150e7b2be967b0c493b6a1def + "@babel/traverse": ^7.27.1 + "@babel/types": ^7.27.1 + checksum: 92d01c71c0e4aacdc2babce418a9a1a27a8f7d770a210ffa0f3933f321befab18b655bc1241bebc40767516731de0b85639140c42e45a8210abe1e792f115b28 languageName: node linkType: hard -"@babel/helper-module-transforms@npm:^7.12.1, @babel/helper-module-transforms@npm:^7.18.6, @babel/helper-module-transforms@npm:^7.19.6, @babel/helper-module-transforms@npm:^7.20.2": - version: 7.20.2 - resolution: "@babel/helper-module-transforms@npm:7.20.2" +"@babel/helper-module-transforms@npm:^7.12.1, @babel/helper-module-transforms@npm:^7.27.1, @babel/helper-module-transforms@npm:^7.28.3": + version: 7.28.3 + resolution: "@babel/helper-module-transforms@npm:7.28.3" dependencies: - "@babel/helper-environment-visitor": ^7.18.9 - "@babel/helper-module-imports": ^7.18.6 - "@babel/helper-simple-access": ^7.20.2 - "@babel/helper-split-export-declaration": ^7.18.6 - "@babel/helper-validator-identifier": ^7.19.1 - "@babel/template": ^7.18.10 - "@babel/traverse": ^7.20.1 - "@babel/types": ^7.20.2 - checksum: 33a60ca115f6fce2c9d98e2a2e5649498aa7b23e2ae3c18745d7a021487708fc311458c33542f299387a0da168afccba94116e077f2cce49ae9e5ab83399e8a2 + "@babel/helper-module-imports": ^7.27.1 + "@babel/helper-validator-identifier": ^7.27.1 + "@babel/traverse": ^7.28.3 + peerDependencies: + "@babel/core": ^7.0.0 + checksum: 7cf7b79da0fa626d6c84bfc7b35c079a2559caecaa2ff645b0f1db0d741507aa4df6b5b98a3283e8ac4e89094af271d805bf5701e5c4f916e622797b7c8cbb18 languageName: node linkType: hard -"@babel/helper-optimise-call-expression@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/helper-optimise-call-expression@npm:7.18.6" +"@babel/helper-optimise-call-expression@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/helper-optimise-call-expression@npm:7.27.1" dependencies: - "@babel/types": ^7.18.6 - checksum: e518fe8418571405e21644cfb39cf694f30b6c47b10b006609a92469ae8b8775cbff56f0b19732343e2ea910641091c5a2dc73b56ceba04e116a33b0f8bd2fbd + "@babel/types": ^7.27.1 + checksum: 0fb7ee824a384529d6b74f8a58279f9b56bfe3cce332168067dddeab2552d8eeb56dc8eaf86c04a3a09166a316cb92dfc79c4c623cd034ad4c563952c98b464f languageName: node linkType: hard @@ -656,238 +568,174 @@ __metadata: languageName: node linkType: hard -"@babel/helper-plugin-utils@npm:^7.0.0, @babel/helper-plugin-utils@npm:^7.10.4, @babel/helper-plugin-utils@npm:^7.12.13, @babel/helper-plugin-utils@npm:^7.14.0, @babel/helper-plugin-utils@npm:^7.14.5, @babel/helper-plugin-utils@npm:^7.16.7, @babel/helper-plugin-utils@npm:^7.18.6, @babel/helper-plugin-utils@npm:^7.18.9, @babel/helper-plugin-utils@npm:^7.19.0, @babel/helper-plugin-utils@npm:^7.20.2, @babel/helper-plugin-utils@npm:^7.8.0, @babel/helper-plugin-utils@npm:^7.8.3": - version: 7.20.2 - resolution: "@babel/helper-plugin-utils@npm:7.20.2" - checksum: f6cae53b7fdb1bf3abd50fa61b10b4470985b400cc794d92635da1e7077bb19729f626adc0741b69403d9b6e411cddddb9c0157a709cc7c4eeb41e663be5d74b +"@babel/helper-plugin-utils@npm:^7.0.0, @babel/helper-plugin-utils@npm:^7.10.4, @babel/helper-plugin-utils@npm:^7.12.13, @babel/helper-plugin-utils@npm:^7.14.0, @babel/helper-plugin-utils@npm:^7.14.5, @babel/helper-plugin-utils@npm:^7.16.7, @babel/helper-plugin-utils@npm:^7.18.6, @babel/helper-plugin-utils@npm:^7.20.2, @babel/helper-plugin-utils@npm:^7.27.1, @babel/helper-plugin-utils@npm:^7.8.0": + version: 7.27.1 + resolution: "@babel/helper-plugin-utils@npm:7.27.1" + checksum: 5d715055301badab62bdb2336075a77f8dc8bd290cad2bc1b37ea3bf1b3efc40594d308082229f239deb4d6b5b80b0a73bce000e595ea74416e0339c11037047 languageName: node linkType: hard -"@babel/helper-remap-async-to-generator@npm:^7.18.6, @babel/helper-remap-async-to-generator@npm:^7.18.9": - version: 7.18.9 - resolution: "@babel/helper-remap-async-to-generator@npm:7.18.9" +"@babel/helper-remap-async-to-generator@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/helper-remap-async-to-generator@npm:7.27.1" dependencies: - "@babel/helper-annotate-as-pure": ^7.18.6 - "@babel/helper-environment-visitor": ^7.18.9 - "@babel/helper-wrap-function": ^7.18.9 - "@babel/types": ^7.18.9 + "@babel/helper-annotate-as-pure": ^7.27.1 + "@babel/helper-wrap-function": ^7.27.1 + "@babel/traverse": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0 - checksum: 4be6076192308671b046245899b703ba090dbe7ad03e0bea897bb2944ae5b88e5e85853c9d1f83f643474b54c578d8ac0800b80341a86e8538264a725fbbefec - languageName: node - linkType: hard - -"@babel/helper-replace-supers@npm:^7.18.6, @babel/helper-replace-supers@npm:^7.19.1": - version: 7.19.1 - resolution: "@babel/helper-replace-supers@npm:7.19.1" - dependencies: - "@babel/helper-environment-visitor": ^7.18.9 - "@babel/helper-member-expression-to-functions": ^7.18.9 - "@babel/helper-optimise-call-expression": ^7.18.6 - "@babel/traverse": ^7.19.1 - "@babel/types": ^7.19.0 - checksum: a0e4bf79ebe7d2bb5947169e47a0b4439c73fb0ec57d446cf3ea81b736721129ec373c3f94d2ebd2716b26dd65f8e6c083dac898170d42905e7ba815a2f52c25 - languageName: node - linkType: hard - -"@babel/helper-simple-access@npm:^7.19.4, @babel/helper-simple-access@npm:^7.20.2": - version: 7.20.2 - resolution: "@babel/helper-simple-access@npm:7.20.2" - dependencies: - "@babel/types": ^7.20.2 - checksum: ad1e96ee2e5f654ffee2369a586e5e8d2722bf2d8b028a121b4c33ebae47253f64d420157b9f0a8927aea3a9e0f18c0103e74fdd531815cf3650a0a4adca11a1 - languageName: node - linkType: hard - -"@babel/helper-skip-transparent-expression-wrappers@npm:^7.18.9": - version: 7.20.0 - resolution: "@babel/helper-skip-transparent-expression-wrappers@npm:7.20.0" - dependencies: - "@babel/types": ^7.20.0 - checksum: 34da8c832d1c8a546e45d5c1d59755459ffe43629436707079989599b91e8c19e50e73af7a4bd09c95402d389266731b0d9c5f69e372d8ebd3a709c05c80d7dd + checksum: 0747397ba013f87dbf575454a76c18210d61c7c9af0f697546b4bcac670b54ddc156330234407b397f0c948738c304c228e0223039bc45eab4fbf46966a5e8cc languageName: node linkType: hard -"@babel/helper-split-export-declaration@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/helper-split-export-declaration@npm:7.18.6" +"@babel/helper-replace-supers@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/helper-replace-supers@npm:7.27.1" dependencies: - "@babel/types": ^7.18.6 - checksum: c6d3dede53878f6be1d869e03e9ffbbb36f4897c7cc1527dc96c56d127d834ffe4520a6f7e467f5b6f3c2843ea0e81a7819d66ae02f707f6ac057f3d57943a2b + "@babel/helper-member-expression-to-functions": ^7.27.1 + "@babel/helper-optimise-call-expression": ^7.27.1 + "@babel/traverse": ^7.27.1 + peerDependencies: + "@babel/core": ^7.0.0 + checksum: 3690266c304f21008690ba68062f889a363583cabc13c3d033b94513953147af3e0a3fdb48fa1bb9fa3734b64e221fc65e5222ab70837f02321b7225f487c6ef languageName: node linkType: hard -"@babel/helper-split-export-declaration@npm:^7.24.7": - version: 7.24.7 - resolution: "@babel/helper-split-export-declaration@npm:7.24.7" +"@babel/helper-skip-transparent-expression-wrappers@npm:^7.20.0, @babel/helper-skip-transparent-expression-wrappers@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/helper-skip-transparent-expression-wrappers@npm:7.27.1" dependencies: - "@babel/types": ^7.24.7 - checksum: e3ddc91273e5da67c6953f4aa34154d005a00791dc7afa6f41894e768748540f6ebcac5d16e72541aea0c89bee4b89b4da6a3d65972a0ea8bfd2352eda5b7e22 + "@babel/traverse": ^7.27.1 + "@babel/types": ^7.27.1 + checksum: 4f380c5d0e0769fa6942a468b0c2d7c8f0c438f941aaa88f785f8752c103631d0904c7b4e76207a3b0e6588b2dec376595370d92ca8f8f1b422c14a69aa146d4 languageName: node linkType: hard -"@babel/helper-string-parser@npm:^7.19.4": - version: 7.19.4 - resolution: "@babel/helper-string-parser@npm:7.19.4" - checksum: b2f8a3920b30dfac81ec282ac4ad9598ea170648f8254b10f475abe6d944808fb006aab325d3eb5a8ad3bea8dfa888cfa6ef471050dae5748497c110ec060943 +"@babel/helper-string-parser@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/helper-string-parser@npm:7.27.1" + checksum: 0a8464adc4b39b138aedcb443b09f4005d86207d7126e5e079177e05c3116107d856ec08282b365e9a79a9872f40f4092a6127f8d74c8a01c1ef789dacfc25d6 languageName: node linkType: hard -"@babel/helper-string-parser@npm:^7.24.8": - version: 7.24.8 - resolution: "@babel/helper-string-parser@npm:7.24.8" - checksum: 39b03c5119216883878655b149148dc4d2e284791e969b19467a9411fccaa33f7a713add98f4db5ed519535f70ad273cdadfd2eb54d47ebbdeac5083351328ce +"@babel/helper-validator-identifier@npm:^7.25.9, @babel/helper-validator-identifier@npm:^7.27.1, @babel/helper-validator-identifier@npm:^7.28.5": + version: 7.28.5 + resolution: "@babel/helper-validator-identifier@npm:7.28.5" + checksum: 5a251a6848e9712aea0338f659a1a3bd334d26219d5511164544ca8ec20774f098c3a6661e9da65a0d085c745c00bb62c8fada38a62f08fa1f8053bc0aeb57e4 languageName: node linkType: hard -"@babel/helper-string-parser@npm:^7.25.9": - version: 7.25.9 - resolution: "@babel/helper-string-parser@npm:7.25.9" - checksum: 6435ee0849e101681c1849868278b5aee82686ba2c1e27280e5e8aca6233af6810d39f8e4e693d2f2a44a3728a6ccfd66f72d71826a94105b86b731697cdfa99 +"@babel/helper-validator-option@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/helper-validator-option@npm:7.27.1" + checksum: db73e6a308092531c629ee5de7f0d04390835b21a263be2644276cb27da2384b64676cab9f22cd8d8dbd854c92b1d7d56fc8517cf0070c35d1c14a8c828b0903 languageName: node linkType: hard -"@babel/helper-validator-identifier@npm:^7.18.6, @babel/helper-validator-identifier@npm:^7.19.1": - version: 7.19.1 - resolution: "@babel/helper-validator-identifier@npm:7.19.1" - checksum: 0eca5e86a729162af569b46c6c41a63e18b43dbe09fda1d2a3c8924f7d617116af39cac5e4cd5d431bb760b4dca3c0970e0c444789b1db42bcf1fa41fbad0a3a - languageName: node - linkType: hard - -"@babel/helper-validator-identifier@npm:^7.24.7": - version: 7.24.7 - resolution: "@babel/helper-validator-identifier@npm:7.24.7" - checksum: 6799ab117cefc0ecd35cd0b40ead320c621a298ecac88686a14cffceaac89d80cdb3c178f969861bf5fa5e4f766648f9161ea0752ecfe080d8e89e3147270257 - languageName: node - linkType: hard - -"@babel/helper-validator-identifier@npm:^7.25.9": - version: 7.25.9 - resolution: "@babel/helper-validator-identifier@npm:7.25.9" - checksum: 5b85918cb1a92a7f3f508ea02699e8d2422fe17ea8e82acd445006c0ef7520fbf48e3dbcdaf7b0a1d571fc3a2715a29719e5226636cb6042e15fe6ed2a590944 - languageName: node - linkType: hard - -"@babel/helper-validator-option@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/helper-validator-option@npm:7.18.6" - checksum: f9cc6eb7cc5d759c5abf006402180f8d5e4251e9198197428a97e05d65eb2f8ae5a0ce73b1dfd2d35af41d0eb780627a64edf98a4e71f064eeeacef8de58f2cf - languageName: node - linkType: hard - -"@babel/helper-wrap-function@npm:^7.18.9": - version: 7.19.0 - resolution: "@babel/helper-wrap-function@npm:7.19.0" +"@babel/helper-wrap-function@npm:^7.27.1": + version: 7.28.3 + resolution: "@babel/helper-wrap-function@npm:7.28.3" dependencies: - "@babel/helper-function-name": ^7.19.0 - "@babel/template": ^7.18.10 - "@babel/traverse": ^7.19.0 - "@babel/types": ^7.19.0 - checksum: 2453a6b134f12cc779179188c4358a66252c29b634a8195c0cf626e17f9806c3c4c40e159cd8056c2ec82b69b9056a088014fa43d6ccc1aca67da8d9605da8fd + "@babel/template": ^7.27.2 + "@babel/traverse": ^7.28.3 + "@babel/types": ^7.28.2 + checksum: 0ebdfdc918fdd0c1cf6ff15ba4c664974d0cdf21a017af560d58b00c379df3bf2e55f13a44fe3225668bca169da174f6cb97a96c4e987fb728fdb8f9a39db302 languageName: node linkType: hard -"@babel/helpers@npm:^7.12.5, @babel/helpers@npm:^7.20.1": - version: 7.26.10 - resolution: "@babel/helpers@npm:7.26.10" +"@babel/helpers@npm:^7.12.5, @babel/helpers@npm:^7.28.4": + version: 7.28.4 + resolution: "@babel/helpers@npm:7.28.4" dependencies: - "@babel/template": ^7.26.9 - "@babel/types": ^7.26.10 - checksum: daa3689024a4fc5e024fea382915c6fb0fde15cf1b2f6093435725c79edccbef7646d4a656b199c046ff5c61846d1b3876d6096b7bf0635823de6aaff2a1e1a4 + "@babel/template": ^7.27.2 + "@babel/types": ^7.28.4 + checksum: a8706219e0bd60c18bbb8e010aa122e9b14e7e7e67c21cc101e6f1b5e79dcb9a18d674f655997f85daaf421aa138cf284710bb04371a2255a0a3137f097430b4 languageName: node linkType: hard -"@babel/highlight@npm:^7.10.4, @babel/highlight@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/highlight@npm:7.18.6" - dependencies: - "@babel/helper-validator-identifier": ^7.18.6 - chalk: ^2.0.0 - js-tokens: ^4.0.0 - checksum: 92d8ee61549de5ff5120e945e774728e5ccd57fd3b2ed6eace020ec744823d4a98e242be1453d21764a30a14769ecd62170fba28539b211799bbaf232bbb2789 - languageName: node - linkType: hard - -"@babel/highlight@npm:^7.24.7": - version: 7.24.7 - resolution: "@babel/highlight@npm:7.24.7" +"@babel/highlight@npm:^7.10.4": + version: 7.25.9 + resolution: "@babel/highlight@npm:7.25.9" dependencies: - "@babel/helper-validator-identifier": ^7.24.7 + "@babel/helper-validator-identifier": ^7.25.9 chalk: ^2.4.2 js-tokens: ^4.0.0 picocolors: ^1.0.0 - checksum: 5cd3a89f143671c4ac129960024ba678b669e6fc673ce078030f5175002d1d3d52bc10b22c5b916a6faf644b5028e9a4bd2bb264d053d9b05b6a98690f1d46f1 + checksum: a6e0ac0a1c4bef7401915ca3442ab2b7ae4adf360262ca96b91396bfb9578abb28c316abf5e34460b780696db833b550238d9256bdaca60fade4ba7a67645064 languageName: node linkType: hard -"@babel/parser@npm:^7.12.7, @babel/parser@npm:^7.14.0, @babel/parser@npm:^7.15.5, @babel/parser@npm:^7.16.8, @babel/parser@npm:^7.18.10, @babel/parser@npm:^7.20.2": - version: 7.20.3 - resolution: "@babel/parser@npm:7.20.3" +"@babel/parser@npm:^7.12.7, @babel/parser@npm:^7.14.0, @babel/parser@npm:^7.15.5, @babel/parser@npm:^7.16.8, @babel/parser@npm:^7.27.2, @babel/parser@npm:^7.28.5": + version: 7.28.5 + resolution: "@babel/parser@npm:7.28.5" + dependencies: + "@babel/types": ^7.28.5 bin: parser: ./bin/babel-parser.js - checksum: 33bcdb45de65a3cf27ed376cb34f32be3c3485a10e3252f8d0126f6a034efc3145c0d219e57fcd5a8956361552008bc30b9bae4a723823fb3633027071be8a45 + checksum: 5c2456e3f26c70d4a3ce1a220b529a91a2df26c54a2894fd0dea2342699ea1067ffdda9f0715eeab61da46ff546fd5661bc70be6d8d11977cbe21f5f0478819a languageName: node linkType: hard -"@babel/parser@npm:^7.24.7, @babel/parser@npm:^7.24.8": - version: 7.24.8 - resolution: "@babel/parser@npm:7.24.8" - bin: - parser: ./bin/babel-parser.js - checksum: 76f866333bfbd53800ac027419ae523bb0137fc63daa968232eb780e4390136bb6e497cb4a2cf6051a2c318aa335c2e6d2adc17079d60691ae7bde89b28c5688 +"@babel/plugin-bugfix-firefox-class-in-computed-class-key@npm:^7.28.5": + version: 7.28.5 + resolution: "@babel/plugin-bugfix-firefox-class-in-computed-class-key@npm:7.28.5" + dependencies: + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/traverse": ^7.28.5 + peerDependencies: + "@babel/core": ^7.0.0 + checksum: 749b40a963d5633f554cad0336245cb6c1c1393c70a3fddcf302d86a1a42b35efdd2ed62056b88db66f3900887ae1cee9a3eeec89799c22e0cf65059f0dfd142 languageName: node linkType: hard -"@babel/parser@npm:^7.26.9": - version: 7.26.10 - resolution: "@babel/parser@npm:7.26.10" +"@babel/plugin-bugfix-safari-class-field-initializer-scope@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-bugfix-safari-class-field-initializer-scope@npm:7.27.1" dependencies: - "@babel/types": ^7.26.10 - bin: - parser: ./bin/babel-parser.js - checksum: 81f9af962aea55a2973d213dffc6191939df7eba0511ba585d23f0d838931f5fca2efb83ae382e4b9bb486f20ae1b2607cb1b8be49af89e9f011fb4355727f47 + "@babel/helper-plugin-utils": ^7.27.1 + peerDependencies: + "@babel/core": ^7.0.0 + checksum: eb7f4146dc01f1198ce559a90b077e58b951a07521ec414e3c7d4593bf6c4ab5c2af22242a7e9fec085e20299e0ba6ea97f44a45e84ab148141bf9eb959ad25e languageName: node linkType: hard -"@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression@npm:7.18.6" +"@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.6 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0 - checksum: 845bd280c55a6a91d232cfa54eaf9708ec71e594676fe705794f494bb8b711d833b752b59d1a5c154695225880c23dbc9cab0e53af16fd57807976cd3ff41b8d + checksum: 621cfddfcc99a81e74f8b6f9101fd260b27500cb1a568e3ceae9cc8afe9aee45ac3bca3900a2b66c612b1a2366d29ef67d4df5a1c975be727eaad6906f98c2c6 languageName: node linkType: hard -"@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining@npm:^7.18.9": - version: 7.18.9 - resolution: "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining@npm:7.18.9" +"@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.9 - "@babel/helper-skip-transparent-expression-wrappers": ^7.18.9 - "@babel/plugin-proposal-optional-chaining": ^7.18.9 + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/helper-skip-transparent-expression-wrappers": ^7.27.1 + "@babel/plugin-transform-optional-chaining": ^7.27.1 peerDependencies: "@babel/core": ^7.13.0 - checksum: 93abb5cb179a13db171bfc2cdf79489598f43c50cc174f97a2b7bb1d44d24ade7109665a20cf4e317ad6c1c730f036f06478f7c7e789b4240be1abdb60d6452f + checksum: f07aa80272bd7a46b7ba11a4644da6c9b6a5a64e848dfaffdad6f02663adefd512e1aaebe664c4dd95f7ed4f80c872c7f8db8d8e34b47aae0930b412a28711a0 languageName: node linkType: hard -"@babel/plugin-proposal-async-generator-functions@npm:^7.20.1": - version: 7.20.1 - resolution: "@babel/plugin-proposal-async-generator-functions@npm:7.20.1" +"@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly@npm:^7.28.3": + version: 7.28.3 + resolution: "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly@npm:7.28.3" dependencies: - "@babel/helper-environment-visitor": ^7.18.9 - "@babel/helper-plugin-utils": ^7.19.0 - "@babel/helper-remap-async-to-generator": ^7.18.9 - "@babel/plugin-syntax-async-generators": ^7.8.4 + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/traverse": ^7.28.3 peerDependencies: - "@babel/core": ^7.0.0-0 - checksum: 518483a68c5618932109913eb7316ed5e656c575cbd9d22667bc0451e35a1be45f8eaeb8e2065834b36c8a93c4840f78cebf8f1d067b07c422f7be16d58eca60 + "@babel/core": ^7.0.0 + checksum: c810e5d36030df6861ced35f0adbda7b4b41ac3e984422b32bee906564fd49374435f0a7a1a42eb0a9e6a5170c255f0ab31c163d5fc51fa5a816aa0420311029 languageName: node linkType: hard -"@babel/plugin-proposal-class-properties@npm:^7.0.0, @babel/plugin-proposal-class-properties@npm:^7.14.0, @babel/plugin-proposal-class-properties@npm:^7.18.6": +"@babel/plugin-proposal-class-properties@npm:^7.0.0, @babel/plugin-proposal-class-properties@npm:^7.14.0": version: 7.18.6 resolution: "@babel/plugin-proposal-class-properties@npm:7.18.6" dependencies: @@ -899,1077 +747,1081 @@ __metadata: languageName: node linkType: hard -"@babel/plugin-proposal-class-static-block@npm:^7.18.6": +"@babel/plugin-proposal-nullish-coalescing-operator@npm:^7.14.5": version: 7.18.6 - resolution: "@babel/plugin-proposal-class-static-block@npm:7.18.6" + resolution: "@babel/plugin-proposal-nullish-coalescing-operator@npm:7.18.6" dependencies: - "@babel/helper-create-class-features-plugin": ^7.18.6 "@babel/helper-plugin-utils": ^7.18.6 - "@babel/plugin-syntax-class-static-block": ^7.14.5 + "@babel/plugin-syntax-nullish-coalescing-operator": ^7.8.3 peerDependencies: - "@babel/core": ^7.12.0 - checksum: b8d7ae99ed5ad784f39e7820e3ac03841f91d6ed60ab4a98c61d6112253da36013e12807bae4ffed0ef3cb318e47debac112ed614e03b403fb8b075b09a828ee + "@babel/core": ^7.0.0-0 + checksum: 949c9ddcdecdaec766ee610ef98f965f928ccc0361dd87cf9f88cf4896a6ccd62fce063d4494778e50da99dea63d270a1be574a62d6ab81cbe9d85884bf55a7d languageName: node linkType: hard -"@babel/plugin-proposal-dynamic-import@npm:^7.18.6": +"@babel/plugin-proposal-numeric-separator@npm:^7.14.5": version: 7.18.6 - resolution: "@babel/plugin-proposal-dynamic-import@npm:7.18.6" + resolution: "@babel/plugin-proposal-numeric-separator@npm:7.18.6" dependencies: "@babel/helper-plugin-utils": ^7.18.6 - "@babel/plugin-syntax-dynamic-import": ^7.8.3 - peerDependencies: - "@babel/core": ^7.0.0-0 - checksum: 96b1c8a8ad8171d39e9ab106be33bde37ae09b22fb2c449afee9a5edf3c537933d79d963dcdc2694d10677cb96da739cdf1b53454e6a5deab9801f28a818bb2f - languageName: node - linkType: hard - -"@babel/plugin-proposal-export-namespace-from@npm:^7.18.9": - version: 7.18.9 - resolution: "@babel/plugin-proposal-export-namespace-from@npm:7.18.9" - dependencies: - "@babel/helper-plugin-utils": ^7.18.9 - "@babel/plugin-syntax-export-namespace-from": ^7.8.3 + "@babel/plugin-syntax-numeric-separator": ^7.10.4 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 84ff22bacc5d30918a849bfb7e0e90ae4c5b8d8b65f2ac881803d1cf9068dffbe53bd657b0e4bc4c20b4db301b1c85f1e74183cf29a0dd31e964bd4e97c363ef + checksum: f370ea584c55bf4040e1f78c80b4eeb1ce2e6aaa74f87d1a48266493c33931d0b6222d8cee3a082383d6bb648ab8d6b7147a06f974d3296ef3bc39c7851683ec languageName: node linkType: hard -"@babel/plugin-proposal-json-strings@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-proposal-json-strings@npm:7.18.6" +"@babel/plugin-proposal-object-rest-spread@npm:7.12.1": + version: 7.12.1 + resolution: "@babel/plugin-proposal-object-rest-spread@npm:7.12.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.6 - "@babel/plugin-syntax-json-strings": ^7.8.3 + "@babel/helper-plugin-utils": ^7.10.4 + "@babel/plugin-syntax-object-rest-spread": ^7.8.0 + "@babel/plugin-transform-parameters": ^7.12.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 25ba0e6b9d6115174f51f7c6787e96214c90dd4026e266976b248a2ed417fe50fddae72843ffb3cbe324014a18632ce5648dfac77f089da858022b49fd608cb3 + checksum: 221a41630c9a7162bf0416c71695b3f7f38482078a1d0d3af7abdc4f07ea1c9feed890399158d56c1d0278c971fe6f565ce822e9351e4481f7d98e9ff735dced languageName: node linkType: hard -"@babel/plugin-proposal-logical-assignment-operators@npm:^7.18.9": - version: 7.18.9 - resolution: "@babel/plugin-proposal-logical-assignment-operators@npm:7.18.9" +"@babel/plugin-proposal-object-rest-spread@npm:^7.0.0, @babel/plugin-proposal-object-rest-spread@npm:^7.14.7": + version: 7.20.7 + resolution: "@babel/plugin-proposal-object-rest-spread@npm:7.20.7" dependencies: - "@babel/helper-plugin-utils": ^7.18.9 - "@babel/plugin-syntax-logical-assignment-operators": ^7.10.4 + "@babel/compat-data": ^7.20.5 + "@babel/helper-compilation-targets": ^7.20.7 + "@babel/helper-plugin-utils": ^7.20.2 + "@babel/plugin-syntax-object-rest-spread": ^7.8.3 + "@babel/plugin-transform-parameters": ^7.20.7 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: dd87fa4a48c6408c5e85dbd6405a65cc8fe909e3090030df46df90df64cdf3e74007381a58ed87608778ee597eff7395d215274009bb3f5d8964b2db5557754f + checksum: 1329db17009964bc644484c660eab717cb3ca63ac0ab0f67c651a028d1bc2ead51dc4064caea283e46994f1b7221670a35cbc0b4beb6273f55e915494b5aa0b2 languageName: node linkType: hard -"@babel/plugin-proposal-nullish-coalescing-operator@npm:^7.14.5, @babel/plugin-proposal-nullish-coalescing-operator@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-proposal-nullish-coalescing-operator@npm:7.18.6" +"@babel/plugin-proposal-optional-chaining@npm:^7.14.5": + version: 7.21.0 + resolution: "@babel/plugin-proposal-optional-chaining@npm:7.21.0" dependencies: - "@babel/helper-plugin-utils": ^7.18.6 - "@babel/plugin-syntax-nullish-coalescing-operator": ^7.8.3 + "@babel/helper-plugin-utils": ^7.20.2 + "@babel/helper-skip-transparent-expression-wrappers": ^7.20.0 + "@babel/plugin-syntax-optional-chaining": ^7.8.3 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 949c9ddcdecdaec766ee610ef98f965f928ccc0361dd87cf9f88cf4896a6ccd62fce063d4494778e50da99dea63d270a1be574a62d6ab81cbe9d85884bf55a7d + checksum: 11c5449e01b18bb8881e8e005a577fa7be2fe5688e2382c8822d51f8f7005342a301a46af7b273b1f5645f9a7b894c428eee8526342038a275ef6ba4c8d8d746 languageName: node linkType: hard -"@babel/plugin-proposal-numeric-separator@npm:^7.14.5, @babel/plugin-proposal-numeric-separator@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-proposal-numeric-separator@npm:7.18.6" - dependencies: - "@babel/helper-plugin-utils": ^7.18.6 - "@babel/plugin-syntax-numeric-separator": ^7.10.4 +"@babel/plugin-proposal-private-property-in-object@npm:7.21.0-placeholder-for-preset-env.2": + version: 7.21.0-placeholder-for-preset-env.2 + resolution: "@babel/plugin-proposal-private-property-in-object@npm:7.21.0-placeholder-for-preset-env.2" peerDependencies: "@babel/core": ^7.0.0-0 - checksum: f370ea584c55bf4040e1f78c80b4eeb1ce2e6aaa74f87d1a48266493c33931d0b6222d8cee3a082383d6bb648ab8d6b7147a06f974d3296ef3bc39c7851683ec + checksum: d97745d098b835d55033ff3a7fb2b895b9c5295b08a5759e4f20df325aa385a3e0bc9bd5ad8f2ec554a44d4e6525acfc257b8c5848a1345cb40f26a30e277e91 languageName: node linkType: hard -"@babel/plugin-proposal-object-rest-spread@npm:7.12.1": - version: 7.12.1 - resolution: "@babel/plugin-proposal-object-rest-spread@npm:7.12.1" +"@babel/plugin-syntax-class-properties@npm:^7.0.0": + version: 7.12.13 + resolution: "@babel/plugin-syntax-class-properties@npm:7.12.13" dependencies: - "@babel/helper-plugin-utils": ^7.10.4 - "@babel/plugin-syntax-object-rest-spread": ^7.8.0 - "@babel/plugin-transform-parameters": ^7.12.1 + "@babel/helper-plugin-utils": ^7.12.13 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 221a41630c9a7162bf0416c71695b3f7f38482078a1d0d3af7abdc4f07ea1c9feed890399158d56c1d0278c971fe6f565ce822e9351e4481f7d98e9ff735dced + checksum: 24f34b196d6342f28d4bad303612d7ff566ab0a013ce89e775d98d6f832969462e7235f3e7eaf17678a533d4be0ba45d3ae34ab4e5a9dcbda5d98d49e5efa2fc languageName: node linkType: hard -"@babel/plugin-proposal-object-rest-spread@npm:^7.0.0, @babel/plugin-proposal-object-rest-spread@npm:^7.14.7, @babel/plugin-proposal-object-rest-spread@npm:^7.20.2": - version: 7.20.2 - resolution: "@babel/plugin-proposal-object-rest-spread@npm:7.20.2" +"@babel/plugin-syntax-dynamic-import@npm:^7.8.3": + version: 7.8.3 + resolution: "@babel/plugin-syntax-dynamic-import@npm:7.8.3" dependencies: - "@babel/compat-data": ^7.20.1 - "@babel/helper-compilation-targets": ^7.20.0 - "@babel/helper-plugin-utils": ^7.20.2 - "@babel/plugin-syntax-object-rest-spread": ^7.8.3 - "@babel/plugin-transform-parameters": ^7.20.1 + "@babel/helper-plugin-utils": ^7.8.0 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 9764d1a4735fcd384fdb9b6c6ccb20d1bea2f88f648640d26ce5d9cd5880ce1e389d2f852d7bea7e86ff343726225dc16e1deb92c7b3dc5c5721ed905a602318 + checksum: ce307af83cf433d4ec42932329fad25fa73138ab39c7436882ea28742e1c0066626d224e0ad2988724c82644e41601cef607b36194f695cb78a1fcdc959637bd languageName: node linkType: hard -"@babel/plugin-proposal-optional-catch-binding@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-proposal-optional-catch-binding@npm:7.18.6" +"@babel/plugin-syntax-flow@npm:^7.0.0, @babel/plugin-syntax-flow@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-syntax-flow@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.6 - "@babel/plugin-syntax-optional-catch-binding": ^7.8.3 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 7b5b39fb5d8d6d14faad6cb68ece5eeb2fd550fb66b5af7d7582402f974f5bc3684641f7c192a5a57e0f59acfae4aada6786be1eba030881ddc590666eff4d1e + checksum: 7baca3171ed595d04c865b0ce46fca7f21900686df9d7fcd1017036ce78bb5483e33803de810831e68d39cf478953db69f49ae3f3de2e3207bc4ba49a96b6739 languageName: node linkType: hard -"@babel/plugin-proposal-optional-chaining@npm:^7.14.5, @babel/plugin-proposal-optional-chaining@npm:^7.18.9": - version: 7.18.9 - resolution: "@babel/plugin-proposal-optional-chaining@npm:7.18.9" +"@babel/plugin-syntax-import-assertions@npm:^7.20.0, @babel/plugin-syntax-import-assertions@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-syntax-import-assertions@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.9 - "@babel/helper-skip-transparent-expression-wrappers": ^7.18.9 - "@babel/plugin-syntax-optional-chaining": ^7.8.3 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: f2db40e26172f07c50b635cb61e1f36165de3ba868fcf608d967642f0d044b7c6beb0e7ecf17cbd421144b99e1eae7ad6031ded92925343bb0ed1d08707b514f + checksum: fb661d630808d67ecb85eabad25aac4e9696a20464bad4c4a6a0d3d40e4dc22557d47e9be3d591ec06429cf048cfe169b8891c373606344d51c4f3ac0f91d6d0 languageName: node linkType: hard -"@babel/plugin-proposal-private-methods@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-proposal-private-methods@npm:7.18.6" +"@babel/plugin-syntax-import-attributes@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-syntax-import-attributes@npm:7.27.1" dependencies: - "@babel/helper-create-class-features-plugin": ^7.18.6 - "@babel/helper-plugin-utils": ^7.18.6 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 22d8502ee96bca99ad2c8393e8493e2b8d4507576dd054490fd8201a36824373440106f5b098b6d821b026c7e72b0424ff4aeca69ed5f42e48f029d3a156d5ad + checksum: 97973982fff1bbf86b3d1df13380567042887c50e2ae13a400d02a8ff2c9742a60a75e279bfb73019e1cd9710f04be5e6ab81f896e6678dcfcec8b135e8896cf languageName: node linkType: hard -"@babel/plugin-proposal-private-property-in-object@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-proposal-private-property-in-object@npm:7.18.6" +"@babel/plugin-syntax-jsx@npm:7.12.1": + version: 7.12.1 + resolution: "@babel/plugin-syntax-jsx@npm:7.12.1" dependencies: - "@babel/helper-annotate-as-pure": ^7.18.6 - "@babel/helper-create-class-features-plugin": ^7.18.6 - "@babel/helper-plugin-utils": ^7.18.6 - "@babel/plugin-syntax-private-property-in-object": ^7.14.5 + "@babel/helper-plugin-utils": ^7.10.4 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: c8e56a972930730345f39f2384916fd8e711b3f4b4eae2ca9740e99958980118120d5cc9b6ac150f0965a5a35f825910e2c3013d90be3e9993ab6111df444569 + checksum: d4b9b589c484b2e0856799770f060dff34c67b24d7f4526f66309a0e0e9cf388a5c1f2c0da329d1973cc87d1b2cede8f3dc8facfac59e785d6393a003bcdd0f9 languageName: node linkType: hard -"@babel/plugin-proposal-unicode-property-regex@npm:^7.18.6, @babel/plugin-proposal-unicode-property-regex@npm:^7.4.4": - version: 7.18.6 - resolution: "@babel/plugin-proposal-unicode-property-regex@npm:7.18.6" +"@babel/plugin-syntax-jsx@npm:^7.0.0, @babel/plugin-syntax-jsx@npm:^7.17.12, @babel/plugin-syntax-jsx@npm:^7.22.5, @babel/plugin-syntax-jsx@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-syntax-jsx@npm:7.27.1" dependencies: - "@babel/helper-create-regexp-features-plugin": ^7.18.6 - "@babel/helper-plugin-utils": ^7.18.6 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: a8575ecb7ff24bf6c6e94808d5c84bb5a0c6dd7892b54f09f4646711ba0ee1e1668032b3c43e3e1dfec2c5716c302e851ac756c1645e15882d73df6ad21ae951 + checksum: c6d1324cff286a369aa95d99b8abd21dd07821b5d3affd5fe7d6058c84cff9190743287826463ee57a7beecd10fa1e4bc99061df532ee14e188c1c8937b13e3a languageName: node linkType: hard -"@babel/plugin-syntax-async-generators@npm:^7.8.4": - version: 7.8.4 - resolution: "@babel/plugin-syntax-async-generators@npm:7.8.4" +"@babel/plugin-syntax-nullish-coalescing-operator@npm:^7.8.3": + version: 7.8.3 + resolution: "@babel/plugin-syntax-nullish-coalescing-operator@npm:7.8.3" dependencies: "@babel/helper-plugin-utils": ^7.8.0 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 7ed1c1d9b9e5b64ef028ea5e755c0be2d4e5e4e3d6cf7df757b9a8c4cfa4193d268176d0f1f7fbecdda6fe722885c7fda681f480f3741d8a2d26854736f05367 + checksum: 87aca4918916020d1fedba54c0e232de408df2644a425d153be368313fdde40d96088feed6c4e5ab72aac89be5d07fef2ddf329a15109c5eb65df006bf2580d1 languageName: node linkType: hard -"@babel/plugin-syntax-class-properties@npm:^7.0.0, @babel/plugin-syntax-class-properties@npm:^7.12.13": - version: 7.12.13 - resolution: "@babel/plugin-syntax-class-properties@npm:7.12.13" +"@babel/plugin-syntax-numeric-separator@npm:^7.10.4": + version: 7.10.4 + resolution: "@babel/plugin-syntax-numeric-separator@npm:7.10.4" dependencies: - "@babel/helper-plugin-utils": ^7.12.13 + "@babel/helper-plugin-utils": ^7.10.4 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 24f34b196d6342f28d4bad303612d7ff566ab0a013ce89e775d98d6f832969462e7235f3e7eaf17678a533d4be0ba45d3ae34ab4e5a9dcbda5d98d49e5efa2fc + checksum: 01ec5547bd0497f76cc903ff4d6b02abc8c05f301c88d2622b6d834e33a5651aa7c7a3d80d8d57656a4588f7276eba357f6b7e006482f5b564b7a6488de493a1 languageName: node linkType: hard -"@babel/plugin-syntax-class-static-block@npm:^7.14.5": - version: 7.14.5 - resolution: "@babel/plugin-syntax-class-static-block@npm:7.14.5" +"@babel/plugin-syntax-object-rest-spread@npm:7.8.3, @babel/plugin-syntax-object-rest-spread@npm:^7.0.0, @babel/plugin-syntax-object-rest-spread@npm:^7.8.0, @babel/plugin-syntax-object-rest-spread@npm:^7.8.3": + version: 7.8.3 + resolution: "@babel/plugin-syntax-object-rest-spread@npm:7.8.3" dependencies: - "@babel/helper-plugin-utils": ^7.14.5 + "@babel/helper-plugin-utils": ^7.8.0 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 3e80814b5b6d4fe17826093918680a351c2d34398a914ce6e55d8083d72a9bdde4fbaf6a2dcea0e23a03de26dc2917ae3efd603d27099e2b98380345703bf948 + checksum: fddcf581a57f77e80eb6b981b10658421bc321ba5f0a5b754118c6a92a5448f12a0c336f77b8abf734841e102e5126d69110a306eadb03ca3e1547cab31f5cbf languageName: node linkType: hard -"@babel/plugin-syntax-dynamic-import@npm:^7.8.3": +"@babel/plugin-syntax-optional-chaining@npm:^7.8.3": version: 7.8.3 - resolution: "@babel/plugin-syntax-dynamic-import@npm:7.8.3" + resolution: "@babel/plugin-syntax-optional-chaining@npm:7.8.3" dependencies: "@babel/helper-plugin-utils": ^7.8.0 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: ce307af83cf433d4ec42932329fad25fa73138ab39c7436882ea28742e1c0066626d224e0ad2988724c82644e41601cef607b36194f695cb78a1fcdc959637bd + checksum: eef94d53a1453361553c1f98b68d17782861a04a392840341bc91780838dd4e695209c783631cf0de14c635758beafb6a3a65399846ffa4386bff90639347f30 languageName: node linkType: hard -"@babel/plugin-syntax-export-namespace-from@npm:^7.8.3": - version: 7.8.3 - resolution: "@babel/plugin-syntax-export-namespace-from@npm:7.8.3" +"@babel/plugin-syntax-typescript@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-syntax-typescript@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.8.3 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 85740478be5b0de185228e7814451d74ab8ce0a26fcca7613955262a26e99e8e15e9da58f60c754b84515d4c679b590dbd3f2148f0f58025f4ae706f1c5a5d4a + checksum: 87836f7e32af624c2914c73cd6b9803cf324e07d43f61dbb973c6a86f75df725e12540d91fac7141c14b697aa9268fd064220998daced156e96ac3062d7afb41 languageName: node linkType: hard -"@babel/plugin-syntax-flow@npm:^7.0.0, @babel/plugin-syntax-flow@npm:^7.18.6": +"@babel/plugin-syntax-unicode-sets-regex@npm:^7.18.6": version: 7.18.6 - resolution: "@babel/plugin-syntax-flow@npm:7.18.6" + resolution: "@babel/plugin-syntax-unicode-sets-regex@npm:7.18.6" dependencies: + "@babel/helper-create-regexp-features-plugin": ^7.18.6 "@babel/helper-plugin-utils": ^7.18.6 peerDependencies: - "@babel/core": ^7.0.0-0 - checksum: abe82062b3eef14de7d2b3c0e4fecf80a3e796ca497e9df616d12dd250968abf71495ee85a955b43a6c827137203f0c409450cf792732ed0d6907c806580ea71 + "@babel/core": ^7.0.0 + checksum: a651d700fe63ff0ddfd7186f4ebc24447ca734f114433139e3c027bc94a900d013cf1ef2e2db8430425ba542e39ae160c3b05f06b59fd4656273a3df97679e9c languageName: node linkType: hard -"@babel/plugin-syntax-import-assertions@npm:^7.20.0": - version: 7.20.0 - resolution: "@babel/plugin-syntax-import-assertions@npm:7.20.0" +"@babel/plugin-transform-arrow-functions@npm:^7.0.0, @babel/plugin-transform-arrow-functions@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-arrow-functions@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.19.0 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 6a86220e0aae40164cd3ffaf80e7c076a1be02a8f3480455dddbae05fda8140f429290027604df7a11b3f3f124866e8a6d69dbfa1dda61ee7377b920ad144d5b + checksum: 62c2cc0ae2093336b1aa1376741c5ed245c0987d9e4b4c5313da4a38155509a7098b5acce582b6781cc0699381420010da2e3086353344abe0a6a0ec38961eb7 languageName: node linkType: hard -"@babel/plugin-syntax-json-strings@npm:^7.8.3": - version: 7.8.3 - resolution: "@babel/plugin-syntax-json-strings@npm:7.8.3" +"@babel/plugin-transform-async-generator-functions@npm:^7.28.0": + version: 7.28.0 + resolution: "@babel/plugin-transform-async-generator-functions@npm:7.28.0" dependencies: - "@babel/helper-plugin-utils": ^7.8.0 + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/helper-remap-async-to-generator": ^7.27.1 + "@babel/traverse": ^7.28.0 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: bf5aea1f3188c9a507e16efe030efb996853ca3cadd6512c51db7233cc58f3ac89ff8c6bdfb01d30843b161cfe7d321e1bf28da82f7ab8d7e6bc5464666f354a + checksum: 174aaccd7a8386fd7f32240c3f65a93cf60dcc5f6a2123cfbff44c0d22b424cd41de3a0c6d136b6a2fa60a8ca01550c261677284cb18a0daeab70730b2265f1d languageName: node linkType: hard -"@babel/plugin-syntax-jsx@npm:7.12.1": - version: 7.12.1 - resolution: "@babel/plugin-syntax-jsx@npm:7.12.1" +"@babel/plugin-transform-async-to-generator@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-async-to-generator@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.10.4 + "@babel/helper-module-imports": ^7.27.1 + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/helper-remap-async-to-generator": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: d4b9b589c484b2e0856799770f060dff34c67b24d7f4526f66309a0e0e9cf388a5c1f2c0da329d1973cc87d1b2cede8f3dc8facfac59e785d6393a003bcdd0f9 + checksum: d79d7a7ae7d416f6a48200017d027a6ba94c09c7617eea8b4e9c803630f00094c1a4fc32bf20ce3282567824ce3fcbda51653aac4003c71ea4e681b331338979 languageName: node linkType: hard -"@babel/plugin-syntax-jsx@npm:^7.0.0, @babel/plugin-syntax-jsx@npm:^7.17.12, @babel/plugin-syntax-jsx@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-syntax-jsx@npm:7.18.6" +"@babel/plugin-transform-block-scoped-functions@npm:^7.0.0, @babel/plugin-transform-block-scoped-functions@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-block-scoped-functions@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.6 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 6d37ea972970195f1ffe1a54745ce2ae456e0ac6145fae9aa1480f297248b262ea6ebb93010eddb86ebfacb94f57c05a1fc5d232b9a67325b09060299d515c67 + checksum: 7fb4988ca80cf1fc8345310d5edfe38e86b3a72a302675cdd09404d5064fe1d1fe1283ebe658ad2b71445ecef857bfb29a748064306b5f6c628e0084759c2201 languageName: node linkType: hard -"@babel/plugin-syntax-logical-assignment-operators@npm:^7.10.4": - version: 7.10.4 - resolution: "@babel/plugin-syntax-logical-assignment-operators@npm:7.10.4" +"@babel/plugin-transform-block-scoping@npm:^7.0.0, @babel/plugin-transform-block-scoping@npm:^7.28.5": + version: 7.28.5 + resolution: "@babel/plugin-transform-block-scoping@npm:7.28.5" dependencies: - "@babel/helper-plugin-utils": ^7.10.4 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: aff33577037e34e515911255cdbb1fd39efee33658aa00b8a5fd3a4b903585112d037cce1cc9e4632f0487dc554486106b79ccd5ea63a2e00df4363f6d4ff886 + checksum: 2cbc11c9b61097b61806c279211a4c4f5e85a5ca7fd52228efbf3a729178d330142a00a93695dbacc2898477e5fa9e34e7637f18323247ebebb84f43005560f3 languageName: node linkType: hard -"@babel/plugin-syntax-nullish-coalescing-operator@npm:^7.8.3": - version: 7.8.3 - resolution: "@babel/plugin-syntax-nullish-coalescing-operator@npm:7.8.3" +"@babel/plugin-transform-class-properties@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-class-properties@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.8.0 + "@babel/helper-create-class-features-plugin": ^7.27.1 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 87aca4918916020d1fedba54c0e232de408df2644a425d153be368313fdde40d96088feed6c4e5ab72aac89be5d07fef2ddf329a15109c5eb65df006bf2580d1 + checksum: 475a6e5a9454912fe1bdc171941976ca10ea4e707675d671cdb5ce6b6761d84d1791ac61b6bca81a2e5f6430cb7b9d8e4b2392404110e69c28207a754e196294 languageName: node linkType: hard -"@babel/plugin-syntax-numeric-separator@npm:^7.10.4": - version: 7.10.4 - resolution: "@babel/plugin-syntax-numeric-separator@npm:7.10.4" +"@babel/plugin-transform-class-static-block@npm:^7.28.3": + version: 7.28.3 + resolution: "@babel/plugin-transform-class-static-block@npm:7.28.3" dependencies: - "@babel/helper-plugin-utils": ^7.10.4 + "@babel/helper-create-class-features-plugin": ^7.28.3 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: - "@babel/core": ^7.0.0-0 - checksum: 01ec5547bd0497f76cc903ff4d6b02abc8c05f301c88d2622b6d834e33a5651aa7c7a3d80d8d57656a4588f7276eba357f6b7e006482f5b564b7a6488de493a1 + "@babel/core": ^7.12.0 + checksum: 9b2feaacbf29637ab35a3aae1df35a1129adec5400a1767443739557fb0d3bf8278bf0ec90aacf43dec9a7dd91428d01375020b70528713e1bc36a72776a104c languageName: node linkType: hard -"@babel/plugin-syntax-object-rest-spread@npm:7.8.3, @babel/plugin-syntax-object-rest-spread@npm:^7.0.0, @babel/plugin-syntax-object-rest-spread@npm:^7.8.0, @babel/plugin-syntax-object-rest-spread@npm:^7.8.3": - version: 7.8.3 - resolution: "@babel/plugin-syntax-object-rest-spread@npm:7.8.3" +"@babel/plugin-transform-classes@npm:^7.0.0, @babel/plugin-transform-classes@npm:^7.15.4, @babel/plugin-transform-classes@npm:^7.28.4": + version: 7.28.4 + resolution: "@babel/plugin-transform-classes@npm:7.28.4" dependencies: - "@babel/helper-plugin-utils": ^7.8.0 + "@babel/helper-annotate-as-pure": ^7.27.3 + "@babel/helper-compilation-targets": ^7.27.2 + "@babel/helper-globals": ^7.28.0 + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/helper-replace-supers": ^7.27.1 + "@babel/traverse": ^7.28.4 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: fddcf581a57f77e80eb6b981b10658421bc321ba5f0a5b754118c6a92a5448f12a0c336f77b8abf734841e102e5126d69110a306eadb03ca3e1547cab31f5cbf + checksum: f412e00c86584a9094cc0a2f3dd181b8108a4dced477d609c5406beddd5bf79d05a7ea74db508dc4dcb37172f042d5ef98d3d6311ade61c7ea6fbbbb70f5ec29 languageName: node linkType: hard -"@babel/plugin-syntax-optional-catch-binding@npm:^7.8.3": - version: 7.8.3 - resolution: "@babel/plugin-syntax-optional-catch-binding@npm:7.8.3" +"@babel/plugin-transform-computed-properties@npm:^7.0.0, @babel/plugin-transform-computed-properties@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-computed-properties@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.8.0 + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/template": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 910d90e72bc90ea1ce698e89c1027fed8845212d5ab588e35ef91f13b93143845f94e2539d831dc8d8ededc14ec02f04f7bd6a8179edd43a326c784e7ed7f0b9 + checksum: 48bd20f7d631b08c51155751bf75b698d4a22cca36f41c22921ab92e53039c9ec5c3544e5282e18692325ef85d2e4a18c27e12c62b5e20c26fb0c92447e35224 languageName: node linkType: hard -"@babel/plugin-syntax-optional-chaining@npm:^7.8.3": - version: 7.8.3 - resolution: "@babel/plugin-syntax-optional-chaining@npm:7.8.3" +"@babel/plugin-transform-destructuring@npm:^7.0.0, @babel/plugin-transform-destructuring@npm:^7.28.0, @babel/plugin-transform-destructuring@npm:^7.28.5": + version: 7.28.5 + resolution: "@babel/plugin-transform-destructuring@npm:7.28.5" dependencies: - "@babel/helper-plugin-utils": ^7.8.0 + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/traverse": ^7.28.5 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: eef94d53a1453361553c1f98b68d17782861a04a392840341bc91780838dd4e695209c783631cf0de14c635758beafb6a3a65399846ffa4386bff90639347f30 + checksum: 74a06e55e715cfda0fdd8be53d2655d64dfdc28dffaede329d42548fd5b1449ad26a4ce43a24c3fd277b96f8b2010c7b3915afa8297911cda740cc5cc3a81f38 languageName: node linkType: hard -"@babel/plugin-syntax-private-property-in-object@npm:^7.14.5": - version: 7.14.5 - resolution: "@babel/plugin-syntax-private-property-in-object@npm:7.14.5" +"@babel/plugin-transform-dotall-regex@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-dotall-regex@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.14.5 + "@babel/helper-create-regexp-features-plugin": ^7.27.1 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: b317174783e6e96029b743ccff2a67d63d38756876e7e5d0ba53a322e38d9ca452c13354a57de1ad476b4c066dbae699e0ca157441da611117a47af88985ecda + checksum: 2173e5b13f403538ffc6bd57b190cedf4caf320abc13a99e5b2721864e7148dbd3bd7c82d92377136af80432818f665fdd9a1fd33bc5549a4c91e24e5ce2413c languageName: node linkType: hard -"@babel/plugin-syntax-top-level-await@npm:^7.14.5": - version: 7.14.5 - resolution: "@babel/plugin-syntax-top-level-await@npm:7.14.5" +"@babel/plugin-transform-duplicate-keys@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-duplicate-keys@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.14.5 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: bbd1a56b095be7820029b209677b194db9b1d26691fe999856462e66b25b281f031f3dfd91b1619e9dcf95bebe336211833b854d0fb8780d618e35667c2d0d7e + checksum: ef2112d658338e3ff0827f39a53c0cfa211f1cbbe60363bca833a5269df389598ec965e7283600b46533c39cdca82307d0d69c0f518290ec5b00bb713044715b languageName: node linkType: hard -"@babel/plugin-syntax-typescript@npm:^7.20.0": - version: 7.20.0 - resolution: "@babel/plugin-syntax-typescript@npm:7.20.0" +"@babel/plugin-transform-duplicate-named-capturing-groups-regex@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-duplicate-named-capturing-groups-regex@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.19.0 + "@babel/helper-create-regexp-features-plugin": ^7.27.1 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: - "@babel/core": ^7.0.0-0 - checksum: 6189c0b5c32ba3c9a80a42338bd50719d783b20ef29b853d4f03929e971913d3cefd80184e924ae98ad6db09080be8fe6f1ffde9a6db8972523234f0274d36f7 + "@babel/core": ^7.0.0 + checksum: 2a109613535e6ac79240dced71429e988affd6a5b3d0cd0f563c8d6c208c51ce7bf2c300bc1150502376b26a51f279119b3358f1c0f2d2f8abca3bcd62e1ae46 languageName: node linkType: hard -"@babel/plugin-transform-arrow-functions@npm:^7.0.0, @babel/plugin-transform-arrow-functions@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-transform-arrow-functions@npm:7.18.6" +"@babel/plugin-transform-dynamic-import@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-dynamic-import@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.6 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 900f5c695755062b91eec74da6f9092f40b8fada099058b92576f1e23c55e9813ec437051893a9b3c05cefe39e8ac06303d4a91b384e1c03dd8dc1581ea11602 + checksum: 7a9fbc8d17148b7f11a1d1ca3990d2c2cd44bd08a45dcaf14f20a017721235b9044b20e6168b6940282bb1b48fb78e6afbdfb9dd9d82fde614e15baa7d579932 languageName: node linkType: hard -"@babel/plugin-transform-async-to-generator@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-transform-async-to-generator@npm:7.18.6" +"@babel/plugin-transform-explicit-resource-management@npm:^7.28.0": + version: 7.28.0 + resolution: "@babel/plugin-transform-explicit-resource-management@npm:7.28.0" dependencies: - "@babel/helper-module-imports": ^7.18.6 - "@babel/helper-plugin-utils": ^7.18.6 - "@babel/helper-remap-async-to-generator": ^7.18.6 + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/plugin-transform-destructuring": ^7.28.0 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: c2cca47468cf1aeefdc7ec35d670e195c86cee4de28a1970648c46a88ce6bd1806ef0bab27251b9e7fb791bb28a64dcd543770efd899f28ee5f7854e64e873d3 + checksum: a44140097ed4854883c426613f4e8763237cd0fdab1c780514f4315f6c148d6b528d7a57fe6fdec4dbce28a21b70393ef3507b72dfec2e30bfc8d7db1ff19474 languageName: node linkType: hard -"@babel/plugin-transform-block-scoped-functions@npm:^7.0.0, @babel/plugin-transform-block-scoped-functions@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-transform-block-scoped-functions@npm:7.18.6" +"@babel/plugin-transform-exponentiation-operator@npm:^7.28.5": + version: 7.28.5 + resolution: "@babel/plugin-transform-exponentiation-operator@npm:7.28.5" dependencies: - "@babel/helper-plugin-utils": ^7.18.6 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 0a0df61f94601e3666bf39f2cc26f5f7b22a94450fb93081edbed967bd752ce3f81d1227fefd3799f5ee2722171b5e28db61379234d1bb85b6ec689589f99d7e + checksum: da9bb5acd35c9fba92b802641f9462b82334158a149c78a739a04576a1e62be41057a201a41c022dda263bb73ac1a26521bbc997c7fc067f54d487af297995f4 languageName: node linkType: hard -"@babel/plugin-transform-block-scoping@npm:^7.0.0, @babel/plugin-transform-block-scoping@npm:^7.20.2": - version: 7.20.2 - resolution: "@babel/plugin-transform-block-scoping@npm:7.20.2" +"@babel/plugin-transform-export-namespace-from@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-export-namespace-from@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.20.2 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 550b983277557ecfa3ef1e7a2367eaa9e0616a56f0d4106812cbc8aeca057b0f0b8bbc5c548b9b3b57399868f916e89e17303c802c8c46d18fba5bc174d4e794 + checksum: 85082923eca317094f08f4953d8ea2a6558b3117826c0b740676983902b7236df1f4213ad844cb38c2dae104753dbe8f1cc51f01567835d476d32f5f544a4385 languageName: node linkType: hard -"@babel/plugin-transform-classes@npm:^7.0.0, @babel/plugin-transform-classes@npm:^7.15.4, @babel/plugin-transform-classes@npm:^7.20.2": - version: 7.20.2 - resolution: "@babel/plugin-transform-classes@npm:7.20.2" +"@babel/plugin-transform-flow-strip-types@npm:^7.0.0": + version: 7.27.1 + resolution: "@babel/plugin-transform-flow-strip-types@npm:7.27.1" dependencies: - "@babel/helper-annotate-as-pure": ^7.18.6 - "@babel/helper-compilation-targets": ^7.20.0 - "@babel/helper-environment-visitor": ^7.18.9 - "@babel/helper-function-name": ^7.19.0 - "@babel/helper-optimise-call-expression": ^7.18.6 - "@babel/helper-plugin-utils": ^7.20.2 - "@babel/helper-replace-supers": ^7.19.1 - "@babel/helper-split-export-declaration": ^7.18.6 - globals: ^11.1.0 + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/plugin-syntax-flow": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 57f3467a8eb7853cdb61cda963cfb6c6568ad276d77c9de2ff5a2194650010217aa318ef3733975537c6fb906b73a019afb6ea650b01852e7d2e1fab4034361b + checksum: 0885028866fadefef35292d5a27f878d6a12b6f83778f8731481d4503b49c258507882a7de2aafda9b62d5f6350042f1a06355b998d5ed5e85d693bfcb77b939 languageName: node linkType: hard -"@babel/plugin-transform-computed-properties@npm:^7.0.0, @babel/plugin-transform-computed-properties@npm:^7.18.9": - version: 7.18.9 - resolution: "@babel/plugin-transform-computed-properties@npm:7.18.9" +"@babel/plugin-transform-for-of@npm:^7.0.0, @babel/plugin-transform-for-of@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-for-of@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.9 + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/helper-skip-transparent-expression-wrappers": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: a6bfbea207827d77592628973c0e8cc3319db636506bdc6e81e21582de2e767890e6975b382d0511e9ec3773b9f43691185df90832883bbf9251f688d27fbc1d + checksum: c9224e08de5d80b2c834383d4359aa9e519db434291711434dd996a4f86b7b664ad67b45d65459b7ec11fa582e3e11a3c769b8a8ca71594bdd4e2f0503f84126 languageName: node linkType: hard -"@babel/plugin-transform-destructuring@npm:^7.0.0, @babel/plugin-transform-destructuring@npm:^7.20.2": - version: 7.20.2 - resolution: "@babel/plugin-transform-destructuring@npm:7.20.2" +"@babel/plugin-transform-function-name@npm:^7.0.0, @babel/plugin-transform-function-name@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-function-name@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.20.2 + "@babel/helper-compilation-targets": ^7.27.1 + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/traverse": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 09033e09b28ca1b0d46a8d82f5a677b1d718a739b3c199886908c3ef1af23369317d0c429b21507d480ee82721c15892a9893be18e50ad6fc219e69312f4b097 + checksum: 26a2a183c3c52a96495967420a64afc5a09f743a230272a131668abf23001e393afa6371e6f8e6c60f4182bea210ed31d1caf866452d91009c1daac345a52f23 languageName: node linkType: hard -"@babel/plugin-transform-dotall-regex@npm:^7.18.6, @babel/plugin-transform-dotall-regex@npm:^7.4.4": - version: 7.18.6 - resolution: "@babel/plugin-transform-dotall-regex@npm:7.18.6" +"@babel/plugin-transform-json-strings@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-json-strings@npm:7.27.1" dependencies: - "@babel/helper-create-regexp-features-plugin": ^7.18.6 - "@babel/helper-plugin-utils": ^7.18.6 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: cbe5d7063eb8f8cca24cd4827bc97f5641166509e58781a5f8aa47fb3d2d786ce4506a30fca2e01f61f18792783a5cb5d96bf5434c3dd1ad0de8c9cc625a53da + checksum: 2c05a02f63b49f47069271b3405a66c3c8038de5b995b0700b1bd9a5e2bb3e67abd01e4604629302a521f4d8122a4233944aefa16559fd4373d256cc5d3da57f languageName: node linkType: hard -"@babel/plugin-transform-duplicate-keys@npm:^7.18.9": - version: 7.18.9 - resolution: "@babel/plugin-transform-duplicate-keys@npm:7.18.9" +"@babel/plugin-transform-literals@npm:^7.0.0, @babel/plugin-transform-literals@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-literals@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.9 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 220bf4a9fec5c4d4a7b1de38810350260e8ea08481bf78332a464a21256a95f0df8cd56025f346238f09b04f8e86d4158fafc9f4af57abaef31637e3b58bd4fe + checksum: 0a76d12ab19f32dd139964aea7da48cecdb7de0b75e207e576f0f700121fe92367d788f328bf4fb44b8261a0f605c97b44e62ae61cddbb67b14e94c88b411f95 languageName: node linkType: hard -"@babel/plugin-transform-exponentiation-operator@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-transform-exponentiation-operator@npm:7.18.6" +"@babel/plugin-transform-logical-assignment-operators@npm:^7.28.5": + version: 7.28.5 + resolution: "@babel/plugin-transform-logical-assignment-operators@npm:7.28.5" dependencies: - "@babel/helper-builder-binary-assignment-operator-visitor": ^7.18.6 - "@babel/helper-plugin-utils": ^7.18.6 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 7f70222f6829c82a36005508d34ddbe6fd0974ae190683a8670dd6ff08669aaf51fef2209d7403f9bd543cb2d12b18458016c99a6ed0332ccedb3ea127b01229 + checksum: c76778f4b186cc4f0b7e3658d91c690678bdb2b9d032f189213016d6177f2564709b79b386523b022b7d52e52331fd91f280f7c7bf85d835e0758b4b0d371447 languageName: node linkType: hard -"@babel/plugin-transform-flow-strip-types@npm:^7.0.0": - version: 7.19.0 - resolution: "@babel/plugin-transform-flow-strip-types@npm:7.19.0" +"@babel/plugin-transform-member-expression-literals@npm:^7.0.0, @babel/plugin-transform-member-expression-literals@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-member-expression-literals@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.19.0 - "@babel/plugin-syntax-flow": ^7.18.6 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: c35339bf80c2a2b9abb9e2ce0382e1d9cc3ef7db2af127f4ec3d184bad2aec3269f3fcac5fdcd565439732803acad72eb9e7d5a18e439221526fdc041c9e8e1e + checksum: 804121430a6dcd431e6ffe99c6d1fbbc44b43478113b79c677629e7f877b4f78a06b69c6bfb2747fd84ee91879fe2eb32e4620b53124603086cf5b727593ebe8 languageName: node linkType: hard -"@babel/plugin-transform-for-of@npm:^7.0.0, @babel/plugin-transform-for-of@npm:^7.18.8": - version: 7.18.8 - resolution: "@babel/plugin-transform-for-of@npm:7.18.8" +"@babel/plugin-transform-modules-amd@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-modules-amd@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.6 + "@babel/helper-module-transforms": ^7.27.1 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: ca64c623cf0c7a80ab6f07ebd3e6e4ade95e2ae806696f70b43eafe6394fa8ce21f2b1ffdd15df2067f7363d2ecfe26472a97c6c774403d2163fa05f50c98f17 + checksum: 8bb36d448e438d5d30f4faf19120e8c18aa87730269e65d805bf6032824d175ed738057cc392c2c8a650028f1ae0f346cad8d6b723f31a037b586e2092a7be18 languageName: node linkType: hard -"@babel/plugin-transform-function-name@npm:^7.0.0, @babel/plugin-transform-function-name@npm:^7.18.9": - version: 7.18.9 - resolution: "@babel/plugin-transform-function-name@npm:7.18.9" +"@babel/plugin-transform-modules-commonjs@npm:^7.0.0, @babel/plugin-transform-modules-commonjs@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-modules-commonjs@npm:7.27.1" dependencies: - "@babel/helper-compilation-targets": ^7.18.9 - "@babel/helper-function-name": ^7.18.9 - "@babel/helper-plugin-utils": ^7.18.9 + "@babel/helper-module-transforms": ^7.27.1 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 62dd9c6cdc9714704efe15545e782ee52d74dc73916bf954b4d3bee088fb0ec9e3c8f52e751252433656c09f744b27b757fc06ed99bcde28e8a21600a1d8e597 + checksum: bc45c1beff9b145c982bd6a614af338893d38bce18a9df7d658c9084e0d8114b286dcd0e015132ae7b15dd966153cb13321e4800df9766d0ddd892d22bf09d2a languageName: node linkType: hard -"@babel/plugin-transform-literals@npm:^7.0.0, @babel/plugin-transform-literals@npm:^7.18.9": - version: 7.18.9 - resolution: "@babel/plugin-transform-literals@npm:7.18.9" +"@babel/plugin-transform-modules-systemjs@npm:^7.28.5": + version: 7.28.5 + resolution: "@babel/plugin-transform-modules-systemjs@npm:7.28.5" dependencies: - "@babel/helper-plugin-utils": ^7.18.9 + "@babel/helper-module-transforms": ^7.28.3 + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/helper-validator-identifier": ^7.28.5 + "@babel/traverse": ^7.28.5 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 3458dd2f1a47ac51d9d607aa18f3d321cbfa8560a985199185bed5a906bb0c61ba85575d386460bac9aed43fdd98940041fae5a67dff286f6f967707cff489f8 + checksum: 646748dcf968c107fedfbff38aa37f7a9ebf2ccdf51fd9f578c6cd323371db36bbc5fe0d995544db168f39be9bca32a85fbf3bfff4742d2bed22e21c2847fa46 languageName: node linkType: hard -"@babel/plugin-transform-member-expression-literals@npm:^7.0.0, @babel/plugin-transform-member-expression-literals@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-transform-member-expression-literals@npm:7.18.6" +"@babel/plugin-transform-modules-umd@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-modules-umd@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.6 + "@babel/helper-module-transforms": ^7.27.1 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 35a3d04f6693bc6b298c05453d85ee6e41cc806538acb6928427e0e97ae06059f97d2f07d21495fcf5f70d3c13a242e2ecbd09d5c1fcb1b1a73ff528dcb0b695 + checksum: b007dd89231f2eeccf1c71a85629bcb692573303977a4b1c5f19a835ea6b5142c18ef07849bc6d752b874a11bc0ddf3c67468b77c8ee8310290b688a4f01ef31 languageName: node linkType: hard -"@babel/plugin-transform-modules-amd@npm:^7.19.6": - version: 7.19.6 - resolution: "@babel/plugin-transform-modules-amd@npm:7.19.6" +"@babel/plugin-transform-named-capturing-groups-regex@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-named-capturing-groups-regex@npm:7.27.1" dependencies: - "@babel/helper-module-transforms": ^7.19.6 - "@babel/helper-plugin-utils": ^7.19.0 + "@babel/helper-create-regexp-features-plugin": ^7.27.1 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: - "@babel/core": ^7.0.0-0 - checksum: 4236aad970025bc10c772c1589b1e2eab8b7681933bb5ffa6e395d4c1a52532b28c47c553e3011b4272ea81e5ab39fe969eb5349584e8390e59771055c467d42 + "@babel/core": ^7.0.0 + checksum: a711c92d9753df26cefc1792481e5cbff4fe4f32b383d76b25e36fa865d8023b1b9aa6338cf18f5c0e864c71a7fbe8115e840872ccd61a914d9953849c68de7d languageName: node linkType: hard -"@babel/plugin-transform-modules-commonjs@npm:^7.0.0, @babel/plugin-transform-modules-commonjs@npm:^7.19.6": - version: 7.19.6 - resolution: "@babel/plugin-transform-modules-commonjs@npm:7.19.6" +"@babel/plugin-transform-new-target@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-new-target@npm:7.27.1" dependencies: - "@babel/helper-module-transforms": ^7.19.6 - "@babel/helper-plugin-utils": ^7.19.0 - "@babel/helper-simple-access": ^7.19.4 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 85d46945ab5ba3fff89e962d560a5d40253f228b9659a697683db3de07c0236e8cd60e5eb41958007359951a42bc268bf32350fcdb5b4a86f58dff1e032c096e + checksum: 32c8078d843bda001244509442d68fd3af088d7348ba883f45c262b2c817a27ffc553b0d78e7f7a763271b2ece7fac56151baad7a91fb21f5bb1d2f38e5acad7 languageName: node linkType: hard -"@babel/plugin-transform-modules-systemjs@npm:^7.19.6": - version: 7.19.6 - resolution: "@babel/plugin-transform-modules-systemjs@npm:7.19.6" +"@babel/plugin-transform-nullish-coalescing-operator@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-nullish-coalescing-operator@npm:7.27.1" dependencies: - "@babel/helper-hoist-variables": ^7.18.6 - "@babel/helper-module-transforms": ^7.19.6 - "@babel/helper-plugin-utils": ^7.19.0 - "@babel/helper-validator-identifier": ^7.19.1 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 8526431cc81ea3eb232ad50862d0ed1cbb422b5251d14a8d6610d0ca0617f6e75f35179e98eb1235d0cccb980120350b9f112594e5646dd45378d41eaaf87342 + checksum: 1c6b3730748782d2178cc30f5cc37be7d7666148260f3f2dfc43999908bdd319bdfebaaf19cf04ac1f9dee0f7081093d3fa730cda5ae1b34bcd73ce406a78be7 languageName: node linkType: hard -"@babel/plugin-transform-modules-umd@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-transform-modules-umd@npm:7.18.6" +"@babel/plugin-transform-numeric-separator@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-numeric-separator@npm:7.27.1" dependencies: - "@babel/helper-module-transforms": ^7.18.6 - "@babel/helper-plugin-utils": ^7.18.6 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: c3b6796c6f4579f1ba5ab0cdcc73910c1e9c8e1e773c507c8bb4da33072b3ae5df73c6d68f9126dab6e99c24ea8571e1563f8710d7c421fac1cde1e434c20153 + checksum: 049b958911de86d32408cd78017940a207e49c054ae9534ab53a32a57122cc592c0aae3c166d6f29bd1a7d75cc779d71883582dd76cb28b2fbb493e842d8ffca languageName: node linkType: hard -"@babel/plugin-transform-named-capturing-groups-regex@npm:^7.19.1": - version: 7.19.1 - resolution: "@babel/plugin-transform-named-capturing-groups-regex@npm:7.19.1" +"@babel/plugin-transform-object-rest-spread@npm:^7.28.4": + version: 7.28.4 + resolution: "@babel/plugin-transform-object-rest-spread@npm:7.28.4" dependencies: - "@babel/helper-create-regexp-features-plugin": ^7.19.0 - "@babel/helper-plugin-utils": ^7.19.0 + "@babel/helper-compilation-targets": ^7.27.2 + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/plugin-transform-destructuring": ^7.28.0 + "@babel/plugin-transform-parameters": ^7.27.7 + "@babel/traverse": ^7.28.4 peerDependencies: - "@babel/core": ^7.0.0 - checksum: 8a40f5d04f2140c44fe890a5a3fd72abc2a88445443ac2bd92e1e85d9366d3eb8f1ebb7e2c89d2daeaf213d9b28cb65605502ac9b155936d48045eeda6053494 + "@babel/core": ^7.0.0-0 + checksum: 2063672ba4ac457a64b5c0c982439c7b08b4c70f0e743792b98240db5a05f1c063918d8366c92d4d6b2572e2e3452b300a23980b6668e4f54ff349f60d47ec48 languageName: node linkType: hard -"@babel/plugin-transform-new-target@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-transform-new-target@npm:7.18.6" +"@babel/plugin-transform-object-super@npm:^7.0.0, @babel/plugin-transform-object-super@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-object-super@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.6 + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/helper-replace-supers": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: bd780e14f46af55d0ae8503b3cb81ca86dcc73ed782f177e74f498fff934754f9e9911df1f8f3bd123777eed7c1c1af4d66abab87c8daae5403e7719a6b845d1 + checksum: 46b819cb9a6cd3cfefe42d07875fee414f18d5e66040366ae856116db560ad4e16f3899a0a7fddd6773e0d1458444f94b208b67c0e3b6977a27ea17a5c13dbf6 languageName: node linkType: hard -"@babel/plugin-transform-object-super@npm:^7.0.0, @babel/plugin-transform-object-super@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-transform-object-super@npm:7.18.6" +"@babel/plugin-transform-optional-catch-binding@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-optional-catch-binding@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.6 - "@babel/helper-replace-supers": ^7.18.6 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 0fcb04e15deea96ae047c21cb403607d49f06b23b4589055993365ebd7a7d7541334f06bf9642e90075e66efce6ebaf1eb0ef066fbbab802d21d714f1aac3aef + checksum: f4356b04cf21a98480f9788ea50f1f13ee88e89bb6393ba4b84d1f39a4a84c7928c9a4328e8f4c5b6deb218da68a8fd17bf4f46faec7653ddc20ffaaa5ba49f4 languageName: node linkType: hard -"@babel/plugin-transform-parameters@npm:^7.0.0, @babel/plugin-transform-parameters@npm:^7.12.1, @babel/plugin-transform-parameters@npm:^7.20.1": - version: 7.20.3 - resolution: "@babel/plugin-transform-parameters@npm:7.20.3" +"@babel/plugin-transform-optional-chaining@npm:^7.27.1, @babel/plugin-transform-optional-chaining@npm:^7.28.5": + version: 7.28.5 + resolution: "@babel/plugin-transform-optional-chaining@npm:7.28.5" dependencies: - "@babel/helper-plugin-utils": ^7.20.2 + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/helper-skip-transparent-expression-wrappers": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 69054c93d744574e06b0244623140718ecba87e1cc34bd5c7bd5824fd4dbef764ac4832046ea1ba5d2c6a2f12e03289555c9f65f0aafae4871f3d740ff61b9ec + checksum: 78c2be52b32e893c992aca52ef84130b3540e2ca0e1ff0e45f8d2ccc213b3c6e2b43f8dd2c86a0976acf3cdff97d4488c23b86d7a3e67daa517013089f44af1d languageName: node linkType: hard -"@babel/plugin-transform-property-literals@npm:^7.0.0, @babel/plugin-transform-property-literals@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-transform-property-literals@npm:7.18.6" +"@babel/plugin-transform-parameters@npm:^7.0.0, @babel/plugin-transform-parameters@npm:^7.12.1, @babel/plugin-transform-parameters@npm:^7.20.7, @babel/plugin-transform-parameters@npm:^7.27.7": + version: 7.27.7 + resolution: "@babel/plugin-transform-parameters@npm:7.27.7" dependencies: - "@babel/helper-plugin-utils": ^7.18.6 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 1c16e64de554703f4b547541de2edda6c01346dd3031d4d29e881aa7733785cd26d53611a4ccf5353f4d3e69097bb0111c0a93ace9e683edd94fea28c4484144 + checksum: d51f195e1d6ac5d9fce583e9a70a5bfe403e62386e5eb06db9fbc6533f895a98ff7e7c3dcaa311a8e6fa7a9794466e81cdabcba6af9f59d787fb767bfe7868b4 languageName: node linkType: hard -"@babel/plugin-transform-react-display-name@npm:^7.0.0, @babel/plugin-transform-react-display-name@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-transform-react-display-name@npm:7.18.6" +"@babel/plugin-transform-private-methods@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-private-methods@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.6 + "@babel/helper-create-class-features-plugin": ^7.27.1 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 51c087ab9e41ef71a29335587da28417536c6f816c292e092ffc0e0985d2f032656801d4dd502213ce32481f4ba6c69402993ffa67f0818a07606ff811e4be49 + checksum: c76f8f6056946466116e67eb9d8014a2d748ade2062636ab82045c1dac9c233aff10e597777bc5af6f26428beb845ceb41b95007abef7d0484da95789da56662 languageName: node linkType: hard -"@babel/plugin-transform-react-jsx-development@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-transform-react-jsx-development@npm:7.18.6" +"@babel/plugin-transform-private-property-in-object@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-private-property-in-object@npm:7.27.1" dependencies: - "@babel/plugin-transform-react-jsx": ^7.18.6 + "@babel/helper-annotate-as-pure": ^7.27.1 + "@babel/helper-create-class-features-plugin": ^7.27.1 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: ec9fa65db66f938b75c45e99584367779ac3e0af8afc589187262e1337c7c4205ea312877813ae4df9fb93d766627b8968d74ac2ba702e4883b1dbbe4953ecee + checksum: af539af1bd423aa46b9da83d649be716494ca80783841f47094b6741fa24e11141446027fd152ddff791dede9d4a76d0d5eb467402a2e584d7f5ea90e2673c7e languageName: node linkType: hard -"@babel/plugin-transform-react-jsx@npm:^7.0.0, @babel/plugin-transform-react-jsx@npm:^7.17.12, @babel/plugin-transform-react-jsx@npm:^7.18.6": - version: 7.19.0 - resolution: "@babel/plugin-transform-react-jsx@npm:7.19.0" +"@babel/plugin-transform-property-literals@npm:^7.0.0, @babel/plugin-transform-property-literals@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-property-literals@npm:7.27.1" dependencies: - "@babel/helper-annotate-as-pure": ^7.18.6 - "@babel/helper-module-imports": ^7.18.6 - "@babel/helper-plugin-utils": ^7.19.0 - "@babel/plugin-syntax-jsx": ^7.18.6 - "@babel/types": ^7.19.0 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: d7d6f0b8f24b1f6b7cf8062c4e91c59af82489a993e51859bd49c2d62a2d2b77fd40b02a9a1d0e6d874cf4ce56a05fa3564b964587d00c94ebc62593524052ec + checksum: 7caec27d5ed8870895c9faf4f71def72745d69da0d8e77903146a4e135fd7bed5778f5f9cebb36c5fba86338e6194dd67a08c033fc84b4299b7eceab6d9630cb languageName: node linkType: hard -"@babel/plugin-transform-react-pure-annotations@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-transform-react-pure-annotations@npm:7.18.6" +"@babel/plugin-transform-react-display-name@npm:^7.0.0, @babel/plugin-transform-react-display-name@npm:^7.28.0": + version: 7.28.0 + resolution: "@babel/plugin-transform-react-display-name@npm:7.28.0" dependencies: - "@babel/helper-annotate-as-pure": ^7.18.6 - "@babel/helper-plugin-utils": ^7.18.6 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 97c4873d409088f437f9084d084615948198dd87fc6723ada0e7e29c5a03623c2f3e03df3f52e7e7d4d23be32a08ea00818bff302812e48713c706713bd06219 + checksum: 268b1a9192974439d17949e170b01cac2a2aa003c844e2fe3b8361146f42f66487178cffdfa8ce862aa9e6c814bc37f879a70300cb3f067815d15fa6aad04e6d languageName: node linkType: hard -"@babel/plugin-transform-regenerator@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-transform-regenerator@npm:7.18.6" +"@babel/plugin-transform-react-jsx-development@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-react-jsx-development@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.6 - regenerator-transform: ^0.15.0 + "@babel/plugin-transform-react-jsx": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 60bd482cb0343c714f85c3e19a13b3b5fa05ee336c079974091c0b35e263307f4e661f4555dff90707a87d5efe19b1d51835db44455405444ac1813e268ad750 + checksum: b88865d5b8c018992f2332da939faa15c4d4a864c9435a5937beaff3fe43781432cc42e0a5d5631098e0bd4066fc33f5fa72203b388b074c3545fe7aaa21e474 languageName: node linkType: hard -"@babel/plugin-transform-reserved-words@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-transform-reserved-words@npm:7.18.6" +"@babel/plugin-transform-react-jsx@npm:^7.0.0, @babel/plugin-transform-react-jsx@npm:^7.17.12, @babel/plugin-transform-react-jsx@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-react-jsx@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.6 + "@babel/helper-annotate-as-pure": ^7.27.1 + "@babel/helper-module-imports": ^7.27.1 + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/plugin-syntax-jsx": ^7.27.1 + "@babel/types": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 0738cdc30abdae07c8ec4b233b30c31f68b3ff0eaa40eddb45ae607c066127f5fa99ddad3c0177d8e2832e3a7d3ad115775c62b431ebd6189c40a951b867a80c + checksum: 960d36e5d11ba68e4fbf1e2b935c153cb6ea7b0004f838aaee8baf7de30462b8f0562743a39ce3c370cc70b8f79d3c549104a415a615b2b0055b71fd025df0f3 languageName: node linkType: hard -"@babel/plugin-transform-runtime@npm:^7.15.0": - version: 7.19.6 - resolution: "@babel/plugin-transform-runtime@npm:7.19.6" - dependencies: - "@babel/helper-module-imports": ^7.18.6 - "@babel/helper-plugin-utils": ^7.19.0 - babel-plugin-polyfill-corejs2: ^0.3.3 - babel-plugin-polyfill-corejs3: ^0.6.0 - babel-plugin-polyfill-regenerator: ^0.4.1 - semver: ^6.3.0 +"@babel/plugin-transform-react-pure-annotations@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-react-pure-annotations@npm:7.27.1" + dependencies: + "@babel/helper-annotate-as-pure": ^7.27.1 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: ef93efbcbb00dcf4da6dcc55bda698a2a57fca3fb05a6a13e932ecfdb7c1c5d2f0b5b245c1c4faca0318853937caba0d82442f58b7653249f64275d08052fbd8 + checksum: a6f591c5e85a1ab0685d4a25afe591fe8d11dc0b73c677cf9560ff8d540d036a1cce9efcb729fc9092def4d854dc304ffdc063a89a9247900b69c516bf971a4c languageName: node linkType: hard -"@babel/plugin-transform-shorthand-properties@npm:^7.0.0, @babel/plugin-transform-shorthand-properties@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-transform-shorthand-properties@npm:7.18.6" +"@babel/plugin-transform-regenerator@npm:^7.28.4": + version: 7.28.4 + resolution: "@babel/plugin-transform-regenerator@npm:7.28.4" dependencies: - "@babel/helper-plugin-utils": ^7.18.6 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: b8e4e8acc2700d1e0d7d5dbfd4fdfb935651913de6be36e6afb7e739d8f9ca539a5150075a0f9b79c88be25ddf45abb912fe7abf525f0b80f5b9d9860de685d7 + checksum: 2aa99b3a7b254a109e913fabbe1fb320ff40723988fde0e225212b7ef20f523a399a6e45077258b176c29715493b2a853cf7c130811692215adf33e5af99782b languageName: node linkType: hard -"@babel/plugin-transform-spread@npm:^7.0.0, @babel/plugin-transform-spread@npm:^7.14.6, @babel/plugin-transform-spread@npm:^7.19.0": - version: 7.19.0 - resolution: "@babel/plugin-transform-spread@npm:7.19.0" +"@babel/plugin-transform-regexp-modifiers@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-regexp-modifiers@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.19.0 - "@babel/helper-skip-transparent-expression-wrappers": ^7.18.9 + "@babel/helper-create-regexp-features-plugin": ^7.27.1 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: - "@babel/core": ^7.0.0-0 - checksum: e73a4deb095999185e70b524d0ff4e35df50fcda58299e700a6149a15bbc1a9b369ef1cef384e15a54b3c3ce316cc0f054dbf249dcd0d1ca59f4281dd4df9718 + "@babel/core": ^7.0.0 + checksum: f6cb385fe0e798bff7e9b20cf5912bf40e180895ff3610b1ccdce260f3c20daaebb3a99dc087c8168a99151cd3e16b94f4689fd5a4b01cf1834b45c133e620b2 languageName: node linkType: hard -"@babel/plugin-transform-sticky-regex@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-transform-sticky-regex@npm:7.18.6" +"@babel/plugin-transform-reserved-words@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-reserved-words@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.6 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 68ea18884ae9723443ffa975eb736c8c0d751265859cd3955691253f7fee37d7a0f7efea96c8a062876af49a257a18ea0ed5fea0d95a7b3611ce40f7ee23aee3 + checksum: dea0b66742d2863b369c06c053e11e15ba785892ea19cccf7aef3c1bdaa38b6ab082e19984c5ea7810d275d9445c5400fcc385ad71ce707ed9256fadb102af3b languageName: node linkType: hard -"@babel/plugin-transform-template-literals@npm:^7.0.0, @babel/plugin-transform-template-literals@npm:^7.18.9": - version: 7.18.9 - resolution: "@babel/plugin-transform-template-literals@npm:7.18.9" +"@babel/plugin-transform-runtime@npm:^7.15.0": + version: 7.28.5 + resolution: "@babel/plugin-transform-runtime@npm:7.28.5" dependencies: - "@babel/helper-plugin-utils": ^7.18.9 + "@babel/helper-module-imports": ^7.27.1 + "@babel/helper-plugin-utils": ^7.27.1 + babel-plugin-polyfill-corejs2: ^0.4.14 + babel-plugin-polyfill-corejs3: ^0.13.0 + babel-plugin-polyfill-regenerator: ^0.6.5 + semver: ^6.3.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 3d2fcd79b7c345917f69b92a85bdc3ddd68ce2c87dc70c7d61a8373546ccd1f5cb8adc8540b49dfba08e1b82bb7b3bbe23a19efdb2b9c994db2db42906ca9fb2 + checksum: 5bb66f366c5bb22d0c890667ecd0f1fde9db86ac04df62b21fc2bbf58531eb84068bb0bf38fb1c496c8f78a917c59a884f6c1f8b205b8689d155e72fcf1d442d languageName: node linkType: hard -"@babel/plugin-transform-typeof-symbol@npm:^7.18.9": - version: 7.18.9 - resolution: "@babel/plugin-transform-typeof-symbol@npm:7.18.9" +"@babel/plugin-transform-shorthand-properties@npm:^7.0.0, @babel/plugin-transform-shorthand-properties@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-shorthand-properties@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.9 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: e754e0d8b8a028c52e10c148088606e3f7a9942c57bd648fc0438e5b4868db73c386a5ed47ab6d6f0594aae29ee5ffc2ffc0f7ebee7fae560a066d6dea811cd4 + checksum: fbba6e2aef0b69681acb68202aa249c0598e470cc0853d7ff5bd0171fd6a7ec31d77cfabcce9df6360fc8349eded7e4a65218c32551bd3fc0caaa1ac899ac6d4 languageName: node linkType: hard -"@babel/plugin-transform-typescript@npm:^7.18.6": - version: 7.20.2 - resolution: "@babel/plugin-transform-typescript@npm:7.20.2" +"@babel/plugin-transform-spread@npm:^7.0.0, @babel/plugin-transform-spread@npm:^7.14.6, @babel/plugin-transform-spread@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-spread@npm:7.27.1" dependencies: - "@babel/helper-create-class-features-plugin": ^7.20.2 - "@babel/helper-plugin-utils": ^7.20.2 - "@babel/plugin-syntax-typescript": ^7.20.0 + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/helper-skip-transparent-expression-wrappers": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 14434eb77cb3c8c4187a055eabdd5ff8b3e90a37ac95ecc7c9007ea8fc5660e0652c445646a2a25836a02d91944e0dc1e8b58ef55b063a901e54a24fdb4168af + checksum: 58b08085ee9c29955ac3b68d61c1a79728d44d19a69cb5eb669794aeaf54c57c6647af7b979c1297e81ede3d08b3ddcb1936ef39a533f28ff3e399a9be54dab1 languageName: node linkType: hard -"@babel/plugin-transform-unicode-escapes@npm:^7.18.10": - version: 7.18.10 - resolution: "@babel/plugin-transform-unicode-escapes@npm:7.18.10" +"@babel/plugin-transform-sticky-regex@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-sticky-regex@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.9 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: f5baca55cb3c11bc08ec589f5f522d85c1ab509b4d11492437e45027d64ae0b22f0907bd1381e8d7f2a436384bb1f9ad89d19277314242c5c2671a0f91d0f9cd + checksum: e1414a502efba92c7974681767e365a8cda6c5e9e5f33472a9eaa0ce2e75cea0a9bef881ff8dda37c7810ad902f98d3c00ead92a3ac3b73a79d011df85b5a189 languageName: node linkType: hard -"@babel/plugin-transform-unicode-regex@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/plugin-transform-unicode-regex@npm:7.18.6" +"@babel/plugin-transform-template-literals@npm:^7.0.0, @babel/plugin-transform-template-literals@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-template-literals@npm:7.27.1" dependencies: - "@babel/helper-create-regexp-features-plugin": ^7.18.6 - "@babel/helper-plugin-utils": ^7.18.6 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: d9e18d57536a2d317fb0b7c04f8f55347f3cfacb75e636b4c6fa2080ab13a3542771b5120e726b598b815891fc606d1472ac02b749c69fd527b03847f22dc25e + checksum: 93aad782503b691faef7c0893372d5243df3219b07f1f22cfc32c104af6a2e7acd6102c128439eab15336d048f1b214ca134b87b0630d8cd568bf447f78b25ce languageName: node linkType: hard -"@babel/preset-env@npm:^7.15.4": - version: 7.20.2 - resolution: "@babel/preset-env@npm:7.20.2" +"@babel/plugin-transform-typeof-symbol@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-typeof-symbol@npm:7.27.1" dependencies: - "@babel/compat-data": ^7.20.1 - "@babel/helper-compilation-targets": ^7.20.0 - "@babel/helper-plugin-utils": ^7.20.2 - "@babel/helper-validator-option": ^7.18.6 - "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": ^7.18.6 - "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": ^7.18.9 - "@babel/plugin-proposal-async-generator-functions": ^7.20.1 - "@babel/plugin-proposal-class-properties": ^7.18.6 - "@babel/plugin-proposal-class-static-block": ^7.18.6 - "@babel/plugin-proposal-dynamic-import": ^7.18.6 - "@babel/plugin-proposal-export-namespace-from": ^7.18.9 - "@babel/plugin-proposal-json-strings": ^7.18.6 - "@babel/plugin-proposal-logical-assignment-operators": ^7.18.9 - "@babel/plugin-proposal-nullish-coalescing-operator": ^7.18.6 - "@babel/plugin-proposal-numeric-separator": ^7.18.6 - "@babel/plugin-proposal-object-rest-spread": ^7.20.2 - "@babel/plugin-proposal-optional-catch-binding": ^7.18.6 - "@babel/plugin-proposal-optional-chaining": ^7.18.9 - "@babel/plugin-proposal-private-methods": ^7.18.6 - "@babel/plugin-proposal-private-property-in-object": ^7.18.6 - "@babel/plugin-proposal-unicode-property-regex": ^7.18.6 - "@babel/plugin-syntax-async-generators": ^7.8.4 - "@babel/plugin-syntax-class-properties": ^7.12.13 - "@babel/plugin-syntax-class-static-block": ^7.14.5 - "@babel/plugin-syntax-dynamic-import": ^7.8.3 - "@babel/plugin-syntax-export-namespace-from": ^7.8.3 - "@babel/plugin-syntax-import-assertions": ^7.20.0 - "@babel/plugin-syntax-json-strings": ^7.8.3 - "@babel/plugin-syntax-logical-assignment-operators": ^7.10.4 - "@babel/plugin-syntax-nullish-coalescing-operator": ^7.8.3 - "@babel/plugin-syntax-numeric-separator": ^7.10.4 - "@babel/plugin-syntax-object-rest-spread": ^7.8.3 - "@babel/plugin-syntax-optional-catch-binding": ^7.8.3 - "@babel/plugin-syntax-optional-chaining": ^7.8.3 - "@babel/plugin-syntax-private-property-in-object": ^7.14.5 - "@babel/plugin-syntax-top-level-await": ^7.14.5 - "@babel/plugin-transform-arrow-functions": ^7.18.6 - "@babel/plugin-transform-async-to-generator": ^7.18.6 - "@babel/plugin-transform-block-scoped-functions": ^7.18.6 - "@babel/plugin-transform-block-scoping": ^7.20.2 - "@babel/plugin-transform-classes": ^7.20.2 - "@babel/plugin-transform-computed-properties": ^7.18.9 - "@babel/plugin-transform-destructuring": ^7.20.2 - "@babel/plugin-transform-dotall-regex": ^7.18.6 - "@babel/plugin-transform-duplicate-keys": ^7.18.9 - "@babel/plugin-transform-exponentiation-operator": ^7.18.6 - "@babel/plugin-transform-for-of": ^7.18.8 - "@babel/plugin-transform-function-name": ^7.18.9 - "@babel/plugin-transform-literals": ^7.18.9 - "@babel/plugin-transform-member-expression-literals": ^7.18.6 - "@babel/plugin-transform-modules-amd": ^7.19.6 - "@babel/plugin-transform-modules-commonjs": ^7.19.6 - "@babel/plugin-transform-modules-systemjs": ^7.19.6 - "@babel/plugin-transform-modules-umd": ^7.18.6 - "@babel/plugin-transform-named-capturing-groups-regex": ^7.19.1 - "@babel/plugin-transform-new-target": ^7.18.6 - "@babel/plugin-transform-object-super": ^7.18.6 - "@babel/plugin-transform-parameters": ^7.20.1 - "@babel/plugin-transform-property-literals": ^7.18.6 - "@babel/plugin-transform-regenerator": ^7.18.6 - "@babel/plugin-transform-reserved-words": ^7.18.6 - "@babel/plugin-transform-shorthand-properties": ^7.18.6 - "@babel/plugin-transform-spread": ^7.19.0 - "@babel/plugin-transform-sticky-regex": ^7.18.6 - "@babel/plugin-transform-template-literals": ^7.18.9 - "@babel/plugin-transform-typeof-symbol": ^7.18.9 - "@babel/plugin-transform-unicode-escapes": ^7.18.10 - "@babel/plugin-transform-unicode-regex": ^7.18.6 - "@babel/preset-modules": ^0.1.5 - "@babel/types": ^7.20.2 - babel-plugin-polyfill-corejs2: ^0.3.3 - babel-plugin-polyfill-corejs3: ^0.6.0 - babel-plugin-polyfill-regenerator: ^0.4.1 - core-js-compat: ^3.25.1 - semver: ^6.3.0 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: ece2d7e9c7789db6116e962b8e1a55eb55c110c44c217f0c8f6ffea4ca234954e66557f7bd019b7affadf7fbb3a53ccc807e93fc935aacd48146234b73b6947e + checksum: ed8048c8de72c60969a64cf2273cc6d9275d8fa8db9bd25a1268273a00fb9cbd79931140311411bda1443aa56cb3961fb911d1795abacde7f0482f1d8fdf0356 languageName: node linkType: hard -"@babel/preset-modules@npm:^0.1.5": - version: 0.1.5 - resolution: "@babel/preset-modules@npm:0.1.5" +"@babel/plugin-transform-typescript@npm:^7.28.5": + version: 7.28.5 + resolution: "@babel/plugin-transform-typescript@npm:7.28.5" dependencies: - "@babel/helper-plugin-utils": ^7.0.0 - "@babel/plugin-proposal-unicode-property-regex": ^7.4.4 - "@babel/plugin-transform-dotall-regex": ^7.4.4 - "@babel/types": ^7.4.4 - esutils: ^2.0.2 + "@babel/helper-annotate-as-pure": ^7.27.3 + "@babel/helper-create-class-features-plugin": ^7.28.5 + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/helper-skip-transparent-expression-wrappers": ^7.27.1 + "@babel/plugin-syntax-typescript": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 8430e0e9e9d520b53e22e8c4c6a5a080a12b63af6eabe559c2310b187bd62ae113f3da82ba33e9d1d0f3230930ca702843aae9dd226dec51f7d7114dc1f51c10 + checksum: 202785e9cc6fb04efba091b3d5560cc8089cdc54df12fafa3d32ed7089e8d7a95b92b2fb1b53ec3e4db3bbafe56e8b32a3530cac004b3e493e902def8666001d languageName: node linkType: hard -"@babel/preset-react@npm:^7.14.0": - version: 7.18.6 - resolution: "@babel/preset-react@npm:7.18.6" +"@babel/plugin-transform-unicode-escapes@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-unicode-escapes@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.6 - "@babel/helper-validator-option": ^7.18.6 - "@babel/plugin-transform-react-display-name": ^7.18.6 - "@babel/plugin-transform-react-jsx": ^7.18.6 - "@babel/plugin-transform-react-jsx-development": ^7.18.6 - "@babel/plugin-transform-react-pure-annotations": ^7.18.6 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 540d9cf0a0cc0bb07e6879994e6fb7152f87dafbac880b56b65e2f528134c7ba33e0cd140b58700c77b2ebf4c81fa6468fed0ba391462d75efc7f8c1699bb4c3 + checksum: d817154bc10758ddd85b716e0bc1af1a1091e088400289ab6b78a1a4d609907ce3d2f1fd51a6fd0e0c8ecbb5f8e3aab4957e0747776d132d2379e85c3ef0520a languageName: node linkType: hard -"@babel/preset-typescript@npm:^7.15.0, @babel/preset-typescript@npm:^7.16.7": - version: 7.18.6 - resolution: "@babel/preset-typescript@npm:7.18.6" +"@babel/plugin-transform-unicode-property-regex@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-unicode-property-regex@npm:7.27.1" dependencies: - "@babel/helper-plugin-utils": ^7.18.6 - "@babel/helper-validator-option": ^7.18.6 - "@babel/plugin-transform-typescript": ^7.18.6 + "@babel/helper-create-regexp-features-plugin": ^7.27.1 + "@babel/helper-plugin-utils": ^7.27.1 peerDependencies: "@babel/core": ^7.0.0-0 - checksum: 7fe0da5103eb72d3cf39cf3e138a794c8cdd19c0b38e3e101507eef519c46a87a0d6d0e8bc9e28a13ea2364001ebe7430b9d75758aab4c3c3a8db9a487b9dc7c + checksum: 5d99c89537d1ebaac3f526c04b162cf95a47d363d4829f78c6701a2c06ab78a48da66a94f853f85f44a3d72153410ba923e072bed4b7166fa097f503eb14131d languageName: node linkType: hard -"@babel/runtime@npm:^7.0.0, @babel/runtime@npm:^7.12.5, @babel/runtime@npm:^7.15.4, @babel/runtime@npm:^7.17.8, @babel/runtime@npm:^7.18.0, @babel/runtime@npm:^7.18.3, @babel/runtime@npm:^7.18.9, @babel/runtime@npm:^7.20.7, @babel/runtime@npm:^7.7.2, @babel/runtime@npm:^7.7.7, @babel/runtime@npm:^7.8.4, @babel/runtime@npm:^7.9.2": - version: 7.26.10 - resolution: "@babel/runtime@npm:7.26.10" +"@babel/plugin-transform-unicode-regex@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-unicode-regex@npm:7.27.1" dependencies: - regenerator-runtime: ^0.14.0 - checksum: 22d2e0abb86e90de489ab16bb578db6fe2b63a88696db431198b24963749820c723f1982298cdbbea187f7b2b80fb4d98a514faf114ddb2fdc14a4b96277b955 + "@babel/helper-create-regexp-features-plugin": ^7.27.1 + "@babel/helper-plugin-utils": ^7.27.1 + peerDependencies: + "@babel/core": ^7.0.0-0 + checksum: a34d89a2b75fb78e66d97c3dc90d4877f7e31f43316b52176f95a5dee20e9bb56ecf158eafc42a001676ddf7b393d9e67650bad6b32f5405780f25fb83cd68e3 languageName: node linkType: hard -"@babel/template@npm:^7.12.7, @babel/template@npm:^7.16.7, @babel/template@npm:^7.18.10": - version: 7.18.10 - resolution: "@babel/template@npm:7.18.10" +"@babel/plugin-transform-unicode-sets-regex@npm:^7.27.1": + version: 7.27.1 + resolution: "@babel/plugin-transform-unicode-sets-regex@npm:7.27.1" dependencies: - "@babel/code-frame": ^7.18.6 - "@babel/parser": ^7.18.10 - "@babel/types": ^7.18.10 - checksum: 93a6aa094af5f355a72bd55f67fa1828a046c70e46f01b1606e6118fa1802b6df535ca06be83cc5a5e834022be95c7b714f0a268b5f20af984465a71e28f1473 + "@babel/helper-create-regexp-features-plugin": ^7.27.1 + "@babel/helper-plugin-utils": ^7.27.1 + peerDependencies: + "@babel/core": ^7.0.0 + checksum: 295126074c7388ab05c82ef3ed0907a1ee4666bbdd763477ead9aba6eb2c74bdf65669416861ac93d337a4a27640963bb214acadc2697275ce95aab14868d57f + languageName: node + linkType: hard + +"@babel/preset-env@npm:^7.15.4": + version: 7.28.5 + resolution: "@babel/preset-env@npm:7.28.5" + dependencies: + "@babel/compat-data": ^7.28.5 + "@babel/helper-compilation-targets": ^7.27.2 + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/helper-validator-option": ^7.27.1 + "@babel/plugin-bugfix-firefox-class-in-computed-class-key": ^7.28.5 + "@babel/plugin-bugfix-safari-class-field-initializer-scope": ^7.27.1 + "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": ^7.27.1 + "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": ^7.27.1 + "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": ^7.28.3 + "@babel/plugin-proposal-private-property-in-object": 7.21.0-placeholder-for-preset-env.2 + "@babel/plugin-syntax-import-assertions": ^7.27.1 + "@babel/plugin-syntax-import-attributes": ^7.27.1 + "@babel/plugin-syntax-unicode-sets-regex": ^7.18.6 + "@babel/plugin-transform-arrow-functions": ^7.27.1 + "@babel/plugin-transform-async-generator-functions": ^7.28.0 + "@babel/plugin-transform-async-to-generator": ^7.27.1 + "@babel/plugin-transform-block-scoped-functions": ^7.27.1 + "@babel/plugin-transform-block-scoping": ^7.28.5 + "@babel/plugin-transform-class-properties": ^7.27.1 + "@babel/plugin-transform-class-static-block": ^7.28.3 + "@babel/plugin-transform-classes": ^7.28.4 + "@babel/plugin-transform-computed-properties": ^7.27.1 + "@babel/plugin-transform-destructuring": ^7.28.5 + "@babel/plugin-transform-dotall-regex": ^7.27.1 + "@babel/plugin-transform-duplicate-keys": ^7.27.1 + "@babel/plugin-transform-duplicate-named-capturing-groups-regex": ^7.27.1 + "@babel/plugin-transform-dynamic-import": ^7.27.1 + "@babel/plugin-transform-explicit-resource-management": ^7.28.0 + "@babel/plugin-transform-exponentiation-operator": ^7.28.5 + "@babel/plugin-transform-export-namespace-from": ^7.27.1 + "@babel/plugin-transform-for-of": ^7.27.1 + "@babel/plugin-transform-function-name": ^7.27.1 + "@babel/plugin-transform-json-strings": ^7.27.1 + "@babel/plugin-transform-literals": ^7.27.1 + "@babel/plugin-transform-logical-assignment-operators": ^7.28.5 + "@babel/plugin-transform-member-expression-literals": ^7.27.1 + "@babel/plugin-transform-modules-amd": ^7.27.1 + "@babel/plugin-transform-modules-commonjs": ^7.27.1 + "@babel/plugin-transform-modules-systemjs": ^7.28.5 + "@babel/plugin-transform-modules-umd": ^7.27.1 + "@babel/plugin-transform-named-capturing-groups-regex": ^7.27.1 + "@babel/plugin-transform-new-target": ^7.27.1 + "@babel/plugin-transform-nullish-coalescing-operator": ^7.27.1 + "@babel/plugin-transform-numeric-separator": ^7.27.1 + "@babel/plugin-transform-object-rest-spread": ^7.28.4 + "@babel/plugin-transform-object-super": ^7.27.1 + "@babel/plugin-transform-optional-catch-binding": ^7.27.1 + "@babel/plugin-transform-optional-chaining": ^7.28.5 + "@babel/plugin-transform-parameters": ^7.27.7 + "@babel/plugin-transform-private-methods": ^7.27.1 + "@babel/plugin-transform-private-property-in-object": ^7.27.1 + "@babel/plugin-transform-property-literals": ^7.27.1 + "@babel/plugin-transform-regenerator": ^7.28.4 + "@babel/plugin-transform-regexp-modifiers": ^7.27.1 + "@babel/plugin-transform-reserved-words": ^7.27.1 + "@babel/plugin-transform-shorthand-properties": ^7.27.1 + "@babel/plugin-transform-spread": ^7.27.1 + "@babel/plugin-transform-sticky-regex": ^7.27.1 + "@babel/plugin-transform-template-literals": ^7.27.1 + "@babel/plugin-transform-typeof-symbol": ^7.27.1 + "@babel/plugin-transform-unicode-escapes": ^7.27.1 + "@babel/plugin-transform-unicode-property-regex": ^7.27.1 + "@babel/plugin-transform-unicode-regex": ^7.27.1 + "@babel/plugin-transform-unicode-sets-regex": ^7.27.1 + "@babel/preset-modules": 0.1.6-no-external-plugins + babel-plugin-polyfill-corejs2: ^0.4.14 + babel-plugin-polyfill-corejs3: ^0.13.0 + babel-plugin-polyfill-regenerator: ^0.6.5 + core-js-compat: ^3.43.0 + semver: ^6.3.1 + peerDependencies: + "@babel/core": ^7.0.0-0 + checksum: 9e17ba89c5d8cbea0fde564ea29e6dc17ad43f6ebf1c11347af69a04cf69dbc62c3124d2afe46412bfa41dddde3aaabfeffc0d68bed96f6ea0c4d8fbf652e761 languageName: node linkType: hard -"@babel/template@npm:^7.24.7": - version: 7.24.7 - resolution: "@babel/template@npm:7.24.7" +"@babel/preset-modules@npm:0.1.6-no-external-plugins": + version: 0.1.6-no-external-plugins + resolution: "@babel/preset-modules@npm:0.1.6-no-external-plugins" dependencies: - "@babel/code-frame": ^7.24.7 - "@babel/parser": ^7.24.7 - "@babel/types": ^7.24.7 - checksum: ea90792fae708ddf1632e54c25fe1a86643d8c0132311f81265d2bdbdd42f9f4fac65457056c1b6ca87f7aa0d6a795b549566774bba064bdcea2034ab3960ee9 + "@babel/helper-plugin-utils": ^7.0.0 + "@babel/types": ^7.4.4 + esutils: ^2.0.2 + peerDependencies: + "@babel/core": ^7.0.0-0 || ^8.0.0-0 <8.0.0 + checksum: 4855e799bc50f2449fb5210f78ea9e8fd46cf4f242243f1e2ed838e2bd702e25e73e822e7f8447722a5f4baa5e67a8f7a0e403f3e7ce04540ff743a9c411c375 languageName: node linkType: hard -"@babel/template@npm:^7.26.9": - version: 7.26.9 - resolution: "@babel/template@npm:7.26.9" +"@babel/preset-react@npm:^7.14.0": + version: 7.28.5 + resolution: "@babel/preset-react@npm:7.28.5" dependencies: - "@babel/code-frame": ^7.26.2 - "@babel/parser": ^7.26.9 - "@babel/types": ^7.26.9 - checksum: 32259298c775e543ab994daff0c758b3d6a184349b146d6497aa46cec5907bc47a6bc09e7295a81a5eccfbd023d4811a9777cb5d698d582d09a87cabf5b576e7 + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/helper-validator-option": ^7.27.1 + "@babel/plugin-transform-react-display-name": ^7.28.0 + "@babel/plugin-transform-react-jsx": ^7.27.1 + "@babel/plugin-transform-react-jsx-development": ^7.27.1 + "@babel/plugin-transform-react-pure-annotations": ^7.27.1 + peerDependencies: + "@babel/core": ^7.0.0-0 + checksum: 13bc1fe4dde0a29d00323e46749e5beb457844507cb3afa2fefbd85d283c2d4836f9e4a780be735de58a44c505870476dc2838f1f8faf9d6f056481e65f1a0fb languageName: node linkType: hard -"@babel/traverse@npm:^7.12.9, @babel/traverse@npm:^7.14.0, @babel/traverse@npm:^7.15.4, @babel/traverse@npm:^7.16.8, @babel/traverse@npm:^7.19.0, @babel/traverse@npm:^7.19.1, @babel/traverse@npm:^7.20.1, @babel/traverse@npm:^7.4.5": - version: 7.24.8 - resolution: "@babel/traverse@npm:7.24.8" +"@babel/preset-typescript@npm:^7.15.0, @babel/preset-typescript@npm:^7.16.7": + version: 7.28.5 + resolution: "@babel/preset-typescript@npm:7.28.5" dependencies: - "@babel/code-frame": ^7.24.7 - "@babel/generator": ^7.24.8 - "@babel/helper-environment-visitor": ^7.24.7 - "@babel/helper-function-name": ^7.24.7 - "@babel/helper-hoist-variables": ^7.24.7 - "@babel/helper-split-export-declaration": ^7.24.7 - "@babel/parser": ^7.24.8 - "@babel/types": ^7.24.8 - debug: ^4.3.1 - globals: ^11.1.0 - checksum: ee7955476ce031613249f2b0ce9e74a3b7787c9d52e84534fcf39ad61aeb0b811a4cd83edc157608be4886f04c6ecf210861e211ba2a3db4fda729cc2048b5ed + "@babel/helper-plugin-utils": ^7.27.1 + "@babel/helper-validator-option": ^7.27.1 + "@babel/plugin-syntax-jsx": ^7.27.1 + "@babel/plugin-transform-modules-commonjs": ^7.27.1 + "@babel/plugin-transform-typescript": ^7.28.5 + peerDependencies: + "@babel/core": ^7.0.0-0 + checksum: 22f889835d9db1e627846e71ca2f02e2d24e2eb9ebcf9845b3b1d37bd3a53787967bafabbbcb342f06aaf7627399a7102ba6ca18f9a0e17066c865d680d2ceb9 + languageName: node + linkType: hard + +"@babel/runtime@npm:^7.0.0, @babel/runtime@npm:^7.12.18, @babel/runtime@npm:^7.12.5, @babel/runtime@npm:^7.15.4, @babel/runtime@npm:^7.17.8, @babel/runtime@npm:^7.18.0, @babel/runtime@npm:^7.18.3, @babel/runtime@npm:^7.18.9, @babel/runtime@npm:^7.21.0, @babel/runtime@npm:^7.7.2, @babel/runtime@npm:^7.9.2": + version: 7.28.4 + resolution: "@babel/runtime@npm:7.28.4" + checksum: 934b0a0460f7d06637d93fcd1a44ac49adc33518d17253b5a0b55ff4cb90a45d8fe78bf034b448911dbec7aff2a90b918697559f78d21c99ff8dbadae9565b55 languageName: node linkType: hard -"@babel/types@npm:^7.0.0, @babel/types@npm:^7.0.0-beta.49, @babel/types@npm:^7.12.7, @babel/types@npm:^7.15.4, @babel/types@npm:^7.16.8, @babel/types@npm:^7.18.10, @babel/types@npm:^7.18.6, @babel/types@npm:^7.18.9, @babel/types@npm:^7.19.0, @babel/types@npm:^7.20.0, @babel/types@npm:^7.20.2, @babel/types@npm:^7.4.4, @babel/types@npm:^7.8.3": - version: 7.20.2 - resolution: "@babel/types@npm:7.20.2" +"@babel/template@npm:^7.12.7, @babel/template@npm:^7.16.7, @babel/template@npm:^7.27.1, @babel/template@npm:^7.27.2": + version: 7.27.2 + resolution: "@babel/template@npm:7.27.2" dependencies: - "@babel/helper-string-parser": ^7.19.4 - "@babel/helper-validator-identifier": ^7.19.1 - to-fast-properties: ^2.0.0 - checksum: 57e76e5f21876135f481bfd4010c87f2d38196bb0a2bc60a28d6e55e3afa90cdd9accf164e4cb71bdfb620517fa0a0cb5600cdce36c21d59fdaccfbb899c024c + "@babel/code-frame": ^7.27.1 + "@babel/parser": ^7.27.2 + "@babel/types": ^7.27.1 + checksum: ff5628bc066060624afd970616090e5bba91c6240c2e4b458d13267a523572cbfcbf549391eec8217b94b064cf96571c6273f0c04b28a8567b96edc675c28e27 languageName: node linkType: hard -"@babel/types@npm:^7.24.7, @babel/types@npm:^7.24.8, @babel/types@npm:^7.24.9": - version: 7.24.9 - resolution: "@babel/types@npm:7.24.9" +"@babel/traverse@npm:^7.12.9, @babel/traverse@npm:^7.14.0, @babel/traverse@npm:^7.15.4, @babel/traverse@npm:^7.16.8, @babel/traverse@npm:^7.27.1, @babel/traverse@npm:^7.28.0, @babel/traverse@npm:^7.28.3, @babel/traverse@npm:^7.28.4, @babel/traverse@npm:^7.28.5, @babel/traverse@npm:^7.4.5": + version: 7.28.5 + resolution: "@babel/traverse@npm:7.28.5" dependencies: - "@babel/helper-string-parser": ^7.24.8 - "@babel/helper-validator-identifier": ^7.24.7 - to-fast-properties: ^2.0.0 - checksum: 15cb05c45be5d4c49a749575d3742bd005d0e2e850c13fb462754983a5bc1063fbc8f6566246fc064e3e8b21a5a75a37a948f1b3f27189cc90b236fee93f5e51 + "@babel/code-frame": ^7.27.1 + "@babel/generator": ^7.28.5 + "@babel/helper-globals": ^7.28.0 + "@babel/parser": ^7.28.5 + "@babel/template": ^7.27.2 + "@babel/types": ^7.28.5 + debug: ^4.3.1 + checksum: e028ee9654f44be7c2a2df268455cee72d5c424c9ae536785f8f7c8680356f7b977c77ad76909d07eeed09ff1e125ce01cf783011f66b56c838791a85fa6af04 languageName: node linkType: hard -"@babel/types@npm:^7.26.10, @babel/types@npm:^7.26.9": - version: 7.26.10 - resolution: "@babel/types@npm:7.26.10" +"@babel/types@npm:^7.0.0, @babel/types@npm:^7.0.0-beta.49, @babel/types@npm:^7.12.7, @babel/types@npm:^7.15.4, @babel/types@npm:^7.16.8, @babel/types@npm:^7.27.1, @babel/types@npm:^7.27.3, @babel/types@npm:^7.28.2, @babel/types@npm:^7.28.4, @babel/types@npm:^7.28.5, @babel/types@npm:^7.4.4": + version: 7.28.5 + resolution: "@babel/types@npm:7.28.5" dependencies: - "@babel/helper-string-parser": ^7.25.9 - "@babel/helper-validator-identifier": ^7.25.9 - checksum: 07340068ea3824dcaccf702dfc9628175c9926912ad6efba182d8b07e20953297d0a514f6fb103a61b9d5c555c8b87fc2237ddb06efebe14794eefc921dfa114 + "@babel/helper-string-parser": ^7.27.1 + "@babel/helper-validator-identifier": ^7.28.5 + checksum: 5bc266af9e55ff92f9ddf33d83a42c9de1a87f9579d0ed62ef94a741a081692dd410a4fbbab18d514b83e135083ff05bc0e37003834801c9514b9d8ad748070d languageName: node linkType: hard @@ -1991,130 +1843,124 @@ __metadata: languageName: node linkType: hard -"@emotion/babel-plugin-jsx-pragmatic@npm:^0.2.0": - version: 0.2.0 - resolution: "@emotion/babel-plugin-jsx-pragmatic@npm:0.2.0" +"@emotion/babel-plugin-jsx-pragmatic@npm:^0.3.0": + version: 0.3.0 + resolution: "@emotion/babel-plugin-jsx-pragmatic@npm:0.3.0" dependencies: "@babel/plugin-syntax-jsx": ^7.17.12 peerDependencies: "@babel/core": ^7.0.0 - checksum: fb7a386ff1335ba09f8db5617c14b87ed844beda181fa9eaf5516328a39ec2f1cfc9d332d53b4378682a869f375f63eaeedfcb18490cd2fd19b70433ffe9487b + checksum: 7e37c5ae1ec7a7a113463cee92f0aa3db2dd51cb9f1f0e859cf8c47a4f4a2fde1bed0196e8d6beff8e73b2a25b6ada38f9e3ba6a58ba96a0b19d0660ec570c60 languageName: node linkType: hard -"@emotion/babel-plugin@npm:^11.10.0, @emotion/babel-plugin@npm:^11.10.5": - version: 11.10.5 - resolution: "@emotion/babel-plugin@npm:11.10.5" +"@emotion/babel-plugin@npm:^11.12.0, @emotion/babel-plugin@npm:^11.13.5": + version: 11.13.5 + resolution: "@emotion/babel-plugin@npm:11.13.5" dependencies: "@babel/helper-module-imports": ^7.16.7 - "@babel/plugin-syntax-jsx": ^7.17.12 "@babel/runtime": ^7.18.3 - "@emotion/hash": ^0.9.0 - "@emotion/memoize": ^0.8.0 - "@emotion/serialize": ^1.1.1 + "@emotion/hash": ^0.9.2 + "@emotion/memoize": ^0.9.0 + "@emotion/serialize": ^1.3.3 babel-plugin-macros: ^3.1.0 convert-source-map: ^1.5.0 escape-string-regexp: ^4.0.0 find-root: ^1.1.0 source-map: ^0.5.7 - stylis: 4.1.3 - peerDependencies: - "@babel/core": ^7.0.0 - checksum: e3353499c76c4422d6e900c0dfab73607056d9da86161a3f27c3459c193c4908050c5d252c68fcde231e13f02a9d8e0dc07d260317ae0e5206841e331cc4caae + stylis: 4.2.0 + checksum: c41df7e6c19520e76d1939f884be878bf88b5ba00bd3de9d05c5b6c5baa5051686ab124d7317a0645de1b017b574d8139ae1d6390ec267fbe8e85a5252afb542 languageName: node linkType: hard "@emotion/babel-preset-css-prop@npm:^11.2.0": - version: 11.10.0 - resolution: "@emotion/babel-preset-css-prop@npm:11.10.0" + version: 11.12.0 + resolution: "@emotion/babel-preset-css-prop@npm:11.12.0" dependencies: "@babel/plugin-transform-react-jsx": ^7.17.12 "@babel/runtime": ^7.18.3 - "@emotion/babel-plugin": ^11.10.0 - "@emotion/babel-plugin-jsx-pragmatic": ^0.2.0 + "@emotion/babel-plugin": ^11.12.0 + "@emotion/babel-plugin-jsx-pragmatic": ^0.3.0 peerDependencies: "@babel/core": ^7.0.0 - checksum: 09d91e89ec5edf105ddcdfcbac5aa45c2c0c19213ee6fcf95fd570ca395b965022fe03a5483802e00eea2436983609cef2b2fcc88169b0a923a8e2c92411ec89 + checksum: 69ab7f374e521ae2a80163edfca0179d2f65886e8a9f80028ab88e8d29f798772b0225834f6f138ac00ccdde7cd701ec8a74a28e371c0e6b055d8f1554bda360 languageName: node linkType: hard -"@emotion/cache@npm:^11.10.5": - version: 11.10.5 - resolution: "@emotion/cache@npm:11.10.5" +"@emotion/cache@npm:^11.14.0": + version: 11.14.0 + resolution: "@emotion/cache@npm:11.14.0" dependencies: - "@emotion/memoize": ^0.8.0 - "@emotion/sheet": ^1.2.1 - "@emotion/utils": ^1.2.0 - "@emotion/weak-memoize": ^0.3.0 - stylis: 4.1.3 - checksum: 1dd2d9af2d3ecbd3d4469ecdf91a335eef6034c851b57a474471b2d2280613eb35bbed98c0368cc4625f188619fbdaf04cf07e8107aaffce94b2178444c0fe7b + "@emotion/memoize": ^0.9.0 + "@emotion/sheet": ^1.4.0 + "@emotion/utils": ^1.4.2 + "@emotion/weak-memoize": ^0.4.0 + stylis: 4.2.0 + checksum: 0a81591541ea43bc7851742e6444b7800d72e98006f94e775ae6ea0806662d14e0a86ff940f5f19d33b4bb2c427c882aa65d417e7322a6e0d5f20fe65ed920c9 languageName: node linkType: hard -"@emotion/hash@npm:^0.9.0": - version: 0.9.0 - resolution: "@emotion/hash@npm:0.9.0" - checksum: b63428f7c8186607acdca5d003700cecf0ded519d0b5c5cc3b3154eafcad6ff433f8361bd2bac8882715b557e6f06945694aeb6ba8b25c6095d7a88570e2e0bb +"@emotion/hash@npm:^0.9.2": + version: 0.9.2 + resolution: "@emotion/hash@npm:0.9.2" + checksum: 379bde2830ccb0328c2617ec009642321c0e009a46aa383dfbe75b679c6aea977ca698c832d225a893901f29d7b3eef0e38cf341f560f6b2b56f1ff23c172387 languageName: node linkType: hard "@emotion/is-prop-valid@npm:^1.1.0": - version: 1.2.0 - resolution: "@emotion/is-prop-valid@npm:1.2.0" + version: 1.4.0 + resolution: "@emotion/is-prop-valid@npm:1.4.0" dependencies: - "@emotion/memoize": ^0.8.0 - checksum: cc7a19850a4c5b24f1514665289442c8c641709e6f7711067ad550e05df331da0692a16148e85eda6f47e31b3261b64d74c5e25194d053223be16231f969d633 + "@emotion/memoize": ^0.9.0 + checksum: 6b003cdc62106c2d5d12207c2d1352d674339252a2d7ac8d96974781d7c639833f35d22e7e331411795daaafa62f126c2824a4983584292b431e08b42877d51e languageName: node linkType: hard -"@emotion/memoize@npm:^0.8.0": - version: 0.8.0 - resolution: "@emotion/memoize@npm:0.8.0" - checksum: c87bb110b829edd8e1c13b90a6bc37cebc39af29c7599a1e66a48e06f9bec43e8e53495ba86278cc52e7589549492c8dfdc81d19f4fdec0cee6ba13d2ad2c928 +"@emotion/memoize@npm:^0.9.0": + version: 0.9.0 + resolution: "@emotion/memoize@npm:0.9.0" + checksum: 038132359397348e378c593a773b1148cd0cf0a2285ffd067a0f63447b945f5278860d9de718f906a74c7c940ba1783ac2ca18f1c06a307b01cc0e3944e783b1 languageName: node linkType: hard "@emotion/react@npm:^11.10.4": - version: 11.10.5 - resolution: "@emotion/react@npm:11.10.5" + version: 11.14.0 + resolution: "@emotion/react@npm:11.14.0" dependencies: "@babel/runtime": ^7.18.3 - "@emotion/babel-plugin": ^11.10.5 - "@emotion/cache": ^11.10.5 - "@emotion/serialize": ^1.1.1 - "@emotion/use-insertion-effect-with-fallbacks": ^1.0.0 - "@emotion/utils": ^1.2.0 - "@emotion/weak-memoize": ^0.3.0 + "@emotion/babel-plugin": ^11.13.5 + "@emotion/cache": ^11.14.0 + "@emotion/serialize": ^1.3.3 + "@emotion/use-insertion-effect-with-fallbacks": ^1.2.0 + "@emotion/utils": ^1.4.2 + "@emotion/weak-memoize": ^0.4.0 hoist-non-react-statics: ^3.3.1 peerDependencies: - "@babel/core": ^7.0.0 react: ">=16.8.0" peerDependenciesMeta: - "@babel/core": - optional: true "@types/react": optional: true - checksum: 32b67b28e9b6d6c53b970072680697f04c2521441050bdeb19a1a7f0164af549b4dad39ff375eda1b6a3cf1cc86ba2c6fa55460ec040e6ebbca3e9ec58353cf7 + checksum: 3cf023b11d132b56168713764d6fced8e5a1f0687dfe0caa2782dfd428c8f9e30f9826a919965a311d87b523cd196722aaf75919cd0f6bd0fd57f8a6a0281500 languageName: node linkType: hard -"@emotion/serialize@npm:^1.1.1": - version: 1.1.1 - resolution: "@emotion/serialize@npm:1.1.1" +"@emotion/serialize@npm:^1.3.3": + version: 1.3.3 + resolution: "@emotion/serialize@npm:1.3.3" dependencies: - "@emotion/hash": ^0.9.0 - "@emotion/memoize": ^0.8.0 - "@emotion/unitless": ^0.8.0 - "@emotion/utils": ^1.2.0 + "@emotion/hash": ^0.9.2 + "@emotion/memoize": ^0.9.0 + "@emotion/unitless": ^0.10.0 + "@emotion/utils": ^1.4.2 csstype: ^3.0.2 - checksum: 24cfd5b16e6f2335c032ca33804a876e0442aaf8f9c94d269d23735ebd194fb1ed142542dd92191a3e6ef8bad5bd560dfc5aaf363a1b70954726dbd4dd93085c + checksum: 510331233767ae4e09e925287ca2c7269b320fa1d737ea86db5b3c861a734483ea832394c0c1fe5b21468fe335624a75e72818831d303ba38125f54f44ba02e7 languageName: node linkType: hard -"@emotion/sheet@npm:^1.2.1": - version: 1.2.1 - resolution: "@emotion/sheet@npm:1.2.1" - checksum: ce78763588ea522438156344d9f592203e2da582d8d67b32e1b0b98eaba26994c6c270f8c7ad46442fc9c0a9f048685d819cd73ca87e544520fd06f0e24a1562 +"@emotion/sheet@npm:^1.4.0": + version: 1.4.0 + resolution: "@emotion/sheet@npm:1.4.0" + checksum: eeb1212e3289db8e083e72e7e401cd6d1a84deece87e9ce184f7b96b9b5dbd6f070a89057255a6ff14d9865c3ce31f27c39248a053e4cdd875540359042586b4 languageName: node linkType: hard @@ -2125,6 +1971,13 @@ __metadata: languageName: node linkType: hard +"@emotion/unitless@npm:^0.10.0": + version: 0.10.0 + resolution: "@emotion/unitless@npm:0.10.0" + checksum: d79346df31a933e6d33518e92636afeb603ce043f3857d0a39a2ac78a09ef0be8bedff40130930cb25df1beeee12d96ee38613963886fa377c681a89970b787c + languageName: node + linkType: hard + "@emotion/unitless@npm:^0.7.4": version: 0.7.5 resolution: "@emotion/unitless@npm:0.7.5" @@ -2132,33 +1985,26 @@ __metadata: languageName: node linkType: hard -"@emotion/unitless@npm:^0.8.0": - version: 0.8.0 - resolution: "@emotion/unitless@npm:0.8.0" - checksum: 176141117ed23c0eb6e53a054a69c63e17ae532ec4210907a20b2208f91771821835f1c63dd2ec63e30e22fcc984026d7f933773ee6526dd038e0850919fae7a - languageName: node - linkType: hard - -"@emotion/use-insertion-effect-with-fallbacks@npm:^1.0.0": - version: 1.0.0 - resolution: "@emotion/use-insertion-effect-with-fallbacks@npm:1.0.0" +"@emotion/use-insertion-effect-with-fallbacks@npm:^1.2.0": + version: 1.2.0 + resolution: "@emotion/use-insertion-effect-with-fallbacks@npm:1.2.0" peerDependencies: react: ">=16.8.0" - checksum: 4f06a3b48258c832aa8022a262572061a31ff078d377e9164cccc99951309d70f4466e774fe704461b2f8715007a82ed625a54a5c7a127c89017d3ce3187d4f1 + checksum: 8ff6aec7f2924526ff8c8f8f93d4b8236376e2e12c435314a18c9a373016e24dfdf984e82bbc83712b8e90ff4783cd765eb39fc7050d1a43245e5728740ddd71 languageName: node linkType: hard -"@emotion/utils@npm:^1.2.0": - version: 1.2.0 - resolution: "@emotion/utils@npm:1.2.0" - checksum: 55457a49ddd4db6a014ea0454dc09eaa23eedfb837095c8ff90470cb26a303f7ceb5fcc1e2190ef64683e64cfd33d3ba3ca3109cd87d12bc9e379e4195c9a4dd +"@emotion/utils@npm:^1.4.2": + version: 1.4.2 + resolution: "@emotion/utils@npm:1.4.2" + checksum: 04cf76849c6401205c058b82689fd0ec5bf501aed6974880fe9681a1d61543efb97e848f4c38664ac4a9068c7ad2d1cb84f73bde6cf95f1208aa3c28e0190321 languageName: node linkType: hard -"@emotion/weak-memoize@npm:^0.3.0": - version: 0.3.0 - resolution: "@emotion/weak-memoize@npm:0.3.0" - checksum: f43ef4c8b7de70d9fa5eb3105921724651e4188e895beb71f0c5919dc899a7b8743e1fdd99d38b9092dd5722c7be2312ebb47fbdad0c4e38bea58f6df5885cc0 +"@emotion/weak-memoize@npm:^0.4.0": + version: 0.4.0 + resolution: "@emotion/weak-memoize@npm:0.4.0" + checksum: db5da0e89bd752c78b6bd65a1e56231f0abebe2f71c0bd8fc47dff96408f7065b02e214080f99924f6a3bfe7ee15afc48dad999d76df86b39b16e513f7a94f52 languageName: node linkType: hard @@ -2180,16 +2026,9 @@ __metadata: linkType: hard "@exodus/schemasafe@npm:^1.0.0-rc.2": - version: 1.0.0-rc.9 - resolution: "@exodus/schemasafe@npm:1.0.0-rc.9" - checksum: e013b0921e1cdb55468fc72034fd9447634b7732bcb3cfe9311d499801ed682309ef463b4d65a3f6c972e0f8dfb364d8b9556a752e9f17df7d02f8d6e84cf2c9 - languageName: node - linkType: hard - -"@gar/promisify@npm:^1.1.3": - version: 1.1.3 - resolution: "@gar/promisify@npm:1.1.3" - checksum: 4059f790e2d07bf3c3ff3e0fec0daa8144fe35c1f6e0111c9921bd32106adaa97a4ab096ad7dab1e28ee6a9060083c4d1a4ada42a7f5f3f7a96b8812e2b757c1 + version: 1.3.0 + resolution: "@exodus/schemasafe@npm:1.3.0" + checksum: 5fa00ce28d142dc39e07d8080e7967e77125bfdf59af31975b7e6395ca5265e2a8540ab7d8cc89abf8c0a483560f8dbb2994761115c995d2c473ab4b6ec74dba languageName: node linkType: hard @@ -2240,32 +2079,32 @@ __metadata: linkType: hard "@graphql-codegen/add@npm:^3.1.1": - version: 3.2.1 - resolution: "@graphql-codegen/add@npm:3.2.1" + version: 3.2.3 + resolution: "@graphql-codegen/add@npm:3.2.3" dependencies: - "@graphql-codegen/plugin-helpers": ^2.6.2 + "@graphql-codegen/plugin-helpers": ^3.1.1 tslib: ~2.4.0 peerDependencies: graphql: ^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 - checksum: 4f9c645a3cf4b6e64c8ea5cbaba95075df2f485e3fea5b2c369bcf898272d0a6665b3eb0b541dc57d3d8400b23610848c8348a469e472db1a1c558d61580dca0 + checksum: 98b1b17104b7e2fa82e9ed30e21160b02cce530d0ff72ce7794478677168ac6381a8d814cdd25d60b41b91b6446ebd592ba4820bd5ac138016f9097fa6ebc483 languageName: node linkType: hard "@graphql-codegen/core@npm:^2.5.1": - version: 2.6.5 - resolution: "@graphql-codegen/core@npm:2.6.5" + version: 2.6.8 + resolution: "@graphql-codegen/core@npm:2.6.8" dependencies: - "@graphql-codegen/plugin-helpers": ^2.7.2 + "@graphql-codegen/plugin-helpers": ^3.1.1 "@graphql-tools/schema": ^9.0.0 - "@graphql-tools/utils": 9.0.0 + "@graphql-tools/utils": ^9.1.1 tslib: ~2.4.0 peerDependencies: graphql: ^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 - checksum: 22a30285af6adf5acd8ed2f45363c77b718a1789f024094a4fcc62fc164440f0fed595b5eecfa216e3568a81ba07dd8f2e6111cb49f2ce46160b14167a330c41 + checksum: 33a222798fd99adcaf5d6d48fcd6949798a62d7a25e9b2af5b13e4def3de4338e5a743e5ea87661d2b32ae3279e3ad8b555d0e212efe86018088cb85a7d59d6a languageName: node linkType: hard -"@graphql-codegen/plugin-helpers@npm:^2.4.2, @graphql-codegen/plugin-helpers@npm:^2.6.2, @graphql-codegen/plugin-helpers@npm:^2.7.2": +"@graphql-codegen/plugin-helpers@npm:^2.4.2": version: 2.7.2 resolution: "@graphql-codegen/plugin-helpers@npm:2.7.2" dependencies: @@ -2281,96 +2120,113 @@ __metadata: languageName: node linkType: hard -"@graphql-codegen/schema-ast@npm:^2.5.1": - version: 2.5.1 - resolution: "@graphql-codegen/schema-ast@npm:2.5.1" +"@graphql-codegen/plugin-helpers@npm:^3.1.1, @graphql-codegen/plugin-helpers@npm:^3.1.2": + version: 3.1.2 + resolution: "@graphql-codegen/plugin-helpers@npm:3.1.2" dependencies: - "@graphql-codegen/plugin-helpers": ^2.6.2 - "@graphql-tools/utils": ^8.8.0 + "@graphql-tools/utils": ^9.0.0 + change-case-all: 1.0.15 + common-tags: 1.8.2 + import-from: 4.0.0 + lodash: ~4.17.0 + tslib: ~2.4.0 + peerDependencies: + graphql: ^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 + checksum: 4d0c615738570681b5ffd3c07305a35d6aa3e5fd87c9199c0a670b95529ab865b1df978ce584d5b415107a567ac484e56a48db129a6d1d2eb8a254fbd3260e39 + languageName: node + linkType: hard + +"@graphql-codegen/schema-ast@npm:^2.6.1": + version: 2.6.1 + resolution: "@graphql-codegen/schema-ast@npm:2.6.1" + dependencies: + "@graphql-codegen/plugin-helpers": ^3.1.2 + "@graphql-tools/utils": ^9.0.0 tslib: ~2.4.0 peerDependencies: graphql: ^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 - checksum: a488c4a35e360f46444fb140ef3b5dffdea1e70549060ce6c2dad6f39c0b3c2cf2bcd797bcec8084f20a3ea4b5ab3e8221b1418e4195d9baf392819425bdd300 + checksum: f44338ac66e6a1f6238c33cdf65778bb467fe5a93767988135cb4e112d3be4d3c7e8aeeffe323754e8d6b0cbc5a52cb71452bfc42a15bc7031ebaa9b3d5da676 languageName: node linkType: hard "@graphql-codegen/typescript-operations@npm:^2.3.5": - version: 2.5.6 - resolution: "@graphql-codegen/typescript-operations@npm:2.5.6" + version: 2.5.13 + resolution: "@graphql-codegen/typescript-operations@npm:2.5.13" dependencies: - "@graphql-codegen/plugin-helpers": ^2.7.2 - "@graphql-codegen/typescript": ^2.8.1 - "@graphql-codegen/visitor-plugin-common": 2.13.1 + "@graphql-codegen/plugin-helpers": ^3.1.2 + "@graphql-codegen/typescript": ^2.8.8 + "@graphql-codegen/visitor-plugin-common": 2.13.8 auto-bind: ~4.0.0 tslib: ~2.4.0 peerDependencies: graphql: ^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 - checksum: 8551b312fc96aba6d6168a6ece613ccb05c07786383f966655335c41f5f72d740f9ccf5f6128e8d9ab92bbd5d4a44adec263b8f452cfc94465db0c4246b086ff + checksum: c36d75b1b0101d8e6e65949e7ad6b068b3595d95d35c20c3d2506f35b5b11c00ca91d7b0c40005de3a6c38fa6a858e27ab4729b1068721eafe79d90b5d721cfc languageName: node linkType: hard -"@graphql-codegen/typescript@npm:^2.4.8, @graphql-codegen/typescript@npm:^2.8.1": - version: 2.8.1 - resolution: "@graphql-codegen/typescript@npm:2.8.1" +"@graphql-codegen/typescript@npm:^2.4.8, @graphql-codegen/typescript@npm:^2.8.8": + version: 2.8.8 + resolution: "@graphql-codegen/typescript@npm:2.8.8" dependencies: - "@graphql-codegen/plugin-helpers": ^2.7.2 - "@graphql-codegen/schema-ast": ^2.5.1 - "@graphql-codegen/visitor-plugin-common": 2.13.1 + "@graphql-codegen/plugin-helpers": ^3.1.2 + "@graphql-codegen/schema-ast": ^2.6.1 + "@graphql-codegen/visitor-plugin-common": 2.13.8 auto-bind: ~4.0.0 tslib: ~2.4.0 peerDependencies: graphql: ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 - checksum: 2b5466190e385c557eed6210b861fb9e632fb61b90bd0f97ff983f359c0ad8106228667c9ff2201842100417a07cfaffa91794ef03058a151df256d733363fa2 + checksum: ebc338bc88fd239b9ef70d900778791af2c68f7a0fa074d870cc5fcaee3ea182dfce8a1f366f53bcd5e81f95bb9e26e00e1b41e6b2ad3305cf7e6f44bf57d649 languageName: node linkType: hard -"@graphql-codegen/visitor-plugin-common@npm:2.13.1": - version: 2.13.1 - resolution: "@graphql-codegen/visitor-plugin-common@npm:2.13.1" +"@graphql-codegen/visitor-plugin-common@npm:2.13.8": + version: 2.13.8 + resolution: "@graphql-codegen/visitor-plugin-common@npm:2.13.8" dependencies: - "@graphql-codegen/plugin-helpers": ^2.7.2 + "@graphql-codegen/plugin-helpers": ^3.1.2 "@graphql-tools/optimize": ^1.3.0 "@graphql-tools/relay-operation-optimizer": ^6.5.0 - "@graphql-tools/utils": ^8.8.0 + "@graphql-tools/utils": ^9.0.0 auto-bind: ~4.0.0 - change-case-all: 1.0.14 + change-case-all: 1.0.15 dependency-graph: ^0.11.0 graphql-tag: ^2.11.0 parse-filepath: ^1.0.2 tslib: ~2.4.0 peerDependencies: graphql: ^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 - checksum: 0c329aa6e435602f2f6c1569ec2091b7850f58cc5dca7ac763c38c82588545ec1110c1de587f5f3949b11ff96f94401d1e63e329607d78424583b276fd08f1ae + checksum: 4ca8074bfb84a7c6f88216c2b327a600b57da35eae9b659656592c48f197e44004dcc5c2ab500a5d3a94e2753f47903e5e113162c8a362de08e307e564d416a5 languageName: node linkType: hard "@graphql-tools/code-file-loader@npm:^7.2.14": - version: 7.3.11 - resolution: "@graphql-tools/code-file-loader@npm:7.3.11" + version: 7.3.23 + resolution: "@graphql-tools/code-file-loader@npm:7.3.23" dependencies: - "@graphql-tools/graphql-tag-pluck": 7.3.11 - "@graphql-tools/utils": 9.1.0 + "@graphql-tools/graphql-tag-pluck": 7.5.2 + "@graphql-tools/utils": ^9.2.1 globby: ^11.0.3 tslib: ^2.4.0 unixify: ^1.0.0 peerDependencies: graphql: ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 - checksum: bd255fa59966632b76caf40d23af8e1b313ea6e3cbe8c9ca97619676abba9f2585ff28d429d2160843a9b2c8ac0297c5e414c3140062deee2840500dce45ba0f + checksum: fb1dfa807b9d5798936c7fe31cf5356412d9b5a25a08d5952b607921637afbe26555cb662cf97f82dfdf47ed8e7c2a42f527238fb2defd3be4505e15fb6027c3 languageName: node linkType: hard -"@graphql-tools/graphql-tag-pluck@npm:7.3.11": - version: 7.3.11 - resolution: "@graphql-tools/graphql-tag-pluck@npm:7.3.11" +"@graphql-tools/graphql-tag-pluck@npm:7.5.2": + version: 7.5.2 + resolution: "@graphql-tools/graphql-tag-pluck@npm:7.5.2" dependencies: "@babel/parser": ^7.16.8 + "@babel/plugin-syntax-import-assertions": ^7.20.0 "@babel/traverse": ^7.16.8 "@babel/types": ^7.16.8 - "@graphql-tools/utils": 9.1.0 + "@graphql-tools/utils": ^9.2.1 tslib: ^2.4.0 peerDependencies: graphql: ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 - checksum: c40ba65f8ce7ecdac86b5fc5059385dbe9e5f4e9345617926b5f321e32a3601ad6e6856d41311f99e93c4a8ef219a0af7d476087f8bf6cfa971a2dfed3de1356 + checksum: fbe2419f97ca700bb5f3fa7ff7a4ecab2519732339c2f5807ff0fc33dcb50e3b6e921b6c0b285992b34e95cb812d514f0d62d82f9275a8c074bcaff64cbff7bb languageName: node linkType: hard @@ -2388,88 +2244,119 @@ __metadata: linkType: hard "@graphql-tools/load@npm:^7.5.10": - version: 7.8.5 - resolution: "@graphql-tools/load@npm:7.8.5" + version: 7.8.14 + resolution: "@graphql-tools/load@npm:7.8.14" dependencies: - "@graphql-tools/schema": 9.0.9 - "@graphql-tools/utils": 9.1.0 + "@graphql-tools/schema": ^9.0.18 + "@graphql-tools/utils": ^9.2.1 p-limit: 3.1.0 tslib: ^2.4.0 peerDependencies: graphql: ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 - checksum: fc2107f792d66ebc7bbdf8e267326367b60065c1721db7b61b476d1e1bd3ad86dd8f89c8afd54e8918cca7a4bc8e9c37229293b0dd3dc6112afebd45e6824478 + checksum: 12ffd6460da3d996d614faa3ced99f526247334bb671301b15ed1d2153314a8813f734d863086d154891ac4b35da090668f0ea7702508d19f8dd0f72413b585c languageName: node linkType: hard -"@graphql-tools/merge@npm:8.3.11, @graphql-tools/merge@npm:^8.1.2": - version: 8.3.11 - resolution: "@graphql-tools/merge@npm:8.3.11" +"@graphql-tools/merge@npm:^8.1.2, @graphql-tools/merge@npm:^8.4.1": + version: 8.4.2 + resolution: "@graphql-tools/merge@npm:8.4.2" dependencies: - "@graphql-tools/utils": 9.1.0 + "@graphql-tools/utils": ^9.2.1 tslib: ^2.4.0 peerDependencies: graphql: ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 - checksum: 3cd16577f1ea1bcc389d232fa620adc0fefc91a6b42b48e7bb5e7bb67b67d206d409a9a8d60cac4d8cd5f0f1c5353369f7c5eb4054b44ce2277545e1fd1de17f + checksum: 96d57a3e810055a2883bf9d3450e88082da207ffb1406222c9fa954e47bac4a328696785fdb7eec95a030d5f75504f7b4c6484c94f248cee13e6ad25aca70c75 + languageName: node + linkType: hard + +"@graphql-tools/merge@npm:^9.1.7": + version: 9.1.7 + resolution: "@graphql-tools/merge@npm:9.1.7" + dependencies: + "@graphql-tools/utils": ^11.0.0 + tslib: ^2.4.0 + peerDependencies: + graphql: ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 + checksum: 5b215c27bac3f8ea145dbe6b4e235f1a04f15dc90fb17782cb7bb9aef8cd799750fc4ef5af5cb5f8dfd171e0f70266b8fd8eb81dd110fdedc783b34c408f2c87 languageName: node linkType: hard "@graphql-tools/optimize@npm:^1.3.0": - version: 1.3.1 - resolution: "@graphql-tools/optimize@npm:1.3.1" + version: 1.4.0 + resolution: "@graphql-tools/optimize@npm:1.4.0" + dependencies: + tslib: ^2.4.0 + peerDependencies: + graphql: ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 + checksum: bccbc596f2007ae706ee948e900f3174aa80ef043e8ae3467f735a10df0b31873bafdd20c0ef09b662171363a31e2d0859adb362bbf762da00245f8e9fd501b0 + languageName: node + linkType: hard + +"@graphql-tools/relay-operation-optimizer@npm:^6.5.0": + version: 6.5.18 + resolution: "@graphql-tools/relay-operation-optimizer@npm:6.5.18" dependencies: + "@ardatan/relay-compiler": 12.0.0 + "@graphql-tools/utils": ^9.2.1 tslib: ^2.4.0 peerDependencies: graphql: ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 - checksum: 4eed041bc3199a70ab426eeb10bc4af65f18fa0c5907613aec236fd7e14918d0f895e12489df6ff501562415eef64c99777a3ca6f6a4ee3c796b68e7cb778342 + checksum: 56a8c7e6a0bf5fa4d5106276f69c08630a95659eb4300249b3dd28e2057ebb7e7815c51beadf98acdbf695cad5937988d16a3d01ca74fc120c76892968fbeb2b languageName: node linkType: hard -"@graphql-tools/relay-operation-optimizer@npm:^6.5.0": - version: 6.5.11 - resolution: "@graphql-tools/relay-operation-optimizer@npm:6.5.11" +"@graphql-tools/schema@npm:^10.0.6": + version: 10.0.31 + resolution: "@graphql-tools/schema@npm:10.0.31" dependencies: - "@ardatan/relay-compiler": 12.0.0 - "@graphql-tools/utils": 9.1.0 + "@graphql-tools/merge": ^9.1.7 + "@graphql-tools/utils": ^11.0.0 tslib: ^2.4.0 peerDependencies: graphql: ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 - checksum: 406d1ad4e17d9a87052319bc921a6935d30547dbd6d813d4e1dc6f9c9e90362ee2e7d34fa99f9633d1f7e1235bcce50d88e56c58d03f3063fb4869b32ae5cdec + checksum: 935b5132d9927f24099168718691e21975529faae39526cee88f4de7c0d2a87edde7ba4f1795411a1ad5fe993fd3f7ce913e3a2aeb723fdd8d6888dbe678c16d languageName: node linkType: hard -"@graphql-tools/schema@npm:9.0.9, @graphql-tools/schema@npm:^9.0.0, @graphql-tools/schema@npm:^9.0.1": - version: 9.0.9 - resolution: "@graphql-tools/schema@npm:9.0.9" +"@graphql-tools/schema@npm:^9.0.0, @graphql-tools/schema@npm:^9.0.18": + version: 9.0.19 + resolution: "@graphql-tools/schema@npm:9.0.19" dependencies: - "@graphql-tools/merge": 8.3.11 - "@graphql-tools/utils": 9.1.0 + "@graphql-tools/merge": ^8.4.1 + "@graphql-tools/utils": ^9.2.1 tslib: ^2.4.0 - value-or-promise: 1.0.11 + value-or-promise: ^1.0.12 peerDependencies: graphql: ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 - checksum: 23620a993eff57723302315100d947b81664d6a1e00010ff293b3649f51ab423946d73920cce0ce822b7f7f42b99ea23240902ff47df3d252639613c0df7b971 + checksum: 1be91f61bf4be0c1c9aa640a6ad5b58328d5434d15e78ba73a47263420939db6741ad6723dece4611257e7e1e56518e116b76513a3014305d3f52d67aafb62fb languageName: node linkType: hard -"@graphql-tools/utils@npm:9.0.0": - version: 9.0.0 - resolution: "@graphql-tools/utils@npm:9.0.0" +"@graphql-tools/utils@npm:^10.6.1": + version: 10.11.0 + resolution: "@graphql-tools/utils@npm:10.11.0" dependencies: + "@graphql-typed-document-node/core": ^3.1.1 + "@whatwg-node/promise-helpers": ^1.0.0 + cross-inspect: 1.0.1 tslib: ^2.4.0 peerDependencies: graphql: ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 - checksum: 8da22b13e0cfceac20f2ee08c45f360d0bd1390fa0edd8496ea75a0ca7d10ab3bbafca6b4b0dbc3f233a05cd53096e3063b9208f727c72db00e461751164afbd + checksum: 09ad7639dc9d3bbb7aeb87bfb5f88c171b353c2c4014d4bb928676360c2af18c352d9a0dc7ca15d0dcd7b70ed0a601fa1e56fa93fa65e522285201c49a704320 languageName: node linkType: hard -"@graphql-tools/utils@npm:9.1.0": - version: 9.1.0 - resolution: "@graphql-tools/utils@npm:9.1.0" +"@graphql-tools/utils@npm:^11.0.0": + version: 11.0.0 + resolution: "@graphql-tools/utils@npm:11.0.0" dependencies: + "@graphql-typed-document-node/core": ^3.1.1 + "@whatwg-node/promise-helpers": ^1.0.0 + cross-inspect: 1.0.1 tslib: ^2.4.0 peerDependencies: graphql: ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 - checksum: dcf08df3bd1715e25e3b80bf2dd332376239ebcd2a9b93f4d6b72a7bd3feffe2207b9683bb8fcaed9d0d1286f701d0686fe99ac803b91c0df54509b869c0554d + checksum: 70e05b8a5e024c181bb3113d54563793100ef62702138373e3e84cfff4e896bdb725193a5ef4621c8ec263d11456c0cfce8ba51f953d76ffe26837c262e4c2c5 languageName: node linkType: hard @@ -2484,7 +2371,7 @@ __metadata: languageName: node linkType: hard -"@graphql-tools/utils@npm:^9.1.1": +"@graphql-tools/utils@npm:^9.0.0, @graphql-tools/utils@npm:^9.1.1, @graphql-tools/utils@npm:^9.2.1": version: 9.2.1 resolution: "@graphql-tools/utils@npm:9.2.1" dependencies: @@ -2497,22 +2384,22 @@ __metadata: linkType: hard "@graphql-typed-document-node/core@npm:^3.1.1": - version: 3.1.1 - resolution: "@graphql-typed-document-node/core@npm:3.1.1" + version: 3.2.0 + resolution: "@graphql-typed-document-node/core@npm:3.2.0" peerDependencies: - graphql: ^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 - checksum: 87ff4cee308f1075f4472b80f9f9409667979940f8f701e87f0aa35ce5cf104d94b41258ea8192d05a0893475cd0f086a3929a07663b4fe8d0e805a277f07ed5 + graphql: ^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 + checksum: fa44443accd28c8cf4cb96aaaf39d144a22e8b091b13366843f4e97d19c7bfeaf609ce3c7603a4aeffe385081eaf8ea245d078633a7324c11c5ec4b2011bb76d languageName: node linkType: hard -"@hapi/hoek@npm:^9.0.0": +"@hapi/hoek@npm:^9.0.0, @hapi/hoek@npm:^9.3.0": version: 9.3.0 resolution: "@hapi/hoek@npm:9.3.0" checksum: 4771c7a776242c3c022b168046af4e324d116a9d2e1d60631ee64f474c6e38d1bb07092d898bf95c7bc5d334c5582798a1456321b2e53ca817d4e7c88bc25b43 languageName: node linkType: hard -"@hapi/topo@npm:^5.0.0": +"@hapi/topo@npm:^5.1.0": version: 5.1.0 resolution: "@hapi/topo@npm:5.1.0" dependencies: @@ -2714,6 +2601,22 @@ __metadata: languageName: node linkType: hard +"@isaacs/balanced-match@npm:^4.0.1": + version: 4.0.1 + resolution: "@isaacs/balanced-match@npm:4.0.1" + checksum: 102fbc6d2c0d5edf8f6dbf2b3feb21695a21bc850f11bc47c4f06aa83bd8884fde3fe9d6d797d619901d96865fdcb4569ac2a54c937992c48885c5e3d9967fe8 + languageName: node + linkType: hard + +"@isaacs/brace-expansion@npm:^5.0.0": + version: 5.0.0 + resolution: "@isaacs/brace-expansion@npm:5.0.0" + dependencies: + "@isaacs/balanced-match": ^4.0.1 + checksum: d7a3b8b0ddbf0ccd8eeb1300e29dd0a0c02147e823d8138f248375a365682360620895c66d113e05ee02389318c654379b0e538b996345b83c914941786705b1 + languageName: node + linkType: hard + "@isaacs/cliui@npm:^8.0.2": version: 8.0.2 resolution: "@isaacs/cliui@npm:8.0.2" @@ -2728,6 +2631,15 @@ __metadata: languageName: node linkType: hard +"@isaacs/fs-minipass@npm:^4.0.0": + version: 4.0.1 + resolution: "@isaacs/fs-minipass@npm:4.0.1" + dependencies: + minipass: ^7.0.4 + checksum: 5d36d289960e886484362d9eb6a51d1ea28baed5f5d0140bbe62b99bac52eaf06cc01c2bc0d3575977962f84f6b2c4387b043ee632216643d4787b0999465bf2 + languageName: node + linkType: hard + "@jimp/bmp@npm:^0.14.0": version: 0.14.0 resolution: "@jimp/bmp@npm:0.14.0" @@ -3152,42 +3064,23 @@ __metadata: languageName: node linkType: hard -"@jridgewell/gen-mapping@npm:^0.1.0": - version: 0.1.1 - resolution: "@jridgewell/gen-mapping@npm:0.1.1" - dependencies: - "@jridgewell/set-array": ^1.0.0 - "@jridgewell/sourcemap-codec": ^1.4.10 - checksum: 3bcc21fe786de6ffbf35c399a174faab05eb23ce6a03e8769569de28abbf4facc2db36a9ddb0150545ae23a8d35a7cf7237b2aa9e9356a7c626fb4698287d5cc - languageName: node - linkType: hard - -"@jridgewell/gen-mapping@npm:^0.3.0, @jridgewell/gen-mapping@npm:^0.3.2": - version: 0.3.2 - resolution: "@jridgewell/gen-mapping@npm:0.3.2" +"@jridgewell/gen-mapping@npm:^0.3.12, @jridgewell/gen-mapping@npm:^0.3.5": + version: 0.3.13 + resolution: "@jridgewell/gen-mapping@npm:0.3.13" dependencies: - "@jridgewell/set-array": ^1.0.1 - "@jridgewell/sourcemap-codec": ^1.4.10 - "@jridgewell/trace-mapping": ^0.3.9 - checksum: 1832707a1c476afebe4d0fbbd4b9434fdb51a4c3e009ab1e9938648e21b7a97049fa6009393bdf05cab7504108413441df26d8a3c12193996e65493a4efb6882 + "@jridgewell/sourcemap-codec": ^1.5.0 + "@jridgewell/trace-mapping": ^0.3.24 + checksum: f2105acefc433337145caa3c84bba286de954f61c0bc46279bbd85a9e6a02871089717fa060413cfb6a9d44189fe8313b2d1cabf3a2eb3284d208fd5f75c54ff languageName: node linkType: hard -"@jridgewell/gen-mapping@npm:^0.3.5": - version: 0.3.5 - resolution: "@jridgewell/gen-mapping@npm:0.3.5" +"@jridgewell/remapping@npm:^2.3.5": + version: 2.3.5 + resolution: "@jridgewell/remapping@npm:2.3.5" dependencies: - "@jridgewell/set-array": ^1.2.1 - "@jridgewell/sourcemap-codec": ^1.4.10 + "@jridgewell/gen-mapping": ^0.3.5 "@jridgewell/trace-mapping": ^0.3.24 - checksum: ff7a1764ebd76a5e129c8890aa3e2f46045109dabde62b0b6c6a250152227647178ff2069ea234753a690d8f3c4ac8b5e7b267bbee272bffb7f3b0a370ab6e52 - languageName: node - linkType: hard - -"@jridgewell/resolve-uri@npm:3.1.0": - version: 3.1.0 - resolution: "@jridgewell/resolve-uri@npm:3.1.0" - checksum: b5ceaaf9a110fcb2780d1d8f8d4a0bfd216702f31c988d8042e5f8fbe353c55d9b0f55a1733afdc64806f8e79c485d2464680ac48a0d9fcadb9548ee6b81d267 + checksum: 4a66a7397c3dc9c6b5c14a0024b1f98c5e1d90a0dbc1e5955b5038f2db339904df2a0ee8a66559fafb4fc23ff33700a2639fd40bbdd2e9e82b58b3bdf83738e3 languageName: node linkType: hard @@ -3198,71 +3091,30 @@ __metadata: languageName: node linkType: hard -"@jridgewell/set-array@npm:^1.0.0, @jridgewell/set-array@npm:^1.0.1": - version: 1.1.2 - resolution: "@jridgewell/set-array@npm:1.1.2" - checksum: 69a84d5980385f396ff60a175f7177af0b8da4ddb81824cb7016a9ef914eee9806c72b6b65942003c63f7983d4f39a5c6c27185bbca88eb4690b62075602e28e - languageName: node - linkType: hard - -"@jridgewell/set-array@npm:^1.2.1": - version: 1.2.1 - resolution: "@jridgewell/set-array@npm:1.2.1" - checksum: 832e513a85a588f8ed4f27d1279420d8547743cc37fcad5a5a76fc74bb895b013dfe614d0eed9cb860048e6546b798f8f2652020b4b2ba0561b05caa8c654b10 - languageName: node - linkType: hard - -"@jridgewell/source-map@npm:^0.3.2": - version: 0.3.2 - resolution: "@jridgewell/source-map@npm:0.3.2" - dependencies: - "@jridgewell/gen-mapping": ^0.3.0 - "@jridgewell/trace-mapping": ^0.3.9 - checksum: 1b83f0eb944e77b70559a394d5d3b3f98a81fcc186946aceb3ef42d036762b52ef71493c6c0a3b7c1d2f08785f53ba2df1277fe629a06e6109588ff4cdcf7482 - languageName: node - linkType: hard - "@jridgewell/source-map@npm:^0.3.3": - version: 0.3.6 - resolution: "@jridgewell/source-map@npm:0.3.6" + version: 0.3.11 + resolution: "@jridgewell/source-map@npm:0.3.11" dependencies: "@jridgewell/gen-mapping": ^0.3.5 "@jridgewell/trace-mapping": ^0.3.25 - checksum: c9dc7d899397df95e3c9ec287b93c0b56f8e4453cd20743e2b9c8e779b1949bc3cccf6c01bb302779e46560eb45f62ea38d19fedd25370d814734268450a9f30 - languageName: node - linkType: hard - -"@jridgewell/sourcemap-codec@npm:1.4.14, @jridgewell/sourcemap-codec@npm:^1.4.10": - version: 1.4.14 - resolution: "@jridgewell/sourcemap-codec@npm:1.4.14" - checksum: 61100637b6d173d3ba786a5dff019e1a74b1f394f323c1fee337ff390239f053b87266c7a948777f4b1ee68c01a8ad0ab61e5ff4abb5a012a0b091bec391ab97 - languageName: node - linkType: hard - -"@jridgewell/sourcemap-codec@npm:^1.4.14": - version: 1.5.0 - resolution: "@jridgewell/sourcemap-codec@npm:1.5.0" - checksum: 05df4f2538b3b0f998ea4c1cd34574d0feba216fa5d4ccaef0187d12abf82eafe6021cec8b49f9bb4d90f2ba4582ccc581e72986a5fcf4176ae0cfeb04cf52ec + checksum: c8a0011cc67e701f270fa042e32b312f382c413bcc70ca9c03684687cbf5b64d5eed87d4afa36dddaabe60ab3da6db4935f878febd9cfc7f82724ea1a114d344 languageName: node linkType: hard -"@jridgewell/trace-mapping@npm:^0.3.13, @jridgewell/trace-mapping@npm:^0.3.14, @jridgewell/trace-mapping@npm:^0.3.9": - version: 0.3.17 - resolution: "@jridgewell/trace-mapping@npm:0.3.17" - dependencies: - "@jridgewell/resolve-uri": 3.1.0 - "@jridgewell/sourcemap-codec": 1.4.14 - checksum: 9d703b859cff5cd83b7308fd457a431387db5db96bd781a63bf48e183418dd9d3d44e76b9e4ae13237f6abeeb25d739ec9215c1d5bfdd08f66f750a50074a339 +"@jridgewell/sourcemap-codec@npm:^1.4.14, @jridgewell/sourcemap-codec@npm:^1.5.0": + version: 1.5.5 + resolution: "@jridgewell/sourcemap-codec@npm:1.5.5" + checksum: c2e36e67971f719a8a3a85ef5a5f580622437cc723c35d03ebd0c9c0b06418700ef006f58af742791f71f6a4fc68fcfaf1f6a74ec2f9a3332860e9373459dae7 languageName: node linkType: hard -"@jridgewell/trace-mapping@npm:^0.3.20, @jridgewell/trace-mapping@npm:^0.3.24, @jridgewell/trace-mapping@npm:^0.3.25": - version: 0.3.25 - resolution: "@jridgewell/trace-mapping@npm:0.3.25" +"@jridgewell/trace-mapping@npm:^0.3.13, @jridgewell/trace-mapping@npm:^0.3.24, @jridgewell/trace-mapping@npm:^0.3.25, @jridgewell/trace-mapping@npm:^0.3.28": + version: 0.3.31 + resolution: "@jridgewell/trace-mapping@npm:0.3.31" dependencies: "@jridgewell/resolve-uri": ^3.1.0 "@jridgewell/sourcemap-codec": ^1.4.14 - checksum: 9d3c40d225e139987b50c48988f8717a54a8c994d8a948ee42e1412e08988761d0754d7d10b803061cc3aebf35f92a5dbbab493bd0e1a9ef9e89a2130e83ba34 + checksum: af8fda2431348ad507fbddf8e25f5d08c79ecc94594061ce402cf41bc5aba1a7b3e59bf0fd70a619b35f33983a3f488ceeba8faf56bff784f98bb5394a8b7d47 languageName: node linkType: hard @@ -3273,19 +3125,19 @@ __metadata: languageName: node linkType: hard -"@lezer/common@npm:^0.15.0, @lezer/common@npm:^0.15.7": - version: 0.15.12 - resolution: "@lezer/common@npm:0.15.12" - checksum: dae65816187bd690bf446bec116313d3b5328e70e3e1f7c806273d9356ca2017cf82aa650ea53b95260fb98898ea73d44f33319f9dbbd48d473e2f20771b2377 +"@lezer/common@npm:^1.0.0": + version: 1.5.0 + resolution: "@lezer/common@npm:1.5.0" + checksum: 564ae4a168e110992c0671420066ae2d7e091d0f29a4e82da3e4e89fa543fd7377125d74a6e3f0f58c8e5a20e7ab6ffc3c70897809e91bea88b72c021f25cbe4 languageName: node linkType: hard -"@lezer/lr@npm:^0.15.4": - version: 0.15.8 - resolution: "@lezer/lr@npm:0.15.8" +"@lezer/lr@npm:^1.0.0": + version: 1.4.7 + resolution: "@lezer/lr@npm:1.4.7" dependencies: - "@lezer/common": ^0.15.0 - checksum: e741225d6ac9cf08f8016bad49622fbd4a4e0d20c2e8c2b38a0abf0ddca69c58275b0ebdb9d5dde2905cf84f6977bc302f7ed5e5ba42c23afa27e9e65b900f36 + "@lezer/common": ^1.0.0 + checksum: 001ef7893fa97210f0a923bf569e0cca5f2f8ae61feb47923f19ad6653d6cc9f118dcdd65c35bde6141a22492b2a144e4a0b5a5f146f1159746550390e333d70 languageName: node linkType: hard @@ -3374,15 +3226,32 @@ __metadata: linkType: hard "@loadable/component@npm:^5.15.2": - version: 5.15.2 - resolution: "@loadable/component@npm:5.15.2" + version: 5.16.7 + resolution: "@loadable/component@npm:5.16.7" dependencies: - "@babel/runtime": ^7.7.7 + "@babel/runtime": ^7.12.18 hoist-non-react-statics: ^3.3.1 react-is: ^16.12.0 peerDependencies: - react: ">=16.3.0" - checksum: dd027f3f9fb684613506fe48dcb656367a13731c139134fb71c2bc1734df4218fdb64e5ca80fa2575fdf52e1be0e0a2ec770f0ca77275706e66d1074d0835401 + react: ^16.3.0 || ^17.0.0 || ^18.0.0 || ^19.0.0 + checksum: 4408fdbc81f8234224c5a418454e0dd8442a25fb66dd2fb0d832fd9c98b0ebfc6bd04e4628ed0c2811b2a2f810599865e0df052e8d54482792532b518ec5b099 + languageName: node + linkType: hard + +"@mapbox/node-pre-gyp@npm:^2.0.0": + version: 2.0.3 + resolution: "@mapbox/node-pre-gyp@npm:2.0.3" + dependencies: + consola: ^3.2.3 + detect-libc: ^2.0.0 + https-proxy-agent: ^7.0.5 + node-fetch: ^2.6.7 + nopt: ^8.0.0 + semver: ^7.5.3 + tar: ^7.4.0 + bin: + node-pre-gyp: bin/node-pre-gyp + checksum: 8b1a9833d4b6cb5cda943fa3e5c2cc61395e2623570092c98d585c3ce3c44088d597d88cbe89cdd99c57ae741927bcbeb58880fbfb03e4161640bed250ab7916 languageName: node linkType: hard @@ -3430,13 +3299,13 @@ __metadata: linkType: hard "@mischnic/json-sourcemap@npm:^0.1.0": - version: 0.1.0 - resolution: "@mischnic/json-sourcemap@npm:0.1.0" + version: 0.1.1 + resolution: "@mischnic/json-sourcemap@npm:0.1.1" dependencies: - "@lezer/common": ^0.15.7 - "@lezer/lr": ^0.15.4 + "@lezer/common": ^1.0.0 + "@lezer/lr": ^1.0.0 json5: ^2.2.1 - checksum: a30eda9eb02db5213b7aa2dc3c688257884a8969849ffa5a3a7c64c5f2a1cfed06691d94f02b37294a3a3b9efe7f88ee6b86c9ef20a799af54807ff2de2d253e + checksum: 631d1080ec4b525b7b757e9e248d0974178961f366123e765c35ddbfe24e0d51562bec48e416aef4a5f78a6769058c24ea88a2109378a8562bff4fb94471bdfa languageName: node linkType: hard @@ -3518,6 +3387,19 @@ __metadata: languageName: node linkType: hard +"@npmcli/agent@npm:^4.0.0": + version: 4.0.0 + resolution: "@npmcli/agent@npm:4.0.0" + dependencies: + agent-base: ^7.1.0 + http-proxy-agent: ^7.0.0 + https-proxy-agent: ^7.0.1 + lru-cache: ^11.2.1 + socks-proxy-agent: ^8.0.3 + checksum: 89ae20b44859ff8d4de56ade319d8ceaa267a0742d6f7345fe98aa5cd8614ced7db85ea4dc5bfbd6614dbb200a10b134e087143582534c939e8a02219e8665c8 + languageName: node + linkType: hard + "@npmcli/config@npm:^8.0.0": version: 8.3.4 resolution: "@npmcli/config@npm:8.3.4" @@ -3534,13 +3416,12 @@ __metadata: languageName: node linkType: hard -"@npmcli/fs@npm:^2.1.0": - version: 2.1.2 - resolution: "@npmcli/fs@npm:2.1.2" +"@npmcli/fs@npm:^5.0.0": + version: 5.0.0 + resolution: "@npmcli/fs@npm:5.0.0" dependencies: - "@gar/promisify": ^1.1.3 semver: ^7.3.5 - checksum: 405074965e72d4c9d728931b64d2d38e6ea12066d4fad651ac253d175e413c06fe4350970c783db0d749181da8fe49c42d3880bd1cbc12cd68e3a7964d820225 + checksum: 897dac32eb37e011800112d406b9ea2ebd96f1dab01bb8fbeb59191b86f6825dffed6a89f3b6c824753d10f8735b76d630927bd7610e9e123b129ef2e5f02cb5 languageName: node linkType: hard @@ -3573,16 +3454,6 @@ __metadata: languageName: node linkType: hard -"@npmcli/move-file@npm:^2.0.0": - version: 2.0.1 - resolution: "@npmcli/move-file@npm:2.0.1" - dependencies: - mkdirp: ^1.0.4 - rimraf: ^3.0.2 - checksum: 52dc02259d98da517fae4cb3a0a3850227bdae4939dda1980b788a7670636ca2b4a01b58df03dd5f65c1e3cb70c50fa8ce5762b582b3f499ec30ee5ce1fd9380 - languageName: node - linkType: hard - "@npmcli/name-from-folder@npm:^2.0.0": version: 2.0.0 resolution: "@npmcli/name-from-folder@npm:2.0.0" @@ -3591,8 +3462,8 @@ __metadata: linkType: hard "@npmcli/package-json@npm:^5.1.1": - version: 5.2.0 - resolution: "@npmcli/package-json@npm:5.2.0" + version: 5.2.1 + resolution: "@npmcli/package-json@npm:5.2.1" dependencies: "@npmcli/git": ^5.0.0 glob: ^10.2.2 @@ -3601,7 +3472,7 @@ __metadata: normalize-package-data: ^6.0.0 proc-log: ^4.0.0 semver: ^7.5.3 - checksum: 8df289c45b52cca88826cc737195cabf21757008e11d90b1f62d5400ff65834c0e9bcb552f235ba560c3af436a1ca3fc553b23b5cb5da8330ae56929065a6988 + checksum: f9f76428fb3b3350fe840f1fa49854d18ff1ecb82b426c9cf53a62a37389c357a89d64a07497f50b7fbf1c742f5a0cd349d8efdddef0bb6982497f8356c1f98a languageName: node linkType: hard @@ -4019,14 +3890,147 @@ __metadata: languageName: node linkType: hard -"@parcel/watcher@npm:^2.0.0": - version: 2.0.7 - resolution: "@parcel/watcher@npm:2.0.7" - dependencies: - node-addon-api: ^3.2.1 +"@parcel/watcher-android-arm64@npm:2.5.1": + version: 2.5.1 + resolution: "@parcel/watcher-android-arm64@npm:2.5.1" + conditions: os=android & cpu=arm64 + languageName: node + linkType: hard + +"@parcel/watcher-darwin-arm64@npm:2.5.1": + version: 2.5.1 + resolution: "@parcel/watcher-darwin-arm64@npm:2.5.1" + conditions: os=darwin & cpu=arm64 + languageName: node + linkType: hard + +"@parcel/watcher-darwin-x64@npm:2.5.1": + version: 2.5.1 + resolution: "@parcel/watcher-darwin-x64@npm:2.5.1" + conditions: os=darwin & cpu=x64 + languageName: node + linkType: hard + +"@parcel/watcher-freebsd-x64@npm:2.5.1": + version: 2.5.1 + resolution: "@parcel/watcher-freebsd-x64@npm:2.5.1" + conditions: os=freebsd & cpu=x64 + languageName: node + linkType: hard + +"@parcel/watcher-linux-arm-glibc@npm:2.5.1": + version: 2.5.1 + resolution: "@parcel/watcher-linux-arm-glibc@npm:2.5.1" + conditions: os=linux & cpu=arm & libc=glibc + languageName: node + linkType: hard + +"@parcel/watcher-linux-arm-musl@npm:2.5.1": + version: 2.5.1 + resolution: "@parcel/watcher-linux-arm-musl@npm:2.5.1" + conditions: os=linux & cpu=arm & libc=musl + languageName: node + linkType: hard + +"@parcel/watcher-linux-arm64-glibc@npm:2.5.1": + version: 2.5.1 + resolution: "@parcel/watcher-linux-arm64-glibc@npm:2.5.1" + conditions: os=linux & cpu=arm64 & libc=glibc + languageName: node + linkType: hard + +"@parcel/watcher-linux-arm64-musl@npm:2.5.1": + version: 2.5.1 + resolution: "@parcel/watcher-linux-arm64-musl@npm:2.5.1" + conditions: os=linux & cpu=arm64 & libc=musl + languageName: node + linkType: hard + +"@parcel/watcher-linux-x64-glibc@npm:2.5.1": + version: 2.5.1 + resolution: "@parcel/watcher-linux-x64-glibc@npm:2.5.1" + conditions: os=linux & cpu=x64 & libc=glibc + languageName: node + linkType: hard + +"@parcel/watcher-linux-x64-musl@npm:2.5.1": + version: 2.5.1 + resolution: "@parcel/watcher-linux-x64-musl@npm:2.5.1" + conditions: os=linux & cpu=x64 & libc=musl + languageName: node + linkType: hard + +"@parcel/watcher-win32-arm64@npm:2.5.1": + version: 2.5.1 + resolution: "@parcel/watcher-win32-arm64@npm:2.5.1" + conditions: os=win32 & cpu=arm64 + languageName: node + linkType: hard + +"@parcel/watcher-win32-ia32@npm:2.5.1": + version: 2.5.1 + resolution: "@parcel/watcher-win32-ia32@npm:2.5.1" + conditions: os=win32 & cpu=ia32 + languageName: node + linkType: hard + +"@parcel/watcher-win32-x64@npm:2.5.1": + version: 2.5.1 + resolution: "@parcel/watcher-win32-x64@npm:2.5.1" + conditions: os=win32 & cpu=x64 + languageName: node + linkType: hard + +"@parcel/watcher@npm:^2.0.0, @parcel/watcher@npm:^2.4.1": + version: 2.5.1 + resolution: "@parcel/watcher@npm:2.5.1" + dependencies: + "@parcel/watcher-android-arm64": 2.5.1 + "@parcel/watcher-darwin-arm64": 2.5.1 + "@parcel/watcher-darwin-x64": 2.5.1 + "@parcel/watcher-freebsd-x64": 2.5.1 + "@parcel/watcher-linux-arm-glibc": 2.5.1 + "@parcel/watcher-linux-arm-musl": 2.5.1 + "@parcel/watcher-linux-arm64-glibc": 2.5.1 + "@parcel/watcher-linux-arm64-musl": 2.5.1 + "@parcel/watcher-linux-x64-glibc": 2.5.1 + "@parcel/watcher-linux-x64-musl": 2.5.1 + "@parcel/watcher-win32-arm64": 2.5.1 + "@parcel/watcher-win32-ia32": 2.5.1 + "@parcel/watcher-win32-x64": 2.5.1 + detect-libc: ^1.0.3 + is-glob: ^4.0.3 + micromatch: ^4.0.5 + node-addon-api: ^7.0.0 node-gyp: latest - node-gyp-build: ^4.3.0 - checksum: 9cf92fbf4486ad6af441286ce85bcd53a03445abb069c61485d3e0aafabe3da3008be06e38f386c3c0e117f743ed1fe04a88936be1daaf9c455e1e7e5b15f562 + dependenciesMeta: + "@parcel/watcher-android-arm64": + optional: true + "@parcel/watcher-darwin-arm64": + optional: true + "@parcel/watcher-darwin-x64": + optional: true + "@parcel/watcher-freebsd-x64": + optional: true + "@parcel/watcher-linux-arm-glibc": + optional: true + "@parcel/watcher-linux-arm-musl": + optional: true + "@parcel/watcher-linux-arm64-glibc": + optional: true + "@parcel/watcher-linux-arm64-musl": + optional: true + "@parcel/watcher-linux-x64-glibc": + optional: true + "@parcel/watcher-linux-x64-musl": + optional: true + "@parcel/watcher-win32-arm64": + optional: true + "@parcel/watcher-win32-ia32": + optional: true + "@parcel/watcher-win32-x64": + optional: true + checksum: c6444cd20212929ef2296d5620c0d41343a1719232cb0c947ced51155b8afc1e470c09d238b92f6c3a589e0320048badf5b73cb41790229521be224cbf89e0f4 languageName: node linkType: hard @@ -4054,25 +4058,23 @@ __metadata: linkType: hard "@pmmmwh/react-refresh-webpack-plugin@npm:^0.5.7": - version: 0.5.9 - resolution: "@pmmmwh/react-refresh-webpack-plugin@npm:0.5.9" + version: 0.5.17 + resolution: "@pmmmwh/react-refresh-webpack-plugin@npm:0.5.17" dependencies: - ansi-html-community: ^0.0.8 - common-path-prefix: ^3.0.0 + ansi-html: ^0.0.9 core-js-pure: ^3.23.3 error-stack-parser: ^2.0.6 - find-up: ^5.0.0 html-entities: ^2.1.0 - loader-utils: ^2.0.3 - schema-utils: ^3.0.0 + loader-utils: ^2.0.4 + schema-utils: ^4.2.0 source-map: ^0.7.3 peerDependencies: "@types/webpack": 4.x || 5.x react-refresh: ">=0.10.0 <1.0.0" sockjs-client: ^1.4.0 - type-fest: ">=0.17.0 <4.0.0" + type-fest: ">=0.17.0 <5.0.0" webpack: ">=4.43.0 <6.0.0" - webpack-dev-server: 3.x || 4.x + webpack-dev-server: 3.x || 4.x || 5.x webpack-hot-middleware: 2.x webpack-plugin-serve: 0.x || 1.x peerDependenciesMeta: @@ -4088,7 +4090,7 @@ __metadata: optional: true webpack-plugin-serve: optional: true - checksum: 446c0add9ecf17ed9911bf310bf22ab64f4b3d0ce334e68a3fcac5efee782ef4d7b6260997efaf720c7a2ea39086db89629e4aa07fb18558387d8dc8f0f31da2 + checksum: ff80b5064f6acba52f18e240dc0a402c5f0980402fd4e5a212a69b9ad6ad76294b4e0f4a78f356cab17b53b88995c6e4dd0b54e6f07c28c2a307cb8bf61fa88f languageName: node linkType: hard @@ -4100,18 +4102,18 @@ __metadata: linkType: hard "@prefresh/core@npm:^1.3.3": - version: 1.4.1 - resolution: "@prefresh/core@npm:1.4.1" + version: 1.5.9 + resolution: "@prefresh/core@npm:1.5.9" peerDependencies: - preact: ^10.0.0 - checksum: afac93e1225d871d88c47717f8b6a328abc9760b212836986fd8bb3017bb6737bb397e016b31c4f542722d0b9c05e1e43d1b5710a61c8efb5208d717d2bb1bba + preact: ^10.0.0 || ^11.0.0-0 + checksum: 26a4c25fc98f010f4007ec6b54e3694f7298e6b80b2ec354b852c18c4d89e323fb853efc1bef5e6296754b37173956cf8930aabdd4ad8e67ec472349f710055c languageName: node linkType: hard "@prefresh/utils@npm:^1.1.2": - version: 1.1.3 - resolution: "@prefresh/utils@npm:1.1.3" - checksum: a95b816d08a68f499489f1e0098effcda99ccba06c80986cb0dfbcda4fc9c8f8e3238603ead4ee35bb9fb7985de66b1a785d12c64fbc61600e0a8bd388fc2de0 + version: 1.2.1 + resolution: "@prefresh/utils@npm:1.2.1" + checksum: d184a11a44ccea4a1aace9f1129f36eb1607632aad9395ce8c0b6b7cf539efd017fd00514222339d1ed2db5cecc53d5ff7218627fc67c6b3d512eedfaa3fa0a7 languageName: node linkType: hard @@ -4129,46 +4131,59 @@ __metadata: languageName: node linkType: hard -"@redocly/ajv@npm:^8.11.0": - version: 8.11.0 - resolution: "@redocly/ajv@npm:8.11.0" +"@redocly/ajv@npm:^8.11.2": + version: 8.17.1 + resolution: "@redocly/ajv@npm:8.17.1" dependencies: - fast-deep-equal: ^3.1.1 + fast-deep-equal: ^3.1.3 + fast-uri: ^3.0.1 json-schema-traverse: ^1.0.0 require-from-string: ^2.0.2 - uri-js: ^4.2.2 - checksum: 3e4c7a18226aefd2016628eed88a84588c49f6e721a1009081a20873f374a3d765c6a640856f6cb6bdd1732b027e3c82ea5c06d27427bc5a8af2cf8bb69bbd9b + checksum: 7f90a264233263f17fbe8ff6397bc793ebe2bec600595ece11fbb144d440d06270e81ea60a42b865f7515bc022e9b4a6b6680dc58a41fa8a9ac9f6e367e08c98 + languageName: node + linkType: hard + +"@redocly/config@npm:^0.22.0": + version: 0.22.2 + resolution: "@redocly/config@npm:0.22.2" + checksum: 0461486fdc938a3b1d88ce2c6a4ad88469cc1f642b6c31bb4e941c5198dd27c62382fd687124559d893ec1faaa824afdb497f904c10b8da979f02044eb80db02 languageName: node linkType: hard "@redocly/openapi-core@npm:^1.0.0-beta.104": - version: 1.0.0-beta.112 - resolution: "@redocly/openapi-core@npm:1.0.0-beta.112" + version: 1.34.6 + resolution: "@redocly/openapi-core@npm:1.34.6" dependencies: - "@redocly/ajv": ^8.11.0 - "@types/node": ^14.11.8 + "@redocly/ajv": ^8.11.2 + "@redocly/config": ^0.22.0 colorette: ^1.2.0 + https-proxy-agent: ^7.0.5 js-levenshtein: ^1.1.6 js-yaml: ^4.1.0 - lodash.isequal: ^4.5.0 minimatch: ^5.0.1 - node-fetch: ^2.6.1 pluralize: ^8.0.0 yaml-ast-parser: 0.0.43 - checksum: 0597112ebf05a7b77929fa6df0be8e8ebdbb8d13c01a56f61b6d050258517ecabdaf588016a1de137378473cced33f700314908201d2159340111c773d824928 + checksum: 584a30e52ef0234dd79fec0827bc9987b17a001329315a3e3b0db5a1f141b6b318f5ac96adda2d29cde823819eb24c0dce72bb0cb032d5f9545b4026f7c78b5d languageName: node linkType: hard -"@sideway/address@npm:^4.1.3": - version: 4.1.4 - resolution: "@sideway/address@npm:4.1.4" +"@rtsao/scc@npm:^1.1.0": + version: 1.1.0 + resolution: "@rtsao/scc@npm:1.1.0" + checksum: 17d04adf404e04c1e61391ed97bca5117d4c2767a76ae3e879390d6dec7b317fcae68afbf9e98badee075d0b64fa60f287729c4942021b4d19cd01db77385c01 + languageName: node + linkType: hard + +"@sideway/address@npm:^4.1.5": + version: 4.1.5 + resolution: "@sideway/address@npm:4.1.5" dependencies: "@hapi/hoek": ^9.0.0 - checksum: b9fca2a93ac2c975ba12e0a6d97853832fb1f4fb02393015e012b47fa916a75ca95102d77214b2a29a2784740df2407951af8c5dde054824c65577fd293c4cdb + checksum: 3e3ea0f00b4765d86509282290368a4a5fd39a7995fdc6de42116ca19a96120858e56c2c995081def06e1c53e1f8bccc7d013f6326602bec9d56b72ee2772b9d languageName: node linkType: hard -"@sideway/formula@npm:^3.0.0": +"@sideway/formula@npm:^3.0.1": version: 3.0.1 resolution: "@sideway/formula@npm:3.0.1" checksum: e4beeebc9dbe2ff4ef0def15cec0165e00d1612e3d7cea0bc9ce5175c3263fc2c818b679bd558957f49400ee7be9d4e5ac90487e1625b4932e15c4aa7919c57a @@ -4312,13 +4327,17 @@ __metadata: linkType: hard "@spectrum-css/contextualhelp@npm:^2.0.35": - version: 2.0.43 - resolution: "@spectrum-css/contextualhelp@npm:2.0.43" + version: 2.1.5 + resolution: "@spectrum-css/contextualhelp@npm:2.1.5" peerDependencies: "@spectrum-css/actionbutton": ">=5" + "@spectrum-css/link": ">=4" "@spectrum-css/popover": ">=6" "@spectrum-css/tokens": ">=13" - checksum: 83d1132365eff45340599169afbda176494217aaf4ac2bf7550e16eba18f7d3ea1343a537b4bc7d1fd928579ed6063b2d9a28643768a654059ea11c8f2eacce8 + peerDependenciesMeta: + "@spectrum-css/link": + optional: true + checksum: bf90063d691d3c7fbb3590ece826271cc7d37703d3e8a6869ae2fea2c77edc665f291d82a1b7e2305e2dc3a517f5fbda3bcb11cea1523d3e51923b7d7102eaf5 languageName: node linkType: hard @@ -4505,13 +4524,20 @@ __metadata: languageName: node linkType: hard -"@spectrum-css/vars@npm:8.0.0, @spectrum-css/vars@npm:^8.0.0": +"@spectrum-css/vars@npm:8.0.0": version: 8.0.0 resolution: "@spectrum-css/vars@npm:8.0.0" checksum: a0639066b21a2300bdc61f567e990960c626d53e2b8966de1174aa42790d29a13da878bf2ace398b875ced2afd622daf3b8bdaecd526e93451d3404f76091378 languageName: node linkType: hard +"@spectrum-css/vars@npm:^8.0.0": + version: 8.0.5 + resolution: "@spectrum-css/vars@npm:8.0.5" + checksum: 3735bc2858d970cc56ec9db74a52583410aa1a4ef4db57e01c575b2fd39ea8bbff3506ae517e4df6c19c7b72d9141bd2bc828e232651879b7ce1123610aae420 + languageName: node + linkType: hard + "@spectrum-css/well@npm:3.0.22": version: 3.0.22 resolution: "@spectrum-css/well@npm:3.0.22" @@ -4522,11 +4548,21 @@ __metadata: linkType: hard "@swc/helpers@npm:^0.4.2": - version: 0.4.12 - resolution: "@swc/helpers@npm:0.4.12" + version: 0.4.37 + resolution: "@swc/helpers@npm:0.4.37" + dependencies: + "@swc/legacy-helpers": "npm:@swc/helpers@=0.4.14" + tslib: ^2.4.0 + checksum: e9577992c74e6f5e94fed4d1e527564031cd1f6e1018c8a9c6fa529edbf9285d20ebeef585a7661e7ba1851df04e087b60e175a7dc88bcec4b99d21fa9dc3116 + languageName: node + linkType: hard + +"@swc/legacy-helpers@npm:@swc/helpers@=0.4.14": + version: 0.4.14 + resolution: "@swc/helpers@npm:0.4.14" dependencies: tslib: ^2.4.0 - checksum: 3f9112f37d87815b6d4270137fc78d22bb98c75138e9b0eac7cac203ec2cf2bffbf13b20a713067c292affd5e9e70a724eb245b8daf0963e7fe528b901771c28 + checksum: 273fd3f3fc461a92f3790cc551ea054745c6d6959afbe1232e6d7aa1c722bbc114d308aab96bef5c78fc0303c85c7b472ef00e2253251cc89737f3b1af56e5a5 languageName: node linkType: hard @@ -4600,16 +4636,16 @@ __metadata: linkType: hard "@types/common-tags@npm:^1.8.1": - version: 1.8.1 - resolution: "@types/common-tags@npm:1.8.1" - checksum: bec6f68c8c434834380abd1dc057aa6ba26661bb0c65c700b65049e9b104d7be96a987d93dbe8726be68554a23a52514a6967d8903fdb51fb8c78cf909d1e4c1 + version: 1.8.4 + resolution: "@types/common-tags@npm:1.8.4" + checksum: 9fad055269bd31eecd910fbf34acb80332b0c21e0fe8fd459df2dec11c183a3da3c96590964289ebd63a39658c23ca4412cc116558cde5a43a2738ff8056d765 languageName: node linkType: hard "@types/component-emitter@npm:^1.2.10": - version: 1.2.11 - resolution: "@types/component-emitter@npm:1.2.11" - checksum: 0e081c5f7a4b113af3732f67ad9ebb487d5c239d440d96938ff9a679d18bb9337a513638e12b5b02a7a921494eef18c5a4d78f1188bc43a12290edd74c42a9c7 + version: 1.2.14 + resolution: "@types/component-emitter@npm:1.2.14" + checksum: 4cf41df13b25c6486f3936a74a0be33c83e6ff32ba07b9312b1eda4e7082018808ee6364d38243dbc74d0704e16cb20e018e5b59d726bab0607dc0199ee9299a languageName: node linkType: hard @@ -4623,11 +4659,11 @@ __metadata: linkType: hard "@types/concat-stream@npm:^2.0.0": - version: 2.0.0 - resolution: "@types/concat-stream@npm:2.0.0" + version: 2.0.3 + resolution: "@types/concat-stream@npm:2.0.3" dependencies: "@types/node": "*" - checksum: d82ace5cb92f9fc91660ae1a101fa0a6b6159da59b0351c28627b24c317670267bc527f24ef4fa2c08d00404b49882ca66bf5c75d47d2b5f48d2fd85f9c2ea4d + checksum: e829fde246528665b31a9b8f64c369ffc66aa2a1337d2bab1d38f4d4145701480af7c67e877dd09a7fa97fcbaa0f3baa816ed1b3e71c3ad430930acd37f4eb1f languageName: node linkType: hard @@ -4646,11 +4682,11 @@ __metadata: linkType: hard "@types/cors@npm:^2.8.8": - version: 2.8.13 - resolution: "@types/cors@npm:2.8.13" + version: 2.8.19 + resolution: "@types/cors@npm:2.8.19" dependencies: "@types/node": "*" - checksum: 7ef197ea19d2e5bf1313b8416baa6f3fd6dd887fd70191da1f804f557395357dafd8bc8bed0ac60686923406489262a7c8a525b55748f7b2b8afa686700de907 + checksum: 9545cc532c9218754443f48a0c98c1a9ba4af1fe54a3425c95de75ff3158147bb39e666cb7c6bf98cc56a9c6dc7b4ce5b2cbdae6b55d5942e50c81b76ed6b825 languageName: node linkType: hard @@ -4662,11 +4698,31 @@ __metadata: linkType: hard "@types/debug@npm:^4.0.0": - version: 4.1.7 - resolution: "@types/debug@npm:4.1.7" + version: 4.1.12 + resolution: "@types/debug@npm:4.1.12" dependencies: "@types/ms": "*" - checksum: 0a7b89d8ed72526858f0b61c6fd81f477853e8c4415bb97f48b1b5545248d2ae389931680b94b393b993a7cfe893537a200647d93defe6d87159b96812305adc + checksum: 47876a852de8240bfdaf7481357af2b88cb660d30c72e73789abf00c499d6bc7cd5e52f41c915d1b9cd8ec9fef5b05688d7b7aef17f7f272c2d04679508d1053 + languageName: node + linkType: hard + +"@types/eslint-scope@npm:^3.7.7": + version: 3.7.7 + resolution: "@types/eslint-scope@npm:3.7.7" + dependencies: + "@types/eslint": "*" + "@types/estree": "*" + checksum: e2889a124aaab0b89af1bab5959847c5bec09809209255de0e63b9f54c629a94781daa04adb66bffcdd742f5e25a17614fb933965093c0eea64aacda4309380e + languageName: node + linkType: hard + +"@types/eslint@npm:*": + version: 9.6.1 + resolution: "@types/eslint@npm:9.6.1" + dependencies: + "@types/estree": "*" + "@types/json-schema": "*" + checksum: c286e79707ab604b577cf8ce51d9bbb9780e3d6a68b38a83febe13fa05b8012c92de17c28532fac2b03d3c460123f5055d603a579685325246ca1c86828223e0 languageName: node linkType: hard @@ -4680,17 +4736,10 @@ __metadata: languageName: node linkType: hard -"@types/estree@npm:*": - version: 1.0.0 - resolution: "@types/estree@npm:1.0.0" - checksum: 910d97fb7092c6738d30a7430ae4786a38542023c6302b95d46f49420b797f21619cdde11fa92b338366268795884111c2eb10356e4bd2c8ad5b92941e9e6443 - languageName: node - linkType: hard - -"@types/estree@npm:^1.0.5": - version: 1.0.5 - resolution: "@types/estree@npm:1.0.5" - checksum: dd8b5bed28e6213b7acd0fb665a84e693554d850b0df423ac8076cc3ad5823a6bc26b0251d080bdc545af83179ede51dd3f6fa78cad2c46ed1f29624ddf3e41a +"@types/estree@npm:*, @types/estree@npm:^1.0.8": + version: 1.0.8 + resolution: "@types/estree@npm:1.0.8" + checksum: bd93e2e415b6f182ec4da1074e1f36c480f1d26add3e696d54fb30c09bc470897e41361c8fd957bf0985024f8fbf1e6e2aff977d79352ef7eb93a5c6dcff6c11 languageName: node linkType: hard @@ -4711,31 +4760,31 @@ __metadata: linkType: hard "@types/glob@npm:*": - version: 8.0.0 - resolution: "@types/glob@npm:8.0.0" + version: 8.1.0 + resolution: "@types/glob@npm:8.1.0" dependencies: - "@types/minimatch": "*" + "@types/minimatch": ^5.1.2 "@types/node": "*" - checksum: 1817b05f5a8aed851d102a65b5e926d5c777bef927ea62b36d635860eef5364f2046bb5a692d135b6f2b28f34e4a9d44ade9396122c0845bcc7636d35f624747 + checksum: 9101f3a9061e40137190f70626aa0e202369b5ec4012c3fabe6f5d229cce04772db9a94fa5a0eb39655e2e4ad105c38afbb4af56a56c0996a8c7d4fc72350e3d languageName: node linkType: hard "@types/glob@npm:^5.0.34": - version: 5.0.37 - resolution: "@types/glob@npm:5.0.37" + version: 5.0.38 + resolution: "@types/glob@npm:5.0.38" dependencies: "@types/minimatch": "*" "@types/node": "*" - checksum: 88683c3bfcac48d992b8d2628eb984ad5806bddd5a5f7a5612d7181fc6ca8eae83e421eba0ff2fb11954871fed38aec2daf6a988e8a6c13f0b708759d484b934 + checksum: 57d92cbe75d03b0b68ebf9d2caf9a36a9da4790c18c88982eb98fa14706ba8231a9d59688c002286fb792197d78c7ccc057075ada90afe00a4702b3ec2593724 languageName: node linkType: hard "@types/hast@npm:^2.0.0": - version: 2.3.4 - resolution: "@types/hast@npm:2.3.4" + version: 2.3.10 + resolution: "@types/hast@npm:2.3.10" dependencies: - "@types/unist": "*" - checksum: fff47998f4c11e21a7454b58673f70478740ecdafd95aaf50b70a3daa7da9cdc57315545bf9c039613732c40b7b0e9e49d11d03fe9a4304721cdc3b29a88141e + "@types/unist": ^2 + checksum: 41531b7fbf590b02452996fc63272479c20a07269e370bd6514982cbcd1819b4b84d3ea620f2410d1b9541a23d08ce2eeb0a592145d05e00e249c3d56700d460 languageName: node linkType: hard @@ -4756,36 +4805,29 @@ __metadata: linkType: hard "@types/http-cache-semantics@npm:*": - version: 4.0.1 - resolution: "@types/http-cache-semantics@npm:4.0.1" - checksum: 1048aacf627829f0d5f00184e16548205cd9f964bf0841c29b36bc504509230c40bc57c39778703a1c965a6f5b416ae2cbf4c1d4589c889d2838dd9dbfccf6e9 + version: 4.0.4 + resolution: "@types/http-cache-semantics@npm:4.0.4" + checksum: 7f4dd832e618bc1e271be49717d7b4066d77c2d4eed5b81198eb987e532bb3e1c7e02f45d77918185bad936f884b700c10cebe06305f50400f382ab75055f9e8 languageName: node linkType: hard "@types/http-proxy@npm:^1.17.7": - version: 1.17.9 - resolution: "@types/http-proxy@npm:1.17.9" + version: 1.17.17 + resolution: "@types/http-proxy@npm:1.17.17" dependencies: "@types/node": "*" - checksum: 7a6746d00729b2a9fe9f9dd3453430b099931df879ec8f7a7b5f07b1795f6d99b0512640c45a67390b1e4bacb9401e36824952aeeaf089feba8627a063cf8e00 + checksum: 7231460dc06c109447b21c125a60662872b9c2e902efd12c47902b8ad75caded19678fa3115f6b9ce06b94d2f46d697be572e848c52da558f4f1ee88ff18a2e0 languageName: node linkType: hard "@types/is-empty@npm:^1.0.0": - version: 1.2.1 - resolution: "@types/is-empty@npm:1.2.1" - checksum: 7fe50427bfe8e4bef75e448a20bb542a57ab69ed0a4e191fd41f7f4417f6bd7cccd5f395fd88a579befbcb2c93ee9ba082749730e052493ea988351691069465 - languageName: node - linkType: hard - -"@types/json-schema@npm:*, @types/json-schema@npm:^7.0.4, @types/json-schema@npm:^7.0.5, @types/json-schema@npm:^7.0.7, @types/json-schema@npm:^7.0.8": - version: 7.0.11 - resolution: "@types/json-schema@npm:7.0.11" - checksum: 527bddfe62db9012fccd7627794bd4c71beb77601861055d87e3ee464f2217c85fca7a4b56ae677478367bbd248dbde13553312b7d4dbc702a2f2bbf60c4018d + version: 1.2.3 + resolution: "@types/is-empty@npm:1.2.3" + checksum: b22065de5978dacacb6b7401df03e94b9688a3ce07c7faab1bab5e943adbdd6455b190963079bb0aae12c8e56980e54c49bc6902a5805741b82fb4f7335b0c44 languageName: node linkType: hard -"@types/json-schema@npm:^7.0.13": +"@types/json-schema@npm:*, @types/json-schema@npm:^7.0.13, @types/json-schema@npm:^7.0.15, @types/json-schema@npm:^7.0.4, @types/json-schema@npm:^7.0.5, @types/json-schema@npm:^7.0.7, @types/json-schema@npm:^7.0.8, @types/json-schema@npm:^7.0.9": version: 7.0.15 resolution: "@types/json-schema@npm:7.0.15" checksum: 97ed0cb44d4070aecea772b7b2e2ed971e10c81ec87dd4ecc160322ffa55ff330dace1793489540e3e318d90942064bb697cc0f8989391797792d919737b3b98 @@ -4809,34 +4851,27 @@ __metadata: linkType: hard "@types/lodash.clonedeep@npm:^4.5.7": - version: 4.5.7 - resolution: "@types/lodash.clonedeep@npm:4.5.7" + version: 4.5.9 + resolution: "@types/lodash.clonedeep@npm:4.5.9" dependencies: "@types/lodash": "*" - checksum: 20d6a20970b3b54b3c10cf17ace1cea49c4905d7f7cae2575a98108466e8d4c9bea3b3449d11ccaac4da1fc9bab225f477f4c2dbea8ba877cc47f629455efb69 - languageName: node - linkType: hard - -"@types/lodash@npm:*": - version: 4.14.198 - resolution: "@types/lodash@npm:4.14.198" - checksum: b290e4480707151bcec738bca40527915defe52a0d8e26c83685c674163a265e1a88cb2ee56b0fb587a89819d0cd5df86ada836aec3e9c2e4bf516e7d348d524 + checksum: ef85512b7dce7a4f981a818ae44d11982907e1f26b5b26bedf0957c35e8591eb8e1d24fa31ca851d4b40e0a1ee88563853d762412691fe5f357e8335cead2325 languageName: node linkType: hard -"@types/lodash@npm:^4.14.92": - version: 4.14.188 - resolution: "@types/lodash@npm:4.14.188" - checksum: 89c32f0a18e0da6ae914b430e76b3d0451c4c85b9c838b440c0c9a8d4966c8e2a76dbb30964c7126402856b2997ec56a8c36d8d6461ec14387689ec37594f09f +"@types/lodash@npm:*, @types/lodash@npm:^4.14.92": + version: 4.17.21 + resolution: "@types/lodash@npm:4.17.21" + checksum: e09e3eaf29b18b6c8e130fcbafd8e3c4ecc2110f35255079245e7d1bd310a5a8f93e4e70266533dce672f253bba899c721bc6870097e0a8c5448e0b628136d39 languageName: node linkType: hard "@types/mdast@npm:^3.0.0, @types/mdast@npm:^3.0.3": - version: 3.0.10 - resolution: "@types/mdast@npm:3.0.10" + version: 3.0.15 + resolution: "@types/mdast@npm:3.0.15" dependencies: - "@types/unist": "*" - checksum: 3f587bfc0a9a2403ecadc220e61031b01734fedaf82e27eb4d5ba039c0eb54db8c85681ccc070ab4df3f7ec711b736a82b990e69caa14c74bf7ac0ccf2ac7313 + "@types/unist": ^2 + checksum: af85042a4e3af3f879bde4059fa9e76c71cb552dffc896cdcc6cf9dc1fd38e37035c2dbd6245cfa6535b433f1f0478f5549696234ccace47a64055a10c656530 languageName: node linkType: hard @@ -4849,7 +4884,7 @@ __metadata: languageName: node linkType: hard -"@types/minimatch@npm:*": +"@types/minimatch@npm:*, @types/minimatch@npm:^5.1.2": version: 5.1.2 resolution: "@types/minimatch@npm:5.1.2" checksum: 0391a282860c7cb6fe262c12b99564732401bdaa5e395bee9ca323c312c1a0f45efbf34dce974682036e857db59a5c9b1da522f3d6055aeead7097264c8705a8 @@ -4866,26 +4901,28 @@ __metadata: linkType: hard "@types/ms@npm:*": - version: 0.7.31 - resolution: "@types/ms@npm:0.7.31" - checksum: daadd354aedde024cce6f5aa873fefe7b71b22cd0e28632a69e8b677aeb48ae8caa1c60e5919bb781df040d116b01cb4316335167a3fc0ef6a63fa3614c0f6da + version: 2.1.0 + resolution: "@types/ms@npm:2.1.0" + checksum: 532d2ebb91937ccc4a89389715e5b47d4c66e708d15942fe6cc25add6dc37b2be058230a327dd50f43f89b8b6d5d52b74685a9e8f70516edfc9bdd6be910eff4 languageName: node linkType: hard "@types/node-fetch@npm:2": - version: 2.6.2 - resolution: "@types/node-fetch@npm:2.6.2" + version: 2.6.13 + resolution: "@types/node-fetch@npm:2.6.13" dependencies: "@types/node": "*" - form-data: ^3.0.0 - checksum: 6f73b1470000d303d25a6fb92875ea837a216656cb7474f66cdd67bb014aa81a5a11e7ac9c21fe19bee9ecb2ef87c1962bceeaec31386119d1ac86e4c30ad7a6 + form-data: ^4.0.4 + checksum: e4b4db3a8c23309dadf0beb87e88882af1157f0c08b7b76027ac40add6ed363c924e2fa275f42ae45eacf776b25ed439d14400d9d6372eb39634dd4c7e7e1ad8 languageName: node linkType: hard "@types/node@npm:*, @types/node@npm:>=10.0.0": - version: 18.11.9 - resolution: "@types/node@npm:18.11.9" - checksum: cc0aae109e9b7adefc32eecb838d6fad931663bb06484b5e9cbbbf74865c721b03d16fd8d74ad90e31dbe093d956a7c2c306ba5429ba0c00f3f7505103d7a496 + version: 25.0.3 + resolution: "@types/node@npm:25.0.3" + dependencies: + undici-types: ~7.16.0 + checksum: b5e0146eafe208e2f1c1167fd6078a460ace823ad1da61967ec70b8d7521bd6dd26f3cd945796effac48ef4b3df4d8d57d03e9eefd5f2903f6c1d6daf84a9a79 languageName: node linkType: hard @@ -4903,19 +4940,12 @@ __metadata: languageName: node linkType: hard -"@types/node@npm:^14.11.8": - version: 14.18.33 - resolution: "@types/node@npm:14.18.33" - checksum: 4e23f95186d8ae1d38c999bc6b46fe94e790da88744b0a3bfeedcbd0d9ffe2cb0ff39e85f43014f6739e5270292c1a1f6f97a1fc606fd573a0c17fda9a1d42de - languageName: node - linkType: hard - -"@types/node@npm:^20.0.0": - version: 20.14.12 - resolution: "@types/node@npm:20.14.12" +"@types/node@npm:^22.0.0": + version: 22.19.3 + resolution: "@types/node@npm:22.19.3" dependencies: - undici-types: ~5.26.4 - checksum: 1dd493d9e27da43fc374b17cf4b956dbd1dfe20ecf4749408a1db046c79b5a39261a2aa7a3f59b79fd1b5632b861ba72837779d812e0d3b6cf5b22f1650fe722 + undici-types: ~6.21.0 + checksum: 2fffd870ac2a5a531a160034075c858e7c95c521b0612e9b7ae35e7a6bae1880c7a190a77a5c335fbb2e5f4a315c1e2f2b529f9be4bdbb2166664a7206e28951 languageName: node linkType: hard @@ -4927,9 +4957,9 @@ __metadata: linkType: hard "@types/parse-json@npm:^4.0.0": - version: 4.0.0 - resolution: "@types/parse-json@npm:4.0.0" - checksum: fd6bce2b674b6efc3db4c7c3d336bd70c90838e8439de639b909ce22f3720d21344f52427f1d9e57b265fcb7f6c018699b99e5e0c208a1a4823014269a6bf35b + version: 4.0.2 + resolution: "@types/parse-json@npm:4.0.2" + checksum: 5bf62eec37c332ad10059252fc0dab7e7da730764869c980b0714777ad3d065e490627be9f40fc52f238ffa3ac4199b19de4127196910576c2fe34dd47c7a470 languageName: node linkType: hard @@ -4940,46 +4970,37 @@ __metadata: languageName: node linkType: hard -"@types/prop-types@npm:*": - version: 15.7.5 - resolution: "@types/prop-types@npm:15.7.5" - checksum: 5b43b8b15415e1f298243165f1d44390403bb2bd42e662bca3b5b5633fdd39c938e91b7fce3a9483699db0f7a715d08cef220c121f723a634972fdf596aec980 - languageName: node - linkType: hard - "@types/qs@npm:^6.2.31": - version: 6.9.7 - resolution: "@types/qs@npm:6.9.7" - checksum: 7fd6f9c25053e9b5bb6bc9f9f76c1d89e6c04f7707a7ba0e44cc01f17ef5284adb82f230f542c2d5557d69407c9a40f0f3515e8319afd14e1e16b5543ac6cdba + version: 6.14.0 + resolution: "@types/qs@npm:6.14.0" + checksum: 1909205514d22b3cbc7c2314e2bd8056d5f05dfb21cf4377f0730ee5e338ea19957c41735d5e4806c746176563f50005bbab602d8358432e25d900bdf4970826 languageName: node linkType: hard "@types/reach__router@npm:^1.3.10": - version: 1.3.11 - resolution: "@types/reach__router@npm:1.3.11" + version: 1.3.15 + resolution: "@types/reach__router@npm:1.3.15" dependencies: "@types/react": "*" - checksum: 6bcf40714e0dafff66cbf10a534320eae35dae8344f616d2ddf077937287a0df188dfbfb32fb8045cbc641139d1ab69ee5bb258a51642823cadefbcda020a044 + checksum: 7a9b60bd15e7c8484700caf1908440b8ddf9237d0422b0164d556b8f4c36766939b52f2ff676dcb33503dd397ce31a362f6e2af6a5a6206978002bbd0b7d9a02 languageName: node linkType: hard "@types/react@npm:*": - version: 18.0.25 - resolution: "@types/react@npm:18.0.25" + version: 19.2.7 + resolution: "@types/react@npm:19.2.7" dependencies: - "@types/prop-types": "*" - "@types/scheduler": "*" - csstype: ^3.0.2 - checksum: 231d658c45abdef044a716b4502774f1585d8336d73b2f5bd68f181acbfc874b7a457686ecd29b415b43ed0922c309bab7e2cf96832d188a3f4f1b02f2af760a + csstype: ^3.2.2 + checksum: b1f4c9a45862ea392b9ead060a5b5730b4c41b21fde097db35e639a8a0978460468d8da87f47226230bd4681d6de48ffee695595540084a8a849dde027c66a46 languageName: node linkType: hard "@types/responselike@npm:^1.0.0": - version: 1.0.0 - resolution: "@types/responselike@npm:1.0.0" + version: 1.0.3 + resolution: "@types/responselike@npm:1.0.3" dependencies: "@types/node": "*" - checksum: e99fc7cc6265407987b30deda54c1c24bb1478803faf6037557a774b2f034c5b097ffd65847daa87e82a61a250d919f35c3588654b0fdaa816906650f596d1b0 + checksum: 6ac4b35723429b11b117e813c7acc42c3af8b5554caaf1fc750404c1ae59f9b7376bc69b9e9e194a5a97357a597c2228b7173d317320f0360d617b6425212f58 languageName: node linkType: hard @@ -4993,13 +5014,6 @@ __metadata: languageName: node linkType: hard -"@types/scheduler@npm:*": - version: 0.16.2 - resolution: "@types/scheduler@npm:0.16.2" - checksum: b6b4dcfeae6deba2e06a70941860fb1435730576d3689225a421280b7742318d1548b3d22c1f66ab68e414f346a9542f29240bc955b6332c5b11e561077583bc - languageName: node - linkType: hard - "@types/sharp@npm:^0.30.5": version: 0.30.5 resolution: "@types/sharp@npm:0.30.5" @@ -5010,16 +5024,16 @@ __metadata: linkType: hard "@types/supports-color@npm:^8.0.0": - version: 8.1.1 - resolution: "@types/supports-color@npm:8.1.1" - checksum: 6f35588fc423bf6b511167b4aaa0348638567f7a74de24d77dfb930d2053757585e1799d9c903f3db7a23a9ef2518878de9427b20d2f4476899aaf923e98de11 + version: 8.1.3 + resolution: "@types/supports-color@npm:8.1.3" + checksum: f5a3ca4aa94ac9d45beae8aa06dcba45e6d56b77999707a2708b54a9b042f84c68e619b10ef6e4b6f447f801824adebb9ed4d7a82c0b5d5d7bf29d5ff34d53a9 languageName: node linkType: hard "@types/text-table@npm:^0.2.0": - version: 0.2.2 - resolution: "@types/text-table@npm:0.2.2" - checksum: f72ee49b50f2e912876cf7366ca1b218a58826e9af8b3171204f1cb73be80e722e094db3523dd7ddd31708c006b0b3d67ce5a2da6e9620ce99f5c4558109863b + version: 0.2.5 + resolution: "@types/text-table@npm:0.2.5" + checksum: 4e96313dc25983868d84b75921c6159de569509921234c2c3bc8e2aac7963323f326b07d485d2c38342d5c1e7d2a0a39c2f3996b5f00f57af4b554b5d710f59d languageName: node linkType: hard @@ -5030,17 +5044,17 @@ __metadata: languageName: node linkType: hard -"@types/unist@npm:*, @types/unist@npm:^2.0.0, @types/unist@npm:^2.0.2, @types/unist@npm:^2.0.3": - version: 2.0.6 - resolution: "@types/unist@npm:2.0.6" - checksum: 25cb860ff10dde48b54622d58b23e66214211a61c84c0f15f88d38b61aa1b53d4d46e42b557924a93178c501c166aa37e28d7f6d994aba13d24685326272d5db +"@types/unist@npm:*, @types/unist@npm:^3.0.0": + version: 3.0.3 + resolution: "@types/unist@npm:3.0.3" + checksum: 96e6453da9e075aaef1dc22482463898198acdc1eeb99b465e65e34303e2ec1e3b1ed4469a9118275ec284dc98019f63c3f5d49422f0e4ac707e5ab90fb3b71a languageName: node linkType: hard -"@types/unist@npm:^3.0.0": - version: 3.0.2 - resolution: "@types/unist@npm:3.0.2" - checksum: 3d04d0be69316e5f14599a0d993a208606c12818cf631fd399243d1dc7a9bd8a3917d6066baa6abc290814afbd744621484756803c80cba892c39cd4b4a85616 +"@types/unist@npm:^2, @types/unist@npm:^2.0.0, @types/unist@npm:^2.0.2, @types/unist@npm:^2.0.3": + version: 2.0.11 + resolution: "@types/unist@npm:2.0.11" + checksum: 6d436e832bc35c6dde9f056ac515ebf2b3384a1d7f63679d12358766f9b313368077402e9c1126a14d827f10370a5485e628bf61aa91117cf4fc882423191a4e languageName: node linkType: hard @@ -5173,169 +5187,193 @@ __metadata: linkType: hard "@ungap/structured-clone@npm:^1.0.0": - version: 1.2.0 - resolution: "@ungap/structured-clone@npm:1.2.0" - checksum: 4f656b7b4672f2ce6e272f2427d8b0824ed11546a601d8d5412b9d7704e83db38a8d9f402ecdf2b9063fc164af842ad0ec4a55819f621ed7e7ea4d1efcc74524 + version: 1.3.0 + resolution: "@ungap/structured-clone@npm:1.3.0" + checksum: 64ed518f49c2b31f5b50f8570a1e37bde3b62f2460042c50f132430b2d869c4a6586f13aa33a58a4722715b8158c68cae2827389d6752ac54da2893c83e480fc languageName: node linkType: hard "@vercel/webpack-asset-relocator-loader@npm:^1.7.0": - version: 1.7.3 - resolution: "@vercel/webpack-asset-relocator-loader@npm:1.7.3" - dependencies: + version: 1.10.0 + resolution: "@vercel/webpack-asset-relocator-loader@npm:1.10.0" + dependencies: + "@mapbox/node-pre-gyp": ^2.0.0 + acorn: ^8.3.0 + acorn-class-fields: ^1.0.0 + acorn-private-class-elements: ^1.0.0 + acorn-static-class-features: ^1.0.0 + bindings: ^1.4.0 + estree-walker: ^0.6.1 + glob: ^7.1.3 + graceful-fs: ^4.1.15 + loader-utils: ^1.2.3 + magic-string: ^0.25.1 + node-gyp-build: ^4.8.4 resolve: ^1.10.0 - checksum: e4d761e82f5f389206b7261874cc232382984c84f9476fb1c90759507782f8cc8a414ec910e24e63075d28ca5999bdf9d8f3ef2b2e41ea05e477188e8b9669d6 + resolve-from: 3.0.0 + rollup-pluginutils: ^2.8.2 + sourcemap-codec: ^1.4.4 + checksum: ac2b610fffea502b00510f31a33c15a41c3e56f0ace780737c72e64a7c89ca6c421c960b42e250c82750127c9ae9c95a885e545c42169629a6dd684ceacd8235 languageName: node linkType: hard -"@webassemblyjs/ast@npm:1.12.1, @webassemblyjs/ast@npm:^1.12.1": - version: 1.12.1 - resolution: "@webassemblyjs/ast@npm:1.12.1" +"@webassemblyjs/ast@npm:1.14.1, @webassemblyjs/ast@npm:^1.14.1": + version: 1.14.1 + resolution: "@webassemblyjs/ast@npm:1.14.1" dependencies: - "@webassemblyjs/helper-numbers": 1.11.6 - "@webassemblyjs/helper-wasm-bytecode": 1.11.6 - checksum: 31bcc64147236bd7b1b6d29d1f419c1f5845c785e1e42dc9e3f8ca2e05a029e9393a271b84f3a5bff2a32d35f51ff59e2181a6e5f953fe88576acd6750506202 + "@webassemblyjs/helper-numbers": 1.13.2 + "@webassemblyjs/helper-wasm-bytecode": 1.13.2 + checksum: f9154ad9ea14f6f2374ebe918c221fd69a4d4514126a1acc6fa4966e8d27ab28cb550a5e6880032cf620e19640578658a7e5a55bd2aad1e3db4e9d598b8f2099 languageName: node linkType: hard -"@webassemblyjs/floating-point-hex-parser@npm:1.11.6": - version: 1.11.6 - resolution: "@webassemblyjs/floating-point-hex-parser@npm:1.11.6" - checksum: 29b08758841fd8b299c7152eda36b9eb4921e9c584eb4594437b5cd90ed6b920523606eae7316175f89c20628da14326801090167cc7fbffc77af448ac84b7e2 +"@webassemblyjs/floating-point-hex-parser@npm:1.13.2": + version: 1.13.2 + resolution: "@webassemblyjs/floating-point-hex-parser@npm:1.13.2" + checksum: e866ec8433f4a70baa511df5e8f2ebcd6c24f4e2cc6274c7c5aabe2bcce3459ea4680e0f35d450e1f3602acf3913b6b8e4f15069c8cfd34ae8609fb9a7d01795 languageName: node linkType: hard -"@webassemblyjs/helper-api-error@npm:1.11.6": - version: 1.11.6 - resolution: "@webassemblyjs/helper-api-error@npm:1.11.6" - checksum: e8563df85161096343008f9161adb138a6e8f3c2cc338d6a36011aa55eabb32f2fd138ffe63bc278d009ada001cc41d263dadd1c0be01be6c2ed99076103689f +"@webassemblyjs/helper-api-error@npm:1.13.2": + version: 1.13.2 + resolution: "@webassemblyjs/helper-api-error@npm:1.13.2" + checksum: 48b5df7fd3095bb252f59a139fe2cbd999a62ac9b488123e9a0da3906ad8a2f2da7b2eb21d328c01a90da987380928706395c2897d1f3ed9e2125b6d75a920d0 languageName: node linkType: hard -"@webassemblyjs/helper-buffer@npm:1.12.1": - version: 1.12.1 - resolution: "@webassemblyjs/helper-buffer@npm:1.12.1" - checksum: c3ffb723024130308db608e86e2bdccd4868bbb62dffb0a9a1530606496f79c87f8565bd8e02805ce64912b71f1a70ee5fb00307258b0c082c3abf961d097eca +"@webassemblyjs/helper-buffer@npm:1.14.1": + version: 1.14.1 + resolution: "@webassemblyjs/helper-buffer@npm:1.14.1" + checksum: b611e981dfd6a797c3d8fc3a772de29a6e55033737c2c09c31bb66c613bdbb2d25f915df1dee62a602c6acc057ca71128432fa8c3e22a893e1219dc454f14ede languageName: node linkType: hard -"@webassemblyjs/helper-numbers@npm:1.11.6": - version: 1.11.6 - resolution: "@webassemblyjs/helper-numbers@npm:1.11.6" +"@webassemblyjs/helper-numbers@npm:1.13.2": + version: 1.13.2 + resolution: "@webassemblyjs/helper-numbers@npm:1.13.2" dependencies: - "@webassemblyjs/floating-point-hex-parser": 1.11.6 - "@webassemblyjs/helper-api-error": 1.11.6 + "@webassemblyjs/floating-point-hex-parser": 1.13.2 + "@webassemblyjs/helper-api-error": 1.13.2 "@xtuc/long": 4.2.2 - checksum: f4b562fa219f84368528339e0f8d273ad44e047a07641ffcaaec6f93e5b76fd86490a009aa91a294584e1436d74b0a01fa9fde45e333a4c657b58168b04da424 + checksum: 49e2c9bf9b66997e480f6b44d80f895b3cde4de52ac135921d28e144565edca6903a519f627f4089b5509de1d7f9e5023f0e1a94ff78a36c9e2eb30e7c18ffd2 languageName: node linkType: hard -"@webassemblyjs/helper-wasm-bytecode@npm:1.11.6": - version: 1.11.6 - resolution: "@webassemblyjs/helper-wasm-bytecode@npm:1.11.6" - checksum: 3535ef4f1fba38de3475e383b3980f4bbf3de72bbb631c2b6584c7df45be4eccd62c6ff48b5edd3f1bcff275cfd605a37679ec199fc91fd0a7705d7f1e3972dc +"@webassemblyjs/helper-wasm-bytecode@npm:1.13.2": + version: 1.13.2 + resolution: "@webassemblyjs/helper-wasm-bytecode@npm:1.13.2" + checksum: 8e059e1c1f0294f4fc3df8e4eaff3c5ef6e2e1358f34ebc118eaf5070ed59e56ed7fc92b28be734ebde17c8d662d5d27e06ade686c282445135da083ae11c128 languageName: node linkType: hard -"@webassemblyjs/helper-wasm-section@npm:1.12.1": - version: 1.12.1 - resolution: "@webassemblyjs/helper-wasm-section@npm:1.12.1" +"@webassemblyjs/helper-wasm-section@npm:1.14.1": + version: 1.14.1 + resolution: "@webassemblyjs/helper-wasm-section@npm:1.14.1" dependencies: - "@webassemblyjs/ast": 1.12.1 - "@webassemblyjs/helper-buffer": 1.12.1 - "@webassemblyjs/helper-wasm-bytecode": 1.11.6 - "@webassemblyjs/wasm-gen": 1.12.1 - checksum: c19810cdd2c90ff574139b6d8c0dda254d42d168a9e5b3d353d1bc085f1d7164ccd1b3c05592a45a939c47f7e403dc8d03572bb686642f06a3d02932f6f0bc8f + "@webassemblyjs/ast": 1.14.1 + "@webassemblyjs/helper-buffer": 1.14.1 + "@webassemblyjs/helper-wasm-bytecode": 1.13.2 + "@webassemblyjs/wasm-gen": 1.14.1 + checksum: 0a08d454a63192cd66abf91b6f060ac4b466cef341262246e9dcc828dd4c8536195dea9b46a1244b1eac65b59b8b502164a771a190052a92ff0a0a2ded0f8f53 languageName: node linkType: hard -"@webassemblyjs/ieee754@npm:1.11.6": - version: 1.11.6 - resolution: "@webassemblyjs/ieee754@npm:1.11.6" +"@webassemblyjs/ieee754@npm:1.13.2": + version: 1.13.2 + resolution: "@webassemblyjs/ieee754@npm:1.13.2" dependencies: "@xtuc/ieee754": ^1.2.0 - checksum: 13574b8e41f6ca39b700e292d7edf102577db5650fe8add7066a320aa4b7a7c09a5056feccac7a74eb68c10dea9546d4461412af351f13f6b24b5f32379b49de + checksum: d7e3520baa37a7309fa7db4d73d69fb869878853b1ebd4b168821bd03fcc4c0e1669c06231315b0039035d9a7a462e53de3ad982da4a426a4b0743b5888e8673 languageName: node linkType: hard -"@webassemblyjs/leb128@npm:1.11.6": - version: 1.11.6 - resolution: "@webassemblyjs/leb128@npm:1.11.6" +"@webassemblyjs/leb128@npm:1.13.2": + version: 1.13.2 + resolution: "@webassemblyjs/leb128@npm:1.13.2" dependencies: "@xtuc/long": 4.2.2 - checksum: 7ea942dc9777d4b18a5ebfa3a937b30ae9e1d2ce1fee637583ed7f376334dd1d4274f813d2e250056cca803e0952def4b954913f1a3c9068bcd4ab4ee5143bf0 + checksum: 64083507f7cff477a6d71a9e325d95665cea78ec8df99ca7c050e1cfbe300fbcf0842ca3dcf3b4fa55028350135588a4f879398d3dd2b6a8de9913ce7faf5333 languageName: node linkType: hard -"@webassemblyjs/utf8@npm:1.11.6": - version: 1.11.6 - resolution: "@webassemblyjs/utf8@npm:1.11.6" - checksum: 807fe5b5ce10c390cfdd93e0fb92abda8aebabb5199980681e7c3743ee3306a75729bcd1e56a3903980e96c885ee53ef901fcbaac8efdfa480f9c0dae1d08713 +"@webassemblyjs/utf8@npm:1.13.2": + version: 1.13.2 + resolution: "@webassemblyjs/utf8@npm:1.13.2" + checksum: 95ec6052f30eefa8d50c9b2a3394d08b17d53a4aa52821451d41d774c126fa8f39b988fbf5bff56da86852a87c16d676e576775a4071e5e5ccf020cc85a4b281 languageName: node linkType: hard -"@webassemblyjs/wasm-edit@npm:^1.12.1": - version: 1.12.1 - resolution: "@webassemblyjs/wasm-edit@npm:1.12.1" +"@webassemblyjs/wasm-edit@npm:^1.14.1": + version: 1.14.1 + resolution: "@webassemblyjs/wasm-edit@npm:1.14.1" dependencies: - "@webassemblyjs/ast": 1.12.1 - "@webassemblyjs/helper-buffer": 1.12.1 - "@webassemblyjs/helper-wasm-bytecode": 1.11.6 - "@webassemblyjs/helper-wasm-section": 1.12.1 - "@webassemblyjs/wasm-gen": 1.12.1 - "@webassemblyjs/wasm-opt": 1.12.1 - "@webassemblyjs/wasm-parser": 1.12.1 - "@webassemblyjs/wast-printer": 1.12.1 - checksum: ae23642303f030af888d30c4ef37b08dfec7eab6851a9575a616e65d1219f880d9223913a39056dd654e49049d76e97555b285d1f7e56935047abf578cce0692 + "@webassemblyjs/ast": 1.14.1 + "@webassemblyjs/helper-buffer": 1.14.1 + "@webassemblyjs/helper-wasm-bytecode": 1.13.2 + "@webassemblyjs/helper-wasm-section": 1.14.1 + "@webassemblyjs/wasm-gen": 1.14.1 + "@webassemblyjs/wasm-opt": 1.14.1 + "@webassemblyjs/wasm-parser": 1.14.1 + "@webassemblyjs/wast-printer": 1.14.1 + checksum: 9341c3146bb1b7863f03d6050c2a66990f20384ca137388047bbe1feffacb599e94fca7b7c18287d17e2449ffb4005fdc7f41f674a6975af9ad8522756f8ffff languageName: node linkType: hard -"@webassemblyjs/wasm-gen@npm:1.12.1": - version: 1.12.1 - resolution: "@webassemblyjs/wasm-gen@npm:1.12.1" +"@webassemblyjs/wasm-gen@npm:1.14.1": + version: 1.14.1 + resolution: "@webassemblyjs/wasm-gen@npm:1.14.1" dependencies: - "@webassemblyjs/ast": 1.12.1 - "@webassemblyjs/helper-wasm-bytecode": 1.11.6 - "@webassemblyjs/ieee754": 1.11.6 - "@webassemblyjs/leb128": 1.11.6 - "@webassemblyjs/utf8": 1.11.6 - checksum: 5787626bb7f0b033044471ddd00ce0c9fe1ee4584e8b73e232051e3a4c99ba1a102700d75337151c8b6055bae77eefa4548960c610a5e4a504e356bd872138ff + "@webassemblyjs/ast": 1.14.1 + "@webassemblyjs/helper-wasm-bytecode": 1.13.2 + "@webassemblyjs/ieee754": 1.13.2 + "@webassemblyjs/leb128": 1.13.2 + "@webassemblyjs/utf8": 1.13.2 + checksum: 401b12bec7431c4fc29d9414bbe40d3c6dc5be04d25a116657c42329f5481f0129f3b5834c293f26f0e42681ceac9157bf078ce9bdb6a7f78037c650373f98b2 languageName: node linkType: hard -"@webassemblyjs/wasm-opt@npm:1.12.1": - version: 1.12.1 - resolution: "@webassemblyjs/wasm-opt@npm:1.12.1" +"@webassemblyjs/wasm-opt@npm:1.14.1": + version: 1.14.1 + resolution: "@webassemblyjs/wasm-opt@npm:1.14.1" dependencies: - "@webassemblyjs/ast": 1.12.1 - "@webassemblyjs/helper-buffer": 1.12.1 - "@webassemblyjs/wasm-gen": 1.12.1 - "@webassemblyjs/wasm-parser": 1.12.1 - checksum: 0e8fa8a0645304a1e18ff40d3db5a2e9233ebaa169b19fcc651d6fc9fe2cac0ce092ddee927318015ae735d9cd9c5d97c0cafb6a51dcd2932ac73587b62df991 + "@webassemblyjs/ast": 1.14.1 + "@webassemblyjs/helper-buffer": 1.14.1 + "@webassemblyjs/wasm-gen": 1.14.1 + "@webassemblyjs/wasm-parser": 1.14.1 + checksum: 60c697a9e9129d8d23573856df0791ba33cea4a3bc2339044cae73128c0983802e5e50a42157b990eeafe1237eb8e7653db6de5f02b54a0ae7b81b02dcdf2ae9 languageName: node linkType: hard -"@webassemblyjs/wasm-parser@npm:1.12.1, @webassemblyjs/wasm-parser@npm:^1.12.1": - version: 1.12.1 - resolution: "@webassemblyjs/wasm-parser@npm:1.12.1" +"@webassemblyjs/wasm-parser@npm:1.14.1, @webassemblyjs/wasm-parser@npm:^1.14.1": + version: 1.14.1 + resolution: "@webassemblyjs/wasm-parser@npm:1.14.1" dependencies: - "@webassemblyjs/ast": 1.12.1 - "@webassemblyjs/helper-api-error": 1.11.6 - "@webassemblyjs/helper-wasm-bytecode": 1.11.6 - "@webassemblyjs/ieee754": 1.11.6 - "@webassemblyjs/leb128": 1.11.6 - "@webassemblyjs/utf8": 1.11.6 - checksum: 176015de3551ac068cd4505d837414f258d9ade7442bd71efb1232fa26c9f6d7d4e11a5c816caeed389943f409af7ebff6899289a992d7a70343cb47009d21a8 + "@webassemblyjs/ast": 1.14.1 + "@webassemblyjs/helper-api-error": 1.13.2 + "@webassemblyjs/helper-wasm-bytecode": 1.13.2 + "@webassemblyjs/ieee754": 1.13.2 + "@webassemblyjs/leb128": 1.13.2 + "@webassemblyjs/utf8": 1.13.2 + checksum: 93f1fe2676da465b4e824419d9812a3d7218de4c3addd4e916c04bc86055fa134416c1b67e4b7cbde8d728c0dce2721d06cc0bfe7a7db7c093a0898009937405 languageName: node linkType: hard -"@webassemblyjs/wast-printer@npm:1.12.1": - version: 1.12.1 - resolution: "@webassemblyjs/wast-printer@npm:1.12.1" +"@webassemblyjs/wast-printer@npm:1.14.1": + version: 1.14.1 + resolution: "@webassemblyjs/wast-printer@npm:1.14.1" dependencies: - "@webassemblyjs/ast": 1.12.1 + "@webassemblyjs/ast": 1.14.1 "@xtuc/long": 4.2.2 - checksum: 2974b5dda8d769145ba0efd886ea94a601e61fb37114c14f9a9a7606afc23456799af652ac3052f284909bd42edc3665a76bc9b50f95f0794c053a8a1757b713 + checksum: 517881a0554debe6945de719d100b2d8883a2d24ddf47552cdeda866341e2bb153cd824a864bc7e2a61190a4b66b18f9899907e0074e9e820d2912ac0789ea60 + languageName: node + linkType: hard + +"@whatwg-node/promise-helpers@npm:^1.0.0": + version: 1.3.2 + resolution: "@whatwg-node/promise-helpers@npm:1.3.2" + dependencies: + tslib: ^2.6.3 + checksum: 62efb129a2c1f36ee3ea63cf65dbd517fab13e8dd6968e32a29219558a76a7725bbff646f4fc9fb80f793466659a8e6b9e70cf5de258ddaa60c5a7bd762630a4 languageName: node linkType: hard @@ -5360,7 +5398,7 @@ __metadata: languageName: node linkType: hard -"abbrev@npm:1, abbrev@npm:^1.0.0": +"abbrev@npm:1": version: 1.1.1 resolution: "abbrev@npm:1.1.1" checksum: a4a97ec07d7ea112c517036882b2ac22f3109b7b19077dc656316d07d308438aac28e4d9746dc4d84bf6b1e75b4a7b0a5f3cb30592419f128ca9a8cee3bcfa17 @@ -5374,14 +5412,37 @@ __metadata: languageName: node linkType: hard +"abbrev@npm:^3.0.0": + version: 3.0.1 + resolution: "abbrev@npm:3.0.1" + checksum: e70b209f5f408dd3a3bbd0eec4b10a2ffd64704a4a3821d0969d84928cc490a8eb60f85b78a95622c1841113edac10161c62e52f5e7d0027aa26786a8136e02e + languageName: node + linkType: hard + +"abbrev@npm:^4.0.0": + version: 4.0.0 + resolution: "abbrev@npm:4.0.0" + checksum: d0344b63d28e763f259b4898c41bdc92c08e9d06d0da5617d0bbe4d78244e46daea88c510a2f9472af59b031d9060ec1a999653144e793fd029a59dae2f56dc8 + languageName: node + linkType: hard + +"abort-controller@npm:^3.0.0": + version: 3.0.0 + resolution: "abort-controller@npm:3.0.0" + dependencies: + event-target-shim: ^5.0.0 + checksum: 170bdba9b47b7e65906a28c8ce4f38a7a369d78e2271706f020849c1bfe0ee2067d4261df8bbb66eb84f79208fd5b710df759d64191db58cfba7ce8ef9c54b75 + languageName: node + linkType: hard + "abortcontroller-polyfill@npm:^1.1.9": - version: 1.7.5 - resolution: "abortcontroller-polyfill@npm:1.7.5" - checksum: daf4169f4228ae0e4f4dbcfa782e501b923667f2666b7c55bd3b7664e5d6b100e333a93371173985fdf21f65d7dfba15bdb2e6031bdc9e57e4ce0297147da3aa + version: 1.7.8 + resolution: "abortcontroller-polyfill@npm:1.7.8" + checksum: 0d270890d8d145a5373dcdf26ac7b512f41536a1804482c332e52a31cefcb1fd6ea082cc3b946a34ad23dea7d740b071e8efa935c667fe52b48d42b6f8388f10 languageName: node linkType: hard -"accepts@npm:^1.3.7, accepts@npm:~1.3.4, accepts@npm:~1.3.5, accepts@npm:~1.3.8": +"accepts@npm:^1.3.7, accepts@npm:~1.3.4, accepts@npm:~1.3.8": version: 1.3.8 resolution: "accepts@npm:1.3.8" dependencies: @@ -5391,6 +5452,17 @@ __metadata: languageName: node linkType: hard +"acorn-class-fields@npm:^1.0.0": + version: 1.0.0 + resolution: "acorn-class-fields@npm:1.0.0" + dependencies: + acorn-private-class-elements: ^1.0.0 + peerDependencies: + acorn: ^6 || ^7 || ^8 + checksum: 14ff899a7dc174816bb65e036a2e03e170d8157d6db17a933a1f8acbf52ccf3108369a1e63269f01a5a7caa92042ebdc70998eb77b79a82558b617c9c36a95b5 + languageName: node + linkType: hard + "acorn-globals@npm:^4.1.0": version: 4.3.4 resolution: "acorn-globals@npm:4.3.4" @@ -5411,12 +5483,12 @@ __metadata: languageName: node linkType: hard -"acorn-import-attributes@npm:^1.9.5": - version: 1.9.5 - resolution: "acorn-import-attributes@npm:1.9.5" +"acorn-import-phases@npm:^1.0.3": + version: 1.0.4 + resolution: "acorn-import-phases@npm:1.0.4" peerDependencies: - acorn: ^8 - checksum: 1c0c49b6a244503964ae46ae850baccf306e84caf99bc2010ed6103c69a423987b07b520a6c619f075d215388bd4923eccac995886a54309eda049ab78a4be95 + acorn: ^8.14.0 + checksum: e669cccfb6711af305150fcbfddcf4485fffdc4547a0ecabebe94103b47124cc02bfd186240061c00ac954cfb0461b4ecc3e203e138e43042b7af32063fa9510 languageName: node linkType: hard @@ -5429,6 +5501,26 @@ __metadata: languageName: node linkType: hard +"acorn-private-class-elements@npm:^1.0.0": + version: 1.0.0 + resolution: "acorn-private-class-elements@npm:1.0.0" + peerDependencies: + acorn: ^6.1.0 || ^7 || ^8 + checksum: e32dd10e3b33c5eb85148b651b22c610e7c10325cac4461093d724eca04e1281c57be2cc01d571f1b985576e3ea9e5ab1210b67e30cd985e53c8ca1eda3b05ec + languageName: node + linkType: hard + +"acorn-static-class-features@npm:^1.0.0": + version: 1.0.0 + resolution: "acorn-static-class-features@npm:1.0.0" + dependencies: + acorn-private-class-elements: ^1.0.0 + peerDependencies: + acorn: ^6.1.0 || ^7 || ^8 + checksum: 3b412af8a6bbd0fb63fbbde51e03f122bb8ea7fcc3de449f092291134e11d286d9733b3e615e7d16dd986bbf5110fde41b8ab16e10a1f879961648370e7bee3b + languageName: node + linkType: hard + "acorn-walk@npm:^6.0.1": version: 6.2.0 resolution: "acorn-walk@npm:6.2.0" @@ -5437,9 +5529,11 @@ __metadata: linkType: hard "acorn-walk@npm:^8.0.2": - version: 8.2.0 - resolution: "acorn-walk@npm:8.2.0" - checksum: 1715e76c01dd7b2d4ca472f9c58968516a4899378a63ad5b6c2d668bba8da21a71976c14ec5f5b75f887b6317c4ae0b897ab141c831d741dc76024d8745f1ad1 + version: 8.3.4 + resolution: "acorn-walk@npm:8.3.4" + dependencies: + acorn: ^8.11.0 + checksum: 4ff03f42323e7cf90f1683e08606b0f460e1e6ac263d2730e3df91c7665b6f64e696db6ea27ee4bed18c2599569be61f28a8399fa170c611161a348c402ca19c languageName: node linkType: hard @@ -5470,21 +5564,12 @@ __metadata: languageName: node linkType: hard -"acorn@npm:^8.1.0, acorn@npm:^8.5.0, acorn@npm:^8.7.1, acorn@npm:^8.8.0": - version: 8.8.1 - resolution: "acorn@npm:8.8.1" - bin: - acorn: bin/acorn - checksum: 4079b67283b94935157698831967642f24a075c52ce3feaaaafe095776dfbe15d86a1b33b1e53860fc0d062ed6c83f4284a5c87c85b9ad51853a01173da6097f - languageName: node - linkType: hard - -"acorn@npm:^8.8.2": - version: 8.12.1 - resolution: "acorn@npm:8.12.1" +"acorn@npm:^8.1.0, acorn@npm:^8.11.0, acorn@npm:^8.15.0, acorn@npm:^8.3.0, acorn@npm:^8.8.1": + version: 8.15.0 + resolution: "acorn@npm:8.15.0" bin: acorn: bin/acorn - checksum: 677880034aee5bdf7434cc2d25b641d7bedb0b5ef47868a78dadabedccf58e1c5457526d9d8249cd253f2df087e081c3fe7d903b448d8e19e5131a3065b83c07 + checksum: 309c6b49aedf1a2e34aaf266de06de04aab6eb097c02375c66fdeb0f64556a6a823540409914fb364d9a11bc30d79d485a2eba29af47992d3490e9886c4391c3 languageName: node linkType: hard @@ -5496,13 +5581,13 @@ __metadata: linkType: hard "address@npm:^1.0.1, address@npm:^1.1.2": - version: 1.2.1 - resolution: "address@npm:1.2.1" - checksum: e4c0f961464ccad09c3f7ed3a8d12f609354a87dd1ad379e43661e9684446fbf158be3edeef85e1590dfc6c88c0897c5908bc18f232eb86e43993a2ada5820fa + version: 1.2.2 + resolution: "address@npm:1.2.2" + checksum: ace439960c1e3564d8f523aff23a841904bf33a2a7c2e064f7f60a064194075758b9690e65bd9785692a4ef698a998c57eb74d145881a1cecab8ba658ddb1607 languageName: node linkType: hard -"agent-base@npm:6, agent-base@npm:^6.0.2": +"agent-base@npm:6": version: 6.0.2 resolution: "agent-base@npm:6.0.2" dependencies: @@ -5511,28 +5596,14 @@ __metadata: languageName: node linkType: hard -"agentkeepalive@npm:^4.2.1": - version: 4.2.1 - resolution: "agentkeepalive@npm:4.2.1" - dependencies: - debug: ^4.1.0 - depd: ^1.1.2 - humanize-ms: ^1.2.1 - checksum: 39cb49ed8cf217fd6da058a92828a0a84e0b74c35550f82ee0a10e1ee403c4b78ade7948be2279b188b7a7303f5d396ea2738b134731e464bf28de00a4f72a18 - languageName: node - linkType: hard - -"aggregate-error@npm:^3.0.0": - version: 3.1.0 - resolution: "aggregate-error@npm:3.1.0" - dependencies: - clean-stack: ^2.0.0 - indent-string: ^4.0.0 - checksum: 1101a33f21baa27a2fa8e04b698271e64616b886795fd43c31068c07533c7b3facfcaf4e9e0cab3624bd88f729a592f1c901a1a229c9e490eafce411a8644b79 +"agent-base@npm:^7.1.0, agent-base@npm:^7.1.2": + version: 7.1.4 + resolution: "agent-base@npm:7.1.4" + checksum: 86a7f542af277cfbd77dd61e7df8422f90bac512953709003a1c530171a9d019d072e2400eab2b59f84b49ab9dd237be44315ca663ac73e82b3922d10ea5eafa languageName: node linkType: hard -"ajv-formats@npm:2.1.1": +"ajv-formats@npm:2.1.1, ajv-formats@npm:^2.1.1": version: 2.1.1 resolution: "ajv-formats@npm:2.1.1" dependencies: @@ -5555,7 +5626,18 @@ __metadata: languageName: node linkType: hard -"ajv@npm:8.12.0, ajv@npm:^8.0.0": +"ajv-keywords@npm:^5.1.0": + version: 5.1.0 + resolution: "ajv-keywords@npm:5.1.0" + dependencies: + fast-deep-equal: ^3.1.3 + peerDependencies: + ajv: ^8.8.2 + checksum: c35193940b853119242c6757787f09ecf89a2c19bcd36d03ed1a615e710d19d450cb448bfda407b939aba54b002368c8bff30529cc50a0536a8e10bcce300421 + languageName: node + linkType: hard + +"ajv@npm:8.12.0": version: 8.12.0 resolution: "ajv@npm:8.12.0" dependencies: @@ -5579,15 +5661,15 @@ __metadata: languageName: node linkType: hard -"ajv@npm:^8.0.1": - version: 8.11.0 - resolution: "ajv@npm:8.11.0" +"ajv@npm:^8.0.0, ajv@npm:^8.0.1, ajv@npm:^8.9.0": + version: 8.17.1 + resolution: "ajv@npm:8.17.1" dependencies: - fast-deep-equal: ^3.1.1 + fast-deep-equal: ^3.1.3 + fast-uri: ^3.0.1 json-schema-traverse: ^1.0.0 require-from-string: ^2.0.2 - uri-js: ^4.2.2 - checksum: 5e0ff226806763be73e93dd7805b634f6f5921e3e90ca04acdf8db81eed9d8d3f0d4c5f1213047f45ebbf8047ffe0c840fa1ef2ec42c3a644899f69aa72b5bef + checksum: 1797bf242cfffbaf3b870d13565bd1716b73f214bb7ada9a497063aada210200da36e3ed40237285f3255acc4feeae91b1fb183625331bad27da95973f7253d9 languageName: node linkType: hard @@ -5602,31 +5684,32 @@ __metadata: linkType: hard "algoliasearch@npm:^4.14.2, algoliasearch@npm:^4.9.1": - version: 4.14.2 - resolution: "algoliasearch@npm:4.14.2" - dependencies: - "@algolia/cache-browser-local-storage": 4.14.2 - "@algolia/cache-common": 4.14.2 - "@algolia/cache-in-memory": 4.14.2 - "@algolia/client-account": 4.14.2 - "@algolia/client-analytics": 4.14.2 - "@algolia/client-common": 4.14.2 - "@algolia/client-personalization": 4.14.2 - "@algolia/client-search": 4.14.2 - "@algolia/logger-common": 4.14.2 - "@algolia/logger-console": 4.14.2 - "@algolia/requester-browser-xhr": 4.14.2 - "@algolia/requester-common": 4.14.2 - "@algolia/requester-node-http": 4.14.2 - "@algolia/transporter": 4.14.2 - checksum: 4365a0d0f066f3ad6798e4dd0d7487cba1cf4546dac27e66cb84865f91955d6537dc5bad4e71d4bf22a68c0b721b1e6f20109203566ca1a252fe2713d713c0fd + version: 4.25.3 + resolution: "algoliasearch@npm:4.25.3" + dependencies: + "@algolia/cache-browser-local-storage": 4.25.3 + "@algolia/cache-common": 4.25.3 + "@algolia/cache-in-memory": 4.25.3 + "@algolia/client-account": 4.25.3 + "@algolia/client-analytics": 4.25.3 + "@algolia/client-common": 4.25.3 + "@algolia/client-personalization": 4.25.3 + "@algolia/client-search": 4.25.3 + "@algolia/logger-common": 4.25.3 + "@algolia/logger-console": 4.25.3 + "@algolia/recommend": 4.25.3 + "@algolia/requester-browser-xhr": 4.25.3 + "@algolia/requester-common": 4.25.3 + "@algolia/requester-node-http": 4.25.3 + "@algolia/transporter": 4.25.3 + checksum: 9b7e1511d3a8caaed902f70c7025c77cead8d8f4fefe310da827f1c03865a5e17dfb7f9f23dfac0c4caff5c2b0222eb0f552922b1991259344f8cdd4810a8d31 languageName: node linkType: hard "anser@npm:^2.1.0": - version: 2.1.1 - resolution: "anser@npm:2.1.1" - checksum: 29b99ae7c54e7107643a130a07228f853b4c28d7742db40dadca2f405263a1d30202e1c1a576644f2162e795e556591dc05fa4a6d77c49a028dfa05f73d76dae + version: 2.3.5 + resolution: "anser@npm:2.3.5" + checksum: c8a0cf15aac0abf08e35962f1f50b8f11ae232c41066b6d2134c6d1bdf475ec14814052bbbd7c5c63d1eb8f471050a04daa5b5c757007e66489231169c11b986 languageName: node linkType: hard @@ -5646,14 +5729,7 @@ __metadata: languageName: node linkType: hard -"ansi-escapes@npm:^3.1.0": - version: 3.2.0 - resolution: "ansi-escapes@npm:3.2.0" - checksum: 0f94695b677ea742f7f1eed961f7fd8d05670f744c6ad1f8f635362f6681dcfbc1575cb05b43abc7bb6d67e25a75fb8c7ea8f2a57330eb2c76b33f18cb2cef0a - languageName: node - linkType: hard - -"ansi-escapes@npm:^4.2.1": +"ansi-escapes@npm:^4.2.1, ansi-escapes@npm:^4.3.2": version: 4.3.2 resolution: "ansi-escapes@npm:4.3.2" dependencies: @@ -5662,7 +5738,7 @@ __metadata: languageName: node linkType: hard -"ansi-html-community@npm:0.0.8, ansi-html-community@npm:^0.0.8": +"ansi-html-community@npm:0.0.8": version: 0.0.8 resolution: "ansi-html-community@npm:0.0.8" bin: @@ -5671,6 +5747,15 @@ __metadata: languageName: node linkType: hard +"ansi-html@npm:^0.0.9": + version: 0.0.9 + resolution: "ansi-html@npm:0.0.9" + bin: + ansi-html: bin/ansi-html + checksum: a03754d6f66bae33938ed8bb3dd98174b7f4895ebe45226185036ed4a1388a7aaf2f2b9581608f0626432ba7add92cfc590aa6475a78bbb90d9d1e1d1af8cbe6 + languageName: node + linkType: hard + "ansi-regex@npm:^2.0.0": version: 2.1.1 resolution: "ansi-regex@npm:2.1.1" @@ -5693,9 +5778,9 @@ __metadata: linkType: hard "ansi-regex@npm:^6.0.1": - version: 6.0.1 - resolution: "ansi-regex@npm:6.0.1" - checksum: 1ff8b7667cded1de4fa2c9ae283e979fc87036864317da86a2e546725f96406746411d0d85e87a2d12fa5abd715d90006de7fa4fa0477c92321ad3b4c7d4e169 + version: 6.2.2 + resolution: "ansi-regex@npm:6.2.2" + checksum: 9b17ce2c6daecc75bcd5966b9ad672c23b184dc3ed9bf3c98a0702f0d2f736c15c10d461913568f2cf527a5e64291c7473358885dd493305c84a1cfed66ba94f languageName: node linkType: hard @@ -5725,9 +5810,9 @@ __metadata: linkType: hard "ansi-styles@npm:^6.1.0": - version: 6.2.1 - resolution: "ansi-styles@npm:6.2.1" - checksum: ef940f2f0ced1a6347398da88a91da7930c33ecac3c77b72c5905f8b8fe402c52e6fde304ff5347f616e27a742da3f1dc76de98f6866c69251ad0b07a66776d9 + version: 6.2.3 + resolution: "ansi-styles@npm:6.2.3" + checksum: f1b0829cf048cce870a305819f65ce2adcebc097b6d6479e12e955fd6225df9b9eb8b497083b764df796d94383ff20016cc4dbbae5b40f36138fb65a9d33c2e2 languageName: node linkType: hard @@ -5739,12 +5824,12 @@ __metadata: linkType: hard "anymatch@npm:~3.1.2": - version: 3.1.2 - resolution: "anymatch@npm:3.1.2" + version: 3.1.3 + resolution: "anymatch@npm:3.1.3" dependencies: normalize-path: ^3.0.0 picomatch: ^2.0.4 - checksum: 985163db2292fac9e5a1e072bf99f1b5baccf196e4de25a0b0b81865ebddeb3b3eb4480734ef0a2ac8c002845396b91aa89121f5b84f93981a4658164a9ec6e9 + checksum: 3e044fd6d1d26545f235a9fe4d7a534e2029d8e59fa7fd9f2a6eb21230f6b5380ea1eaf55136e60cbf8e613544b3b766e7a6fa2102e2a3a117505466e3025dc2 languageName: node linkType: hard @@ -5756,16 +5841,9 @@ __metadata: linkType: hard "application-config-path@npm:^0.1.0": - version: 0.1.0 - resolution: "application-config-path@npm:0.1.0" - checksum: 573f45766f0af050ddecfcd3ecda0e8a0a33f67e1143c1d45e3cc01b4081feb4031afe58e0e04509ca73e8695b787278c375e2c95c35714af3d8b2d00dadb6da - languageName: node - linkType: hard - -"aproba@npm:^1.0.3 || ^2.0.0": - version: 2.0.0 - resolution: "aproba@npm:2.0.0" - checksum: 5615cadcfb45289eea63f8afd064ab656006361020e1735112e346593856f87435e02d8dcc7ff0d11928bc7d425f27bc7c2a84f6c0b35ab0ff659c814c138a24 + version: 0.1.1 + resolution: "application-config-path@npm:0.1.1" + checksum: e478c1e4d515108de89693165d92dab11cfdc69dd0f3ccde034f14a3f4e50007946de9e4dd51cd77d2f7ba9752e75d8e4d937ef053a53e466425d9751c961a37 languageName: node linkType: hard @@ -5776,16 +5854,6 @@ __metadata: languageName: node linkType: hard -"are-we-there-yet@npm:^3.0.0": - version: 3.0.1 - resolution: "are-we-there-yet@npm:3.0.1" - dependencies: - delegates: ^1.0.0 - readable-stream: ^3.6.0 - checksum: 52590c24860fa7173bedeb69a4c05fb573473e860197f618b9a28432ee4379049336727ae3a1f9c4cb083114601c1140cee578376164d0e651217a9843f9fe83 - languageName: node - linkType: hard - "argparse@npm:^1.0.7": version: 1.0.10 resolution: "argparse@npm:1.0.10" @@ -5802,12 +5870,20 @@ __metadata: languageName: node linkType: hard -"aria-query@npm:^5.1.3": - version: 5.1.3 - resolution: "aria-query@npm:5.1.3" +"aria-query@npm:^5.3.2": + version: 5.3.2 + resolution: "aria-query@npm:5.3.2" + checksum: d971175c85c10df0f6d14adfe6f1292409196114ab3c62f238e208b53103686f46cc70695a4f775b73bc65f6a09b6a092fd963c4f3a5a7d690c8fc5094925717 + languageName: node + linkType: hard + +"array-buffer-byte-length@npm:^1.0.0, array-buffer-byte-length@npm:^1.0.1, array-buffer-byte-length@npm:^1.0.2": + version: 1.0.2 + resolution: "array-buffer-byte-length@npm:1.0.2" dependencies: - deep-equal: ^2.0.5 - checksum: 929ff95f02857b650fb4cbcd2f41072eee2f46159a6605ea03bf63aa572e35ffdff43d69e815ddc462e16e07de8faba3978afc2813650b4448ee18c9895d982b + call-bound: ^1.0.3 + is-array-buffer: ^3.0.5 + checksum: 0ae3786195c3211b423e5be8dd93357870e6fb66357d81da968c2c39ef43583ef6eece1f9cb1caccdae4806739c65dea832b44b8593414313cd76a89795fca63 languageName: node linkType: hard @@ -5819,9 +5895,9 @@ __metadata: linkType: hard "array-equal@npm:^1.0.0": - version: 1.0.0 - resolution: "array-equal@npm:1.0.0" - checksum: 3f68045806357db9b2fa1ad583e42a659de030633118a0cd35ee4975cb20db3b9a3d36bbec9b5afe70011cf989eefd215c12fe0ce08c498f770859ca6e70688a + version: 1.0.2 + resolution: "array-equal@npm:1.0.2" + checksum: 5c37df0cad330516d1255663dfa4fa761fb0ea63878f535aa70dfefe5499853a8b372faf0a27b91781ca1230f4b4333bbeb751e9b1748527d96df2bee30032ea languageName: node linkType: hard @@ -5832,16 +5908,19 @@ __metadata: languageName: node linkType: hard -"array-includes@npm:^3.1.4, array-includes@npm:^3.1.5, array-includes@npm:^3.1.6": - version: 3.1.6 - resolution: "array-includes@npm:3.1.6" +"array-includes@npm:^3.1.6, array-includes@npm:^3.1.8, array-includes@npm:^3.1.9": + version: 3.1.9 + resolution: "array-includes@npm:3.1.9" dependencies: - call-bind: ^1.0.2 - define-properties: ^1.1.4 - es-abstract: ^1.20.4 - get-intrinsic: ^1.1.3 - is-string: ^1.0.7 - checksum: f22f8cd8ba8a6448d91eebdc69f04e4e55085d09232b5216ee2d476dab3ef59984e8d1889e662c6a0ed939dcb1b57fd05b2c0209c3370942fc41b752c82a2ca5 + call-bind: ^1.0.8 + call-bound: ^1.0.4 + define-properties: ^1.2.1 + es-abstract: ^1.24.0 + es-object-atoms: ^1.1.1 + get-intrinsic: ^1.3.0 + is-string: ^1.1.1 + math-intrinsics: ^1.1.0 + checksum: b58dc526fe415252e50319eaf88336e06e75aa673e3b58d252414739a4612dbe56e7b613fdcc7c90561dc9cf9202bbe5ca029ccd8c08362746459475ae5a8f3e languageName: node linkType: hard @@ -5866,27 +5945,84 @@ __metadata: languageName: node linkType: hard -"array.prototype.flat@npm:^1.2.5": - version: 1.3.1 - resolution: "array.prototype.flat@npm:1.3.1" +"array.prototype.findlast@npm:^1.2.5": + version: 1.2.5 + resolution: "array.prototype.findlast@npm:1.2.5" dependencies: - call-bind: ^1.0.2 - define-properties: ^1.1.4 - es-abstract: ^1.20.4 - es-shim-unscopables: ^1.0.0 - checksum: 5a8415949df79bf6e01afd7e8839bbde5a3581300e8ad5d8449dea52639e9e59b26a467665622783697917b43bf39940a6e621877c7dd9b3d1c1f97484b9b88b + call-bind: ^1.0.7 + define-properties: ^1.2.1 + es-abstract: ^1.23.2 + es-errors: ^1.3.0 + es-object-atoms: ^1.0.0 + es-shim-unscopables: ^1.0.2 + checksum: 83ce4ad95bae07f136d316f5a7c3a5b911ac3296c3476abe60225bc4a17938bf37541972fcc37dd5adbc99cbb9c928c70bbbfc1c1ce549d41a415144030bb446 languageName: node linkType: hard -"array.prototype.flatmap@npm:^1.3.0, array.prototype.flatmap@npm:^1.3.1": - version: 1.3.1 - resolution: "array.prototype.flatmap@npm:1.3.1" +"array.prototype.findlastindex@npm:^1.2.6": + version: 1.2.6 + resolution: "array.prototype.findlastindex@npm:1.2.6" dependencies: - call-bind: ^1.0.2 - define-properties: ^1.1.4 - es-abstract: ^1.20.4 - es-shim-unscopables: ^1.0.0 - checksum: 8c1c43a4995f12cf12523436da28515184c753807b3f0bc2ca6c075f71c470b099e2090cc67dba8e5280958fea401c1d0c59e1db0143272aef6cd1103921a987 + call-bind: ^1.0.8 + call-bound: ^1.0.4 + define-properties: ^1.2.1 + es-abstract: ^1.23.9 + es-errors: ^1.3.0 + es-object-atoms: ^1.1.1 + es-shim-unscopables: ^1.1.0 + checksum: bd2665bd51f674d4e1588ce5d5848a8adb255f414070e8e652585598b801480516df2c6cef2c60b6ea1a9189140411c49157a3f112d52e9eabb4e9fc80936ea6 + languageName: node + linkType: hard + +"array.prototype.flat@npm:^1.3.1, array.prototype.flat@npm:^1.3.3": + version: 1.3.3 + resolution: "array.prototype.flat@npm:1.3.3" + dependencies: + call-bind: ^1.0.8 + define-properties: ^1.2.1 + es-abstract: ^1.23.5 + es-shim-unscopables: ^1.0.2 + checksum: 5d5a7829ab2bb271a8d30a1c91e6271cef0ec534593c0fe6d2fb9ebf8bb62c1e5326e2fddcbbcbbe5872ca04f5e6b54a1ecf092e0af704fb538da9b2bfd95b40 + languageName: node + linkType: hard + +"array.prototype.flatmap@npm:^1.3.2, array.prototype.flatmap@npm:^1.3.3": + version: 1.3.3 + resolution: "array.prototype.flatmap@npm:1.3.3" + dependencies: + call-bind: ^1.0.8 + define-properties: ^1.2.1 + es-abstract: ^1.23.5 + es-shim-unscopables: ^1.0.2 + checksum: 11b4de09b1cf008be6031bb507d997ad6f1892e57dc9153583de6ebca0f74ea403fffe0f203461d359de05048d609f3f480d9b46fed4099652d8b62cc972f284 + languageName: node + linkType: hard + +"array.prototype.tosorted@npm:^1.1.4": + version: 1.1.4 + resolution: "array.prototype.tosorted@npm:1.1.4" + dependencies: + call-bind: ^1.0.7 + define-properties: ^1.2.1 + es-abstract: ^1.23.3 + es-errors: ^1.3.0 + es-shim-unscopables: ^1.0.2 + checksum: e4142d6f556bcbb4f393c02e7dbaea9af8f620c040450c2be137c9cbbd1a17f216b9c688c5f2c08fbb038ab83f55993fa6efdd9a05881d84693c7bcb5422127a + languageName: node + linkType: hard + +"arraybuffer.prototype.slice@npm:^1.0.4": + version: 1.0.4 + resolution: "arraybuffer.prototype.slice@npm:1.0.4" + dependencies: + array-buffer-byte-length: ^1.0.1 + call-bind: ^1.0.8 + define-properties: ^1.2.1 + es-abstract: ^1.23.5 + es-errors: ^1.3.0 + get-intrinsic: ^1.2.6 + is-array-buffer: ^3.0.4 + checksum: b1d1fd20be4e972a3779b1569226f6740170dca10f07aa4421d42cefeec61391e79c557cda8e771f5baefe47d878178cd4438f60916ce831813c08132bced765 languageName: node linkType: hard @@ -5915,18 +6051,6 @@ __metadata: languageName: node linkType: hard -"asn1.js@npm:^5.2.0": - version: 5.4.1 - resolution: "asn1.js@npm:5.4.1" - dependencies: - bn.js: ^4.0.0 - inherits: ^2.0.1 - minimalistic-assert: ^1.0.0 - safer-buffer: ^2.1.0 - checksum: 3786a101ac6f304bd4e9a7df79549a7561950a13d4bcaec0c7790d44c80d147c1a94ba3d4e663673406064642a40b23fcd6c82a9952468e386c1a1376d747f9a - languageName: node - linkType: hard - "asn1@npm:~0.2.3": version: 0.2.6 resolution: "asn1@npm:0.2.6" @@ -5944,19 +6068,19 @@ __metadata: linkType: hard "assert@npm:^1.1.1": - version: 1.5.0 - resolution: "assert@npm:1.5.0" + version: 1.5.1 + resolution: "assert@npm:1.5.1" dependencies: - object-assign: ^4.1.1 - util: 0.10.3 - checksum: 9be48435f726029ae7020c5888a3566bf4d617687aab280827f2e4029644b6515a9519ea10d018b342147c02faf73d9e9419e780e8937b3786ee4945a0ca71e5 + object.assign: ^4.1.4 + util: ^0.10.4 + checksum: bfc539da97545f9b2989395d6b85be40b70649ce57464f3cc6e61f4975fb097ba0689c386f95bdb4c3ab867931e40a565c9e193ae3c02263a8e92acb17c9dc93 languageName: node linkType: hard -"ast-types-flow@npm:^0.0.7": - version: 0.0.7 - resolution: "ast-types-flow@npm:0.0.7" - checksum: a26dcc2182ffee111cad7c471759b0bda22d3b7ebacf27c348b22c55f16896b18ab0a4d03b85b4020dce7f3e634b8f00b593888f622915096ea1927fa51866c4 +"ast-types-flow@npm:^0.0.8": + version: 0.0.8 + resolution: "ast-types-flow@npm:0.0.8" + checksum: 0a64706609a179233aac23817837abab614f3548c252a2d3d79ea1e10c74aa28a0846e11f466cf72771b6ed8713abc094dcf8c40c3ec4207da163efa525a94a8 languageName: node linkType: hard @@ -5976,6 +6100,20 @@ __metadata: languageName: node linkType: hard +"async-function@npm:^1.0.0": + version: 1.0.0 + resolution: "async-function@npm:1.0.0" + checksum: 9102e246d1ed9b37ac36f57f0a6ca55226876553251a31fc80677e71471f463a54c872dc78d5d7f80740c8ba624395cccbe8b60f7b690c4418f487d8e9fd1106 + languageName: node + linkType: hard + +"async-generator-function@npm:^1.0.0": + version: 1.0.0 + resolution: "async-generator-function@npm:1.0.0" + checksum: 74a71a4a2dd7afd06ebb612f6d612c7f4766a351bedffde466023bf6dae629e46b0d2cd38786239e0fbf245de0c7df76035465e16d1213774a0efb22fec0d713 + languageName: node + linkType: hard + "async-limiter@npm:~1.0.0": version: 1.0.1 resolution: "async-limiter@npm:1.0.1" @@ -5999,17 +6137,10 @@ __metadata: languageName: node linkType: hard -"async@npm:^3.2.3, async@npm:^3.2.4, async@npm:~3.2.0": - version: 3.2.4 - resolution: "async@npm:3.2.4" - checksum: 43d07459a4e1d09b84a20772414aa684ff4de085cbcaec6eea3c7a8f8150e8c62aa6cd4e699fe8ee93c3a5b324e777d34642531875a0817a35697522c1b02e89 - languageName: node - linkType: hard - -"async@npm:^3.2.5": - version: 3.2.5 - resolution: "async@npm:3.2.5" - checksum: 5ec77f1312301dee02d62140a6b1f7ee0edd2a0f983b6fd2b0849b969f245225b990b47b8243e7b9ad16451a53e7f68e753700385b706198ced888beedba3af4 +"async@npm:^3.2.3, async@npm:^3.2.4, async@npm:^3.2.5, async@npm:~3.2.0": + version: 3.2.6 + resolution: "async@npm:3.2.6" + checksum: ee6eb8cd8a0ab1b58bd2a3ed6c415e93e773573a91d31df9d5ef559baafa9dab37d3b096fa7993e84585cac3697b2af6ddb9086f45d3ac8cae821bb2aab65682 languageName: node linkType: hard @@ -6035,27 +6166,19 @@ __metadata: linkType: hard "autoprefixer@npm:^10.4.0": - version: 10.4.13 - resolution: "autoprefixer@npm:10.4.13" + version: 10.4.23 + resolution: "autoprefixer@npm:10.4.23" dependencies: - browserslist: ^4.21.4 - caniuse-lite: ^1.0.30001426 - fraction.js: ^4.2.0 - normalize-range: ^0.1.2 - picocolors: ^1.0.0 + browserslist: ^4.28.1 + caniuse-lite: ^1.0.30001760 + fraction.js: ^5.3.4 + picocolors: ^1.1.1 postcss-value-parser: ^4.2.0 peerDependencies: postcss: ^8.1.0 bin: autoprefixer: bin/autoprefixer - checksum: dcb1cb7ae96a3363d65d82e52f9a0a7d8c982256f6fd032d7e1ec311f099c23acfebfd517ff8e96bf93f716a66c4ea2b80c60aa19efd2f474ce434bd75ef7b79 - languageName: node - linkType: hard - -"available-typed-arrays@npm:^1.0.5": - version: 1.0.5 - resolution: "available-typed-arrays@npm:1.0.5" - checksum: 20eb47b3cefd7db027b9bbb993c658abd36d4edd3fe1060e83699a03ee275b0c9b216cc076ff3f2db29073225fb70e7613987af14269ac1fe2a19803ccc97f1a + checksum: a805dd6d2c2bdeef96edbdab9ee23b85c1aa168569cc31ca53c579269b7d923108ae4a469d8b2cf6d8e0b49d6c30eaff6bd9af1e4b767be9dfd15d2759e36e3d languageName: node linkType: hard @@ -6083,16 +6206,16 @@ __metadata: linkType: hard "aws4@npm:^1.8.0": - version: 1.11.0 - resolution: "aws4@npm:1.11.0" - checksum: 5a00d045fd0385926d20ebebcfba5ec79d4482fe706f63c27b324d489a04c68edb0db99ed991e19eda09cb8c97dc2452059a34d97545cebf591d7a2b5a10999f + version: 1.13.2 + resolution: "aws4@npm:1.13.2" + checksum: 9ac924e4a91c088b4928ea86b68d8c4558b0e6289ccabaae0e3e96a611bd75277c2eab6e3965821028768700516f612b929a5ce822f33a8771f74ba2a8cedb9c languageName: node linkType: hard -"axe-core@npm:^4.6.2": - version: 4.6.3 - resolution: "axe-core@npm:4.6.3" - checksum: d0c46be92b9707c48b88a53cd5f471b155a2bfc8bf6beffb514ecd14e30b4863e340b5fc4f496d82a3c562048088c1f3ff5b93b9b3b026cb9c3bfacfd535da10 +"axe-core@npm:^4.10.0": + version: 4.11.1 + resolution: "axe-core@npm:4.11.1" + checksum: 92b3c79af3695bcebac0e7f3f90f4bc11d2b39ccdc670937290e8dacbc943473713cc06b771dea0563c66d57d93d940ed89e082bfdecccf9dd70782d4bb243c0 languageName: node linkType: hard @@ -6105,27 +6228,25 @@ __metadata: languageName: node linkType: hard -"axobject-query@npm:^3.1.1": - version: 3.1.1 - resolution: "axobject-query@npm:3.1.1" - dependencies: - deep-equal: ^2.0.5 - checksum: c12a5da10dc7bab75e1cda9b6a3b5fcf10eba426ddf1a17b71ef65a434ed707ede7d1c4f013ba1609e970bc8c0cddac01365080d376204314e9b294719acd8a5 +"axobject-query@npm:^4.1.0": + version: 4.1.0 + resolution: "axobject-query@npm:4.1.0" + checksum: 7d1e87bf0aa7ae7a76cd39ab627b7c48fda3dc40181303d9adce4ba1d5b5ce73b5e5403ee6626ec8e91090448c887294d6144e24b6741a976f5be9347e3ae1df languageName: node linkType: hard "babel-loader@npm:^8.2.3": - version: 8.3.0 - resolution: "babel-loader@npm:8.3.0" + version: 8.4.1 + resolution: "babel-loader@npm:8.4.1" dependencies: find-cache-dir: ^3.3.1 - loader-utils: ^2.0.0 + loader-utils: ^2.0.4 make-dir: ^3.1.0 schema-utils: ^2.6.5 peerDependencies: "@babel/core": ^7.0.0 webpack: ">=2" - checksum: d48bcf9e030e598656ad3ff5fb85967db2eaaf38af5b4a4b99d25618a2057f9f100e6b231af2a46c1913206db506115ca7a8cbdf52c9c73d767070dae4352ab5 + checksum: fa02db1a7d3ebb7b4aab83e926fb51e627a00427943c9dd1b3302c8099c67fa6a242a2adeed37d95abcd39ba619edf558a1dec369ce0849c5a87dc290c90fe2f languageName: node linkType: hard @@ -6190,39 +6311,39 @@ __metadata: languageName: node linkType: hard -"babel-plugin-polyfill-corejs2@npm:^0.3.3": - version: 0.3.3 - resolution: "babel-plugin-polyfill-corejs2@npm:0.3.3" +"babel-plugin-polyfill-corejs2@npm:^0.4.14": + version: 0.4.14 + resolution: "babel-plugin-polyfill-corejs2@npm:0.4.14" dependencies: - "@babel/compat-data": ^7.17.7 - "@babel/helper-define-polyfill-provider": ^0.3.3 - semver: ^6.1.1 + "@babel/compat-data": ^7.27.7 + "@babel/helper-define-polyfill-provider": ^0.6.5 + semver: ^6.3.1 peerDependencies: - "@babel/core": ^7.0.0-0 - checksum: 7db3044993f3dddb3cc3d407bc82e640964a3bfe22de05d90e1f8f7a5cb71460011ab136d3c03c6c1ba428359ebf635688cd6205e28d0469bba221985f5c6179 + "@babel/core": ^7.4.0 || ^8.0.0-0 <8.0.0 + checksum: d654334c1b4390d08282416144b7b6f3d74d2cab44b2bfa2b6405c828882c82907b8b67698dce1be046c218d2d4fe5bf7fb6d01879938f3129dad969e8cfc44d languageName: node linkType: hard -"babel-plugin-polyfill-corejs3@npm:^0.6.0": - version: 0.6.0 - resolution: "babel-plugin-polyfill-corejs3@npm:0.6.0" +"babel-plugin-polyfill-corejs3@npm:^0.13.0": + version: 0.13.0 + resolution: "babel-plugin-polyfill-corejs3@npm:0.13.0" dependencies: - "@babel/helper-define-polyfill-provider": ^0.3.3 - core-js-compat: ^3.25.1 + "@babel/helper-define-polyfill-provider": ^0.6.5 + core-js-compat: ^3.43.0 peerDependencies: - "@babel/core": ^7.0.0-0 - checksum: 470bb8c59f7c0912bd77fe1b5a2e72f349b3f65bbdee1d60d6eb7e1f4a085c6f24b2dd5ab4ac6c2df6444a96b070ef6790eccc9edb6a2668c60d33133bfb62c6 + "@babel/core": ^7.4.0 || ^8.0.0-0 <8.0.0 + checksum: cf526031acd97ff2124e7c10e15047e6eeb0620d029c687f1dca99916a8fe6cac0e634b84c913db6cb68b7a024f82492ba8fdcc2a6266e7b05bdac2cba0c2434 languageName: node linkType: hard -"babel-plugin-polyfill-regenerator@npm:^0.4.1": - version: 0.4.1 - resolution: "babel-plugin-polyfill-regenerator@npm:0.4.1" +"babel-plugin-polyfill-regenerator@npm:^0.6.5": + version: 0.6.5 + resolution: "babel-plugin-polyfill-regenerator@npm:0.6.5" dependencies: - "@babel/helper-define-polyfill-provider": ^0.3.3 + "@babel/helper-define-polyfill-provider": ^0.6.5 peerDependencies: - "@babel/core": ^7.0.0-0 - checksum: ab0355efbad17d29492503230387679dfb780b63b25408990d2e4cf421012dae61d6199ddc309f4d2409ce4e9d3002d187702700dd8f4f8770ebbba651ed066c + "@babel/core": ^7.4.0 || ^8.0.0-0 <8.0.0 + checksum: ed1932fa9a31e0752fd10ebf48ab9513a654987cab1182890839523cb898559d24ae0578fdc475d9f995390420e64eeaa4b0427045b56949dace3c725bc66dbb languageName: node linkType: hard @@ -6241,24 +6362,17 @@ __metadata: linkType: hard "babel-plugin-styled-components@npm:>= 1.12.0": - version: 2.0.7 - resolution: "babel-plugin-styled-components@npm:2.0.7" + version: 2.1.4 + resolution: "babel-plugin-styled-components@npm:2.1.4" dependencies: - "@babel/helper-annotate-as-pure": ^7.16.0 - "@babel/helper-module-imports": ^7.16.0 - babel-plugin-syntax-jsx: ^6.18.0 - lodash: ^4.17.11 - picomatch: ^2.3.0 + "@babel/helper-annotate-as-pure": ^7.22.5 + "@babel/helper-module-imports": ^7.22.5 + "@babel/plugin-syntax-jsx": ^7.22.5 + lodash: ^4.17.21 + picomatch: ^2.3.1 peerDependencies: styled-components: ">= 2" - checksum: 80b06b10db02d749432a0ac43a5feedd686f6b648628d7433a39b1844260b2b7c72431f6e705c82636ee025fcfd4f6c32fc05677e44033b8a39ddcd4488b3147 - languageName: node - linkType: hard - -"babel-plugin-syntax-jsx@npm:^6.18.0": - version: 6.18.0 - resolution: "babel-plugin-syntax-jsx@npm:6.18.0" - checksum: 0c7ce5b81d6cfc01a7dd7a76a9a8f090ee02ba5c890310f51217ef1a7e6163fb7848994bbc14fd560117892e82240df9c7157ad0764da67ca5f2afafb73a7d27 + checksum: d791aed68d975dae4f73055f86cd47afa99cb402b8113acdaf5678c8b6fba2cbc15543f2debe8ed09becb198aae8be2adfe268ad41f4bca917288e073a622bf8 languageName: node linkType: hard @@ -6397,6 +6511,15 @@ __metadata: languageName: node linkType: hard +"baseline-browser-mapping@npm:^2.9.0": + version: 2.9.13 + resolution: "baseline-browser-mapping@npm:2.9.13" + bin: + baseline-browser-mapping: dist/cli.js + checksum: 657db684a65df0d86b9011352a79891091b0d28251dd5a9011f7793fadff206c01ba9cfd72e34d80bc1c53e955eff4379944afd2d926693b29ccae8d4a79b290 + languageName: node + linkType: hard + "basic-auth@npm:~2.0.1": version: 2.0.1 resolution: "basic-auth@npm:2.0.1" @@ -6439,9 +6562,18 @@ __metadata: linkType: hard "binary-extensions@npm:^2.0.0": - version: 2.2.0 - resolution: "binary-extensions@npm:2.2.0" - checksum: ccd267956c58d2315f5d3ea6757cf09863c5fc703e50fbeb13a7dc849b812ef76e3cf9ca8f35a0c48498776a7478d7b4a0418e1e2b8cb9cb9731f2922aaad7f8 + version: 2.3.0 + resolution: "binary-extensions@npm:2.3.0" + checksum: bcad01494e8a9283abf18c1b967af65ee79b0c6a9e6fcfafebfe91dbe6e0fc7272bafb73389e198b310516ae04f7ad17d79aacf6cb4c0d5d5202a7e2e52c7d98 + languageName: node + linkType: hard + +"bindings@npm:^1.4.0": + version: 1.5.0 + resolution: "bindings@npm:1.5.0" + dependencies: + file-uri-to-path: 1.0.0 + checksum: 65b6b48095717c2e6105a021a7da4ea435aa8d3d3cd085cb9e85bcb6e5773cf318c4745c3f7c504412855940b585bdf9b918236612a1c7a7942491de176f1ae7 languageName: node linkType: hard @@ -6471,36 +6603,36 @@ __metadata: linkType: hard "bn.js@npm:^4.0.0, bn.js@npm:^4.1.0, bn.js@npm:^4.11.9": - version: 4.12.0 - resolution: "bn.js@npm:4.12.0" - checksum: 39afb4f15f4ea537b55eaf1446c896af28ac948fdcf47171961475724d1bb65118cca49fa6e3d67706e4790955ec0e74de584e45c8f1ef89f46c812bee5b5a12 + version: 4.12.2 + resolution: "bn.js@npm:4.12.2" + checksum: dd224afda6f5a7d15f2fe5154e1a1c245576a725584ea1852c8c42f9748dfe847bc63a48b2885360023389a24cfebb3653ca97f4c69742f3c22bc63da6565030 languageName: node linkType: hard -"bn.js@npm:^5.0.0, bn.js@npm:^5.2.1": - version: 5.2.1 - resolution: "bn.js@npm:5.2.1" - checksum: 3dd8c8d38055fedfa95c1d5fc3c99f8dd547b36287b37768db0abab3c239711f88ff58d18d155dd8ad902b0b0cee973747b7ae20ea12a09473272b0201c9edd3 +"bn.js@npm:^5.2.1, bn.js@npm:^5.2.2": + version: 5.2.2 + resolution: "bn.js@npm:5.2.2" + checksum: 4384d35fef785c757eb050bc1f13d60dd8e37662ca72392ae6678b35cfa2a2ae8f0494291086294683a7d977609c7878ac3cff08ecca7f74c3ca73f3acbadbe8 languageName: node linkType: hard -"body-parser@npm:1.20.3": - version: 1.20.3 - resolution: "body-parser@npm:1.20.3" +"body-parser@npm:~1.20.3": + version: 1.20.4 + resolution: "body-parser@npm:1.20.4" dependencies: - bytes: 3.1.2 + bytes: ~3.1.2 content-type: ~1.0.5 debug: 2.6.9 depd: 2.0.0 - destroy: 1.2.0 - http-errors: 2.0.0 - iconv-lite: 0.4.24 - on-finished: 2.4.1 - qs: 6.13.0 - raw-body: 2.5.2 + destroy: ~1.2.0 + http-errors: ~2.0.1 + iconv-lite: ~0.4.24 + on-finished: ~2.4.1 + qs: ~6.14.0 + raw-body: ~2.5.3 type-is: ~1.6.18 - unpipe: 1.0.0 - checksum: 1a35c59a6be8d852b00946330141c4f142c6af0f970faa87f10ad74f1ee7118078056706a05ae3093c54dabca9cd3770fa62a170a85801da1a4324f04381167d + unpipe: ~1.0.0 + checksum: eaa212cff1737d2fbb49fc7aa1d71d9b456adea2dc3de388ff3c6d67b28028d6b1fa7e6cd77e3670b4cbd402ab011f80f6e5bb811480b53a28d11f33678c6298 languageName: node linkType: hard @@ -6523,6 +6655,22 @@ __metadata: languageName: node linkType: hard +"boxen@npm:5.1.2, boxen@npm:^5.0.0, boxen@npm:^5.1.2": + version: 5.1.2 + resolution: "boxen@npm:5.1.2" + dependencies: + ansi-align: ^3.0.0 + camelcase: ^6.2.0 + chalk: ^4.1.0 + cli-boxes: ^2.2.1 + string-width: ^4.2.2 + type-fest: ^0.20.2 + widest-line: ^3.1.0 + wrap-ansi: ^7.0.0 + checksum: 82d03e42a72576ff235123f17b7c505372fe05c83f75f61e7d4fa4bcb393897ec95ce766fecb8f26b915f0f7a7227d66e5ec7cef43f5b2bd9d3aeed47ec55877 + languageName: node + linkType: hard + "boxen@npm:^4.2.0": version: 4.2.0 resolution: "boxen@npm:4.2.0" @@ -6539,22 +6687,6 @@ __metadata: languageName: node linkType: hard -"boxen@npm:^5.0.0, boxen@npm:^5.1.2": - version: 5.1.2 - resolution: "boxen@npm:5.1.2" - dependencies: - ansi-align: ^3.0.0 - camelcase: ^6.2.0 - chalk: ^4.1.0 - cli-boxes: ^2.2.1 - string-width: ^4.2.2 - type-fest: ^0.20.2 - widest-line: ^3.1.0 - wrap-ansi: ^7.0.0 - checksum: 82d03e42a72576ff235123f17b7c505372fe05c83f75f61e7d4fa4bcb393897ec95ce766fecb8f26b915f0f7a7227d66e5ec7cef43f5b2bd9d3aeed47ec55877 - languageName: node - linkType: hard - "brace-expansion@npm:^1.1.7": version: 1.1.12 resolution: "brace-expansion@npm:1.1.12" @@ -6566,11 +6698,11 @@ __metadata: linkType: hard "brace-expansion@npm:^2.0.1": - version: 2.0.1 - resolution: "brace-expansion@npm:2.0.1" + version: 2.0.2 + resolution: "brace-expansion@npm:2.0.2" dependencies: balanced-match: ^1.0.0 - checksum: a61e7cd2e8a8505e9f0036b3b6108ba5e926b4b55089eeb5550cd04a471fe216c96d4fe7e4c7f995c728c554ae20ddfc4244cad10aef255e72b62930afd233d1 + checksum: 01dff195e3646bc4b0d27b63d9bab84d2ebc06121ff5013ad6e5356daa5a9d6b60fa26cf73c74797f2dc3fbec112af13578d51f75228c1112b26c790a87b0488 languageName: node linkType: hard @@ -6597,7 +6729,7 @@ __metadata: languageName: node linkType: hard -"browserify-aes@npm:^1.0.0, browserify-aes@npm:^1.0.4, browserify-aes@npm:^1.2.0": +"browserify-aes@npm:^1.0.4, browserify-aes@npm:^1.2.0": version: 1.2.0 resolution: "browserify-aes@npm:1.2.0" dependencies: @@ -6611,7 +6743,7 @@ __metadata: languageName: node linkType: hard -"browserify-cipher@npm:^1.0.0": +"browserify-cipher@npm:^1.0.1": version: 1.0.1 resolution: "browserify-cipher@npm:1.0.1" dependencies: @@ -6634,31 +6766,31 @@ __metadata: languageName: node linkType: hard -"browserify-rsa@npm:^4.0.0, browserify-rsa@npm:^4.1.0": - version: 4.1.0 - resolution: "browserify-rsa@npm:4.1.0" +"browserify-rsa@npm:^4.0.0, browserify-rsa@npm:^4.1.1": + version: 4.1.1 + resolution: "browserify-rsa@npm:4.1.1" dependencies: - bn.js: ^5.0.0 - randombytes: ^2.0.1 - checksum: 155f0c135873efc85620571a33d884aa8810e40176125ad424ec9d85016ff105a07f6231650914a760cca66f29af0494087947b7be34880dd4599a0cd3c38e54 + bn.js: ^5.2.1 + randombytes: ^2.1.0 + safe-buffer: ^5.2.1 + checksum: 2628508646331791c29312bbf274c076a237437a17178ea9bdc75c577fb4164a0da0b137deaadf6ade623701332377c5c2ceb0ff6f991c744a576e790ec95852 languageName: node linkType: hard -"browserify-sign@npm:^4.0.0": - version: 4.2.3 - resolution: "browserify-sign@npm:4.2.3" +"browserify-sign@npm:^4.2.3": + version: 4.2.5 + resolution: "browserify-sign@npm:4.2.5" dependencies: - bn.js: ^5.2.1 - browserify-rsa: ^4.1.0 + bn.js: ^5.2.2 + browserify-rsa: ^4.1.1 create-hash: ^1.2.0 create-hmac: ^1.1.7 - elliptic: ^6.5.5 - hash-base: ~3.0 + elliptic: ^6.6.1 inherits: ^2.0.4 - parse-asn1: ^5.1.7 + parse-asn1: ^5.1.9 readable-stream: ^2.3.8 safe-buffer: ^5.2.1 - checksum: 403a8061d229ae31266670345b4a7c00051266761d2c9bbeb68b1a9bcb05f68143b16110cf23a171a5d6716396a1f41296282b3e73eeec0a1871c77f0ff4ee6b + checksum: 1cea126a0539f4f26d2b55290fbe49934e72129ce8120b20b1f9c75ce070db0a69d8fe3a46927db3dcb73391967b1bf546b89f2835defe05a18b2da41afa14b1 languageName: node linkType: hard @@ -6671,31 +6803,18 @@ __metadata: languageName: node linkType: hard -"browserslist@npm:^4.0.0, browserslist@npm:^4.16.3, browserslist@npm:^4.16.6, browserslist@npm:^4.17.5, browserslist@npm:^4.18.1, browserslist@npm:^4.21.3, browserslist@npm:^4.21.4, browserslist@npm:^4.6.6": - version: 4.21.4 - resolution: "browserslist@npm:4.21.4" - dependencies: - caniuse-lite: ^1.0.30001400 - electron-to-chromium: ^1.4.251 - node-releases: ^2.0.6 - update-browserslist-db: ^1.0.9 - bin: - browserslist: cli.js - checksum: 4af3793704dbb4615bcd29059ab472344dc7961c8680aa6c4bb84f05340e14038d06a5aead58724eae69455b8fade8b8c69f1638016e87e5578969d74c078b79 - languageName: node - linkType: hard - -"browserslist@npm:^4.21.10": - version: 4.23.2 - resolution: "browserslist@npm:4.23.2" +"browserslist@npm:^4.0.0, browserslist@npm:^4.16.3, browserslist@npm:^4.17.5, browserslist@npm:^4.18.1, browserslist@npm:^4.21.4, browserslist@npm:^4.24.0, browserslist@npm:^4.28.0, browserslist@npm:^4.28.1, browserslist@npm:^4.6.6": + version: 4.28.1 + resolution: "browserslist@npm:4.28.1" dependencies: - caniuse-lite: ^1.0.30001640 - electron-to-chromium: ^1.4.820 - node-releases: ^2.0.14 - update-browserslist-db: ^1.1.0 + baseline-browser-mapping: ^2.9.0 + caniuse-lite: ^1.0.30001759 + electron-to-chromium: ^1.5.263 + node-releases: ^2.0.27 + update-browserslist-db: ^1.2.0 bin: browserslist: cli.js - checksum: 8212af37f6ca6355da191cf2d4ad49bd0b82854888b9a7e103638fada70d38cbe36d28feeeaa98344cb15d9128f9f74bcc8ce1bfc9011b5fd14381c1c6fb542c + checksum: 895357d912ae5a88a3fa454d2d280e9869e13432df30ca8918e206c0783b3b59375b178fdaf16d0041a1cf21ac45c8eb0a20f96f73dbd9662abf4cf613177a1e languageName: node linkType: hard @@ -6750,6 +6869,16 @@ __metadata: languageName: node linkType: hard +"buffer@npm:^6.0.3": + version: 6.0.3 + resolution: "buffer@npm:6.0.3" + dependencies: + base64-js: ^1.3.1 + ieee754: ^1.2.1 + checksum: 5ad23293d9a731e4318e420025800b42bf0d264004c0286c8cc010af7a270c7a0f6522e84f54b9ad65cbd6db20b8badbfd8d2ebf4f80fa03dab093b89e68c3f9 + languageName: node + linkType: hard + "builtin-status-codes@npm:^3.0.0": version: 3.0.0 resolution: "builtin-status-codes@npm:3.0.0" @@ -6773,43 +6902,29 @@ __metadata: languageName: node linkType: hard -"bytes@npm:3.0.0": - version: 3.0.0 - resolution: "bytes@npm:3.0.0" - checksum: a2b386dd8188849a5325f58eef69c3b73c51801c08ffc6963eddc9be244089ba32d19347caf6d145c86f315ae1b1fc7061a32b0c1aa6379e6a719090287ed101 - languageName: node - linkType: hard - -"bytes@npm:3.1.2": +"bytes@npm:3.1.2, bytes@npm:~3.1.2": version: 3.1.2 resolution: "bytes@npm:3.1.2" checksum: e4bcd3948d289c5127591fbedf10c0b639ccbf00243504e4e127374a15c3bc8eed0d28d4aaab08ff6f1cf2abc0cce6ba3085ed32f4f90e82a5683ce0014e1b6e languageName: node linkType: hard -"cacache@npm:^16.1.0": - version: 16.1.3 - resolution: "cacache@npm:16.1.3" +"cacache@npm:^20.0.1": + version: 20.0.3 + resolution: "cacache@npm:20.0.3" dependencies: - "@npmcli/fs": ^2.1.0 - "@npmcli/move-file": ^2.0.0 - chownr: ^2.0.0 - fs-minipass: ^2.1.0 - glob: ^8.0.1 - infer-owner: ^1.0.4 - lru-cache: ^7.7.1 - minipass: ^3.1.6 - minipass-collect: ^1.0.2 + "@npmcli/fs": ^5.0.0 + fs-minipass: ^3.0.0 + glob: ^13.0.0 + lru-cache: ^11.1.0 + minipass: ^7.0.3 + minipass-collect: ^2.0.1 minipass-flush: ^1.0.5 minipass-pipeline: ^1.2.4 - mkdirp: ^1.0.4 - p-map: ^4.0.0 - promise-inflight: ^1.0.1 - rimraf: ^3.0.2 - ssri: ^9.0.0 - tar: ^6.1.11 - unique-filename: ^2.0.0 - checksum: d91409e6e57d7d9a3a25e5dcc589c84e75b178ae8ea7de05cbf6b783f77a5fae938f6e8fda6f5257ed70000be27a681e1e44829251bfffe4c10216002f8f14e6 + p-map: ^7.0.2 + ssri: ^13.0.0 + unique-filename: ^5.0.0 + checksum: 595e6b91d72972d596e1e9ccab8ddbf08b773f27240220b1b5b1b7b3f52173cfbcf095212e5d7acd86c3bd453c28e69b116469889c511615ef3589523d542639 languageName: node linkType: hard @@ -6847,8 +6962,8 @@ __metadata: linkType: hard "cacheable-request@npm:^7.0.2": - version: 7.0.2 - resolution: "cacheable-request@npm:7.0.2" + version: 7.0.4 + resolution: "cacheable-request@npm:7.0.4" dependencies: clone-response: ^1.0.2 get-stream: ^5.1.0 @@ -6857,7 +6972,7 @@ __metadata: lowercase-keys: ^2.0.0 normalize-url: ^6.0.1 responselike: ^2.0.0 - checksum: 6152813982945a5c9989cb457a6c499f12edcc7ade323d2fbfd759abc860bdbd1306e08096916bb413c3c47e812f8e4c0a0cc1e112c8ce94381a960f115bc77f + checksum: 0de9df773fd4e7dd9bd118959878f8f2163867e2e1ab3575ffbecbe6e75e80513dd0c68ba30005e5e5a7b377cc6162bbc00ab1db019bb4e9cb3c2f3f7a6f1ee4 languageName: node linkType: hard @@ -6871,30 +6986,7 @@ __metadata: languageName: node linkType: hard -"call-bind@npm:^1.0.0, call-bind@npm:^1.0.2": - version: 1.0.2 - resolution: "call-bind@npm:1.0.2" - dependencies: - function-bind: ^1.1.1 - get-intrinsic: ^1.0.2 - checksum: f8e31de9d19988a4b80f3e704788c4a2d6b6f3d17cfec4f57dc29ced450c53a49270dc66bf0fbd693329ee948dd33e6c90a329519aef17474a4d961e8d6426b0 - languageName: node - linkType: hard - -"call-bind@npm:^1.0.7": - version: 1.0.7 - resolution: "call-bind@npm:1.0.7" - dependencies: - es-define-property: ^1.0.0 - es-errors: ^1.3.0 - function-bind: ^1.1.2 - get-intrinsic: ^1.2.4 - set-function-length: ^1.2.1 - checksum: 295c0c62b90dd6522e6db3b0ab1ce26bdf9e7404215bda13cfee25b626b5ff1a7761324d58d38b1ef1607fc65aca2d06e44d2e18d0dfc6c14b465b00d8660029 - languageName: node - linkType: hard - -"call-bind@npm:^1.0.8": +"call-bind@npm:^1.0.2, call-bind@npm:^1.0.5, call-bind@npm:^1.0.7, call-bind@npm:^1.0.8": version: 1.0.8 resolution: "call-bind@npm:1.0.8" dependencies: @@ -6906,7 +6998,7 @@ __metadata: languageName: node linkType: hard -"call-bound@npm:^1.0.3, call-bound@npm:^1.0.4": +"call-bound@npm:^1.0.2, call-bound@npm:^1.0.3, call-bound@npm:^1.0.4": version: 1.0.4 resolution: "call-bound@npm:1.0.4" dependencies: @@ -6990,10 +7082,10 @@ __metadata: languageName: node linkType: hard -"caniuse-lite@npm:^1.0.0, caniuse-lite@npm:^1.0.30001400, caniuse-lite@npm:^1.0.30001426, caniuse-lite@npm:^1.0.30001640": - version: 1.0.30001643 - resolution: "caniuse-lite@npm:1.0.30001643" - checksum: e39991c13a0fd8f5c2aa99c9128188e4c4e9d6a203c3da6270c36285460ef152c5e9410ee4db560aa723904668946afe50541dce9636ab5e61434ba71dc22955 +"caniuse-lite@npm:^1.0.0, caniuse-lite@npm:^1.0.30001759, caniuse-lite@npm:^1.0.30001760": + version: 1.0.30001763 + resolution: "caniuse-lite@npm:1.0.30001763" + checksum: ea6b1492b30ffe532c47cae011f27ab043293f1d67d54355df579a7eae35f4bdb3752cc7caa9db6e0a42e08b07aa694f88e2b39cd4baf7b5590eb67aa7d16346 languageName: node linkType: hard @@ -7022,6 +7114,15 @@ __metadata: languageName: node linkType: hard +"centra@npm:^2.7.0": + version: 2.7.0 + resolution: "centra@npm:2.7.0" + dependencies: + follow-redirects: ^1.15.6 + checksum: 59ec76d9ba7086b76e9594129b9843856fe7293400b89cb8b133f444a62ca5d4c536df0d4722374b0c16d86dd4e0baba1fc9722640b7d3b532865bebdec2b1a2 + languageName: node + linkType: hard + "chalk@npm:^1.1.1": version: 1.1.3 resolution: "chalk@npm:1.1.3" @@ -7035,7 +7136,7 @@ __metadata: languageName: node linkType: hard -"chalk@npm:^2.0.0, chalk@npm:^2.4.2": +"chalk@npm:^2.4.2": version: 2.4.2 resolution: "chalk@npm:2.4.2" dependencies: @@ -7067,9 +7168,9 @@ __metadata: linkType: hard "chalk@npm:^5.0.0": - version: 5.3.0 - resolution: "chalk@npm:5.3.0" - checksum: 623922e077b7d1e9dedaea6f8b9e9352921f8ae3afe739132e0e00c275971bdd331268183b2628cf4ab1727c45ea1f28d7e24ac23ce1db1eb653c414ca8a5a80 + version: 5.6.2 + resolution: "chalk@npm:5.6.2" + checksum: 4ee2d47a626d79ca27cb5299ecdcce840ef5755e287412536522344db0fc51ca0f6d6433202332c29e2288c6a90a2b31f3bd626bc8c14743b6b6ee28abd3b796 languageName: node linkType: hard @@ -7091,6 +7192,24 @@ __metadata: languageName: node linkType: hard +"change-case-all@npm:1.0.15": + version: 1.0.15 + resolution: "change-case-all@npm:1.0.15" + dependencies: + change-case: ^4.1.2 + is-lower-case: ^2.0.2 + is-upper-case: ^2.0.2 + lower-case: ^2.0.2 + lower-case-first: ^2.0.2 + sponge-case: ^1.0.1 + swap-case: ^2.0.2 + title-case: ^3.0.3 + upper-case: ^2.0.2 + upper-case-first: ^2.0.2 + checksum: e1dabdcd8447a3690f3faf15f92979dfbc113109b50916976e1d5e518e6cfdebee4f05f54d0ca24fb79a4bf835185b59ae25e967bb3dc10bd236a775b19ecc52 + languageName: node + linkType: hard + "change-case@npm:^3.1.0": version: 3.1.0 resolution: "change-case@npm:3.1.0" @@ -7193,7 +7312,7 @@ __metadata: languageName: node linkType: hard -"cheerio@npm:1.0.0-rc.12, cheerio@npm:^1.0.0-rc.10, cheerio@npm:^1.0.0-rc.12": +"cheerio@npm:1.0.0-rc.12": version: 1.0.0-rc.12 resolution: "cheerio@npm:1.0.0-rc.12" dependencies: @@ -7232,9 +7351,28 @@ __metadata: languageName: node linkType: hard -"chokidar@npm:>=3.0.0 <4.0.0, chokidar@npm:^3.0.0, chokidar@npm:^3.4.2, chokidar@npm:^3.5.1, chokidar@npm:^3.5.3": - version: 3.5.3 - resolution: "chokidar@npm:3.5.3" +"cheerio@npm:^1.0.0-rc.10, cheerio@npm:^1.0.0-rc.12": + version: 1.1.2 + resolution: "cheerio@npm:1.1.2" + dependencies: + cheerio-select: ^2.1.0 + dom-serializer: ^2.0.0 + domhandler: ^5.0.3 + domutils: ^3.2.2 + encoding-sniffer: ^0.2.1 + htmlparser2: ^10.0.0 + parse5: ^7.3.0 + parse5-htmlparser2-tree-adapter: ^7.1.0 + parse5-parser-stream: ^7.1.2 + undici: ^7.12.0 + whatwg-mimetype: ^4.0.0 + checksum: 84fec985143d81323d39f13bbe1b65ff4f934bfbfcfe586ab7674f4a54b13b3e9c6aa9b23e4a54e7147e08fafaed12f5f9bad554bb707579b3db464eeccc158f + languageName: node + linkType: hard + +"chokidar@npm:^3.0.0, chokidar@npm:^3.4.2, chokidar@npm:^3.5.1, chokidar@npm:^3.5.3": + version: 3.6.0 + resolution: "chokidar@npm:3.6.0" dependencies: anymatch: ~3.1.2 braces: ~3.0.2 @@ -7247,7 +7385,16 @@ __metadata: dependenciesMeta: fsevents: optional: true - checksum: b49fcde40176ba007ff361b198a2d35df60d9bb2a5aab228279eb810feae9294a6b4649ab15981304447afe1e6ffbf4788ad5db77235dc770ab777c6e771980c + checksum: d2f29f499705dcd4f6f3bbed79a9ce2388cf530460122eed3b9c48efeab7a4e28739c6551fd15bec9245c6b9eeca7a32baa64694d64d9b6faeb74ddb8c4a413d + languageName: node + linkType: hard + +"chokidar@npm:^4.0.0": + version: 4.0.3 + resolution: "chokidar@npm:4.0.3" + dependencies: + readdirp: ^4.0.1 + checksum: a8765e452bbafd04f3f2fad79f04222dd65f43161488bb6014a41099e6ca18d166af613d59a90771908c1c823efa3f46ba36b86ac50b701c20c1b9908c5fe36e languageName: node linkType: hard @@ -7258,17 +7405,17 @@ __metadata: languageName: node linkType: hard -"chownr@npm:^2.0.0": - version: 2.0.0 - resolution: "chownr@npm:2.0.0" - checksum: c57cf9dd0791e2f18a5ee9c1a299ae6e801ff58fee96dc8bfd0dcb4738a6ce58dd252a3605b1c93c6418fe4f9d5093b28ffbf4d66648cb2a9c67eaef9679be2f +"chownr@npm:^3.0.0": + version: 3.0.0 + resolution: "chownr@npm:3.0.0" + checksum: fd73a4bab48b79e66903fe1cafbdc208956f41ea4f856df883d0c7277b7ab29fd33ee65f93b2ec9192fc0169238f2f8307b7735d27c155821d886b84aa97aa8d languageName: node linkType: hard "chrome-trace-event@npm:^1.0.2": - version: 1.0.3 - resolution: "chrome-trace-event@npm:1.0.3" - checksum: cb8b1fc7e881aaef973bd0c4a43cd353c2ad8323fb471a041e64f7c2dd849cde4aad15f8b753331a32dda45c973f032c8a03b8177fc85d60eaa75e91e08bfb97 + version: 1.0.4 + resolution: "chrome-trace-event@npm:1.0.4" + checksum: fcbbd9dd0cd5b48444319007cc0c15870fd8612cc0df320908aa9d5e8a244084d48571eb28bf3c58c19327d2c5838f354c2d89fac3956d8e992273437401ac19 languageName: node linkType: hard @@ -7280,26 +7427,27 @@ __metadata: linkType: hard "ci-info@npm:^4.0.0": - version: 4.0.0 - resolution: "ci-info@npm:4.0.0" - checksum: 122fe41c5eb8d0b5fa0ab6fd674c5ddcf2dc59766528b062a0144ff0d913cfb210ef925ec52110e7c2a7f4e603d5f0e8b91cfe68867e196e9212fa0b94d0a08a + version: 4.3.1 + resolution: "ci-info@npm:4.3.1" + checksum: 66c159d92648e8a07acab0a3a0681bff6ccc39aa44916263208c4d97bbbeedbbc886d7611fd30c21df1aa624ce3c6fcdfde982e74689e3e014e064e1d0805f94 languageName: node linkType: hard "cipher-base@npm:^1.0.0, cipher-base@npm:^1.0.1, cipher-base@npm:^1.0.3": - version: 1.0.4 - resolution: "cipher-base@npm:1.0.4" + version: 1.0.7 + resolution: "cipher-base@npm:1.0.7" dependencies: - inherits: ^2.0.1 - safe-buffer: ^5.0.1 - checksum: 47d3568dbc17431a339bad1fe7dff83ac0891be8206911ace3d3b818fc695f376df809bea406e759cdea07fff4b454fa25f1013e648851bec790c1d75763032e + inherits: ^2.0.4 + safe-buffer: ^5.2.1 + to-buffer: ^1.2.2 + checksum: 3c3b5ddd8c8bfbb68fdd134c4c6db408b57a81f19260c59a5e1f5b75cb67fc5a0127af2ffb84a14720c9d249226659544c593245123f42285c82267cf787b883 languageName: node linkType: hard "classnames@npm:^2.3.1, classnames@npm:^2.3.2": - version: 2.3.2 - resolution: "classnames@npm:2.3.2" - checksum: 2c62199789618d95545c872787137262e741f9db13328e216b093eea91c85ef2bfb152c1f9e63027204e2559a006a92eb74147d46c800a9f96297ae1d9f96f4e + version: 2.5.1 + resolution: "classnames@npm:2.5.1" + checksum: da424a8a6f3a96a2e87d01a432ba19315503294ac7e025f9fece656db6b6a0f7b5003bb1fbb51cbb0d9624d964f1b9bb35a51c73af9b2434c7b292c42231c1e5 languageName: node linkType: hard @@ -7312,13 +7460,6 @@ __metadata: languageName: node linkType: hard -"clean-stack@npm:^2.0.0": - version: 2.2.0 - resolution: "clean-stack@npm:2.2.0" - checksum: 2ac8cd2b2f5ec986a3c743935ec85b07bc174d5421a5efc8017e1f146a1cf5f781ae962618f416352103b32c9cd7e203276e8c28241bbe946160cab16149fb68 - languageName: node - linkType: hard - "cli-boxes@npm:^2.2.0, cli-boxes@npm:^2.2.1": version: 2.2.1 resolution: "cli-boxes@npm:2.2.1" @@ -7475,15 +7616,6 @@ __metadata: languageName: node linkType: hard -"color-support@npm:^1.1.3": - version: 1.1.3 - resolution: "color-support@npm:1.1.3" - bin: - color-support: bin.js - checksum: 9b7356817670b9a13a26ca5af1c21615463b500783b739b7634a0c2047c16cef4b2865d7576875c31c3cddf9dd621fa19285e628f20198b233a5cfdda6d0793b - languageName: node - linkType: hard - "color@npm:^4.2.3": version: 4.2.3 resolution: "color@npm:4.2.3" @@ -7570,7 +7702,7 @@ __metadata: version: 0.0.0-use.local resolution: "commerce-webapi@workspace:." dependencies: - "@adobe/gatsby-theme-aio": 4.15.3 + "@adobe/gatsby-theme-aio": 4.15.5 gatsby: 4.22.0 react: ^17.0.2 react-dom: ^17.0.2 @@ -7578,18 +7710,11 @@ __metadata: remark-frontmatter: ^5.0.0 remark-heading-id: ^1.0.1 remark-lint-frontmatter-schema: ^3.15.4 - remark-validate-links: ^13.0.1 - spectaql: ^3.0.2 + remark-validate-links: 13.0.1 + spectaql: ^3.0.6 languageName: unknown linkType: soft -"common-path-prefix@npm:^3.0.0": - version: 3.0.0 - resolution: "common-path-prefix@npm:3.0.0" - checksum: fdb3c4f54e51e70d417ccd950c07f757582de800c0678ca388aedefefc84982039f346f9fd9a1252d08d2da9e9ef4019f580a1d1d3a10da031e4bb3c924c5818 - languageName: node - linkType: hard - "common-tags@npm:1.8.2, common-tags@npm:^1.8.0, common-tags@npm:^1.8.2": version: 1.8.2 resolution: "common-tags@npm:1.8.2" @@ -7605,13 +7730,13 @@ __metadata: linkType: hard "component-emitter@npm:~1.3.0": - version: 1.3.0 - resolution: "component-emitter@npm:1.3.0" - checksum: b3c46de38ffd35c57d1c02488355be9f218e582aec72d72d1b8bbec95a3ac1b38c96cd6e03ff015577e68f550fbb361a3bfdbd9bb248be9390b7b3745691be6b + version: 1.3.1 + resolution: "component-emitter@npm:1.3.1" + checksum: 94550aa462c7bd5a61c1bc480e28554aa306066930152d1b1844a0dd3845d4e5db7e261ddec62ae184913b3e59b55a2ad84093b9d3596a8f17c341514d6c483d languageName: node linkType: hard -"compressible@npm:~2.0.16": +"compressible@npm:~2.0.18": version: 2.0.18 resolution: "compressible@npm:2.0.18" dependencies: @@ -7621,17 +7746,17 @@ __metadata: linkType: hard "compression@npm:^1.7.4": - version: 1.7.4 - resolution: "compression@npm:1.7.4" + version: 1.8.1 + resolution: "compression@npm:1.8.1" dependencies: - accepts: ~1.3.5 - bytes: 3.0.0 - compressible: ~2.0.16 + bytes: 3.1.2 + compressible: ~2.0.18 debug: 2.6.9 - on-headers: ~1.0.2 - safe-buffer: 5.1.2 + negotiator: ~0.6.4 + on-headers: ~1.1.0 + safe-buffer: 5.2.1 vary: ~1.1.2 - checksum: 35c0f2eb1f28418978615dc1bc02075b34b1568f7f56c62d60f4214d4b7cc00d0f6d282b5f8a954f59872396bd770b6b15ffd8aa94c67d4bce9b8887b906999b + checksum: 906325935180cd3507d30ed898fb129deccab03689383d55536245a94610f5003923bb14c95ee6adc8d658ee13be549407eb4346ef55169045f3e41e9969808e languageName: node linkType: hard @@ -7716,6 +7841,13 @@ __metadata: languageName: node linkType: hard +"consola@npm:^3.2.3": + version: 3.4.2 + resolution: "consola@npm:3.4.2" + checksum: 32d1339e0505842f033ca34cb4572a841281caa367f438b785d3b284ab2a06134f009e605908480402c5f57f56c1e3210090c37e6417923416f76ce730d39361 + languageName: node + linkType: hard + "console-browserify@npm:^1.1.0": version: 1.2.0 resolution: "console-browserify@npm:1.2.0" @@ -7723,13 +7855,6 @@ __metadata: languageName: node linkType: hard -"console-control-strings@npm:^1.1.0": - version: 1.1.0 - resolution: "console-control-strings@npm:1.1.0" - checksum: 8755d76787f94e6cf79ce4666f0c5519906d7f5b02d4b884cf41e11dcd759ed69c57da0670afd9236d229a46e0f9cf519db0cd829c6dca820bb5a5c3def584ed - languageName: node - linkType: hard - "constant-case@npm:^2.0.0": version: 2.0.0 resolution: "constant-case@npm:2.0.0" @@ -7758,7 +7883,7 @@ __metadata: languageName: node linkType: hard -"content-disposition@npm:0.5.4": +"content-disposition@npm:~0.5.4": version: 0.5.4 resolution: "content-disposition@npm:0.5.4" dependencies: @@ -7767,14 +7892,7 @@ __metadata: languageName: node linkType: hard -"content-type@npm:^1.0.4, content-type@npm:~1.0.4": - version: 1.0.4 - resolution: "content-type@npm:1.0.4" - checksum: 3d93585fda985d1554eca5ebd251994327608d2e200978fdbfba21c0c679914d5faf266d17027de44b34a72c7b0745b18584ecccaa7e1fdfb6a68ac7114f12e0 - languageName: node - linkType: hard - -"content-type@npm:~1.0.5": +"content-type@npm:^1.0.4, content-type@npm:~1.0.4, content-type@npm:~1.0.5": version: 1.0.5 resolution: "content-type@npm:1.0.5" checksum: 566271e0a251642254cde0f845f9dd4f9856e52d988f4eb0d0dcffbb7a1f8ec98de7a5215fc628f3bce30fe2fb6fd2bc064b562d721658c59b544e2d34ea2766 @@ -7802,17 +7920,17 @@ __metadata: languageName: node linkType: hard -"cookie-signature@npm:1.0.6": - version: 1.0.6 - resolution: "cookie-signature@npm:1.0.6" - checksum: f4e1b0a98a27a0e6e66fd7ea4e4e9d8e038f624058371bf4499cfcd8f3980be9a121486995202ba3fca74fbed93a407d6d54d43a43f96fd28d0bd7a06761591a +"convert-source-map@npm:^2.0.0": + version: 2.0.0 + resolution: "convert-source-map@npm:2.0.0" + checksum: 63ae9933be5a2b8d4509daca5124e20c14d023c820258e484e32dc324d34c2754e71297c94a05784064ad27615037ef677e3f0c00469fb55f409d2bb21261035 languageName: node linkType: hard -"cookie@npm:0.6.0": - version: 0.6.0 - resolution: "cookie@npm:0.6.0" - checksum: f56a7d32a07db5458e79c726b77e3c2eff655c36792f2b6c58d351fb5f61531e5b1ab7f46987150136e366c65213cbe31729e02a3eaed630c3bf7334635fb410 +"cookie-signature@npm:~1.0.6": + version: 1.0.7 + resolution: "cookie-signature@npm:1.0.7" + checksum: 1a62808cd30d15fb43b70e19829b64d04b0802d8ef00275b57d152de4ae6a3208ca05c197b6668d104c4d9de389e53ccc2d3bc6bcaaffd9602461417d8c40710 languageName: node linkType: hard @@ -7823,6 +7941,13 @@ __metadata: languageName: node linkType: hard +"cookie@npm:~0.7.1": + version: 0.7.2 + resolution: "cookie@npm:0.7.2" + checksum: 9bf8555e33530affd571ea37b615ccad9b9a34febbf2c950c86787088eb00a8973690833b0f8ebd6b69b753c62669ea60cec89178c1fb007bf0749abed74f93e + languageName: node + linkType: hard + "core-js-compat@npm:3.9.0": version: 3.9.0 resolution: "core-js-compat@npm:3.9.0" @@ -7833,26 +7958,26 @@ __metadata: languageName: node linkType: hard -"core-js-compat@npm:^3.25.1": - version: 3.26.0 - resolution: "core-js-compat@npm:3.26.0" +"core-js-compat@npm:^3.43.0": + version: 3.47.0 + resolution: "core-js-compat@npm:3.47.0" dependencies: - browserslist: ^4.21.4 - checksum: 120780ec33d441e476810abac9bf57199c2083006b179dc23d0ab0cfea096eff2a2fc3e9cb315d245735df661cfa4b76a8b8c37f5056fd02428a3cd2ea1d9f36 + browserslist: ^4.28.0 + checksum: 425c8cb4c3277a11f3d7d4752c53e5903892635126ed1cdc326a1cd7d961606c5d2c951493f1c783e624f9cdc1ec791c6db68dc19988d68f112d7d82a4c39c9a languageName: node linkType: hard "core-js-pure@npm:^3.23.3": - version: 3.26.0 - resolution: "core-js-pure@npm:3.26.0" - checksum: bbf5fa65cf3368a25f9d9cc525863acc8082fa3797efc8dc514f85d7f4aa870f4999b68863f3c7b96ed0b062add261a448758e6d337626c2535ad89ee8481a92 + version: 3.47.0 + resolution: "core-js-pure@npm:3.47.0" + checksum: e3d604ef8f8aaafcd9b8fbc1ac313ea2be21439b84ca8ebebdd7b2a66fddb93e3c52003e5a288514d8735cb9ad1a019b5d046fbcc55cac97c17ba4691fa26f22 languageName: node linkType: hard "core-js@npm:^3.22.3, core-js@npm:^3.25.1": - version: 3.26.0 - resolution: "core-js@npm:3.26.0" - checksum: 0149eb9d3909fde9c17626af3a6e625c326e8598d0bb5e6c5b48a18e5fcd4eaf48d4964d873667d8148542ff590fb98eb3f93618da114ca54999d6bc0349734b + version: 3.47.0 + resolution: "core-js@npm:3.47.0" + checksum: 33ed738fbf1d8596400915ed8ff02538cc89e805d7298e52dbac34b9aecd62400cf84905ce6d5fabd5cc96cb61395907d67d8b89067263f3d7fff8e79a230109 languageName: node linkType: hard @@ -7894,19 +8019,19 @@ __metadata: linkType: hard "cosmiconfig@npm:^7.0.0": - version: 7.0.1 - resolution: "cosmiconfig@npm:7.0.1" + version: 7.1.0 + resolution: "cosmiconfig@npm:7.1.0" dependencies: "@types/parse-json": ^4.0.0 import-fresh: ^3.2.1 parse-json: ^5.0.0 path-type: ^4.0.0 yaml: ^1.10.0 - checksum: 4be63e7117955fd88333d7460e4c466a90f556df6ef34efd59034d2463484e339666c41f02b523d574a797ec61f4a91918c5b89a316db2ea2f834e0d2d09465b + checksum: c53bf7befc1591b2651a22414a5e786cd5f2eeaa87f3678a3d49d6069835a9d8d1aef223728e98aa8fec9a95bf831120d245096db12abe019fecb51f5696c96f languageName: node linkType: hard -"create-ecdh@npm:^4.0.0": +"create-ecdh@npm:^4.0.4": version: 4.0.4 resolution: "create-ecdh@npm:4.0.4" dependencies: @@ -7940,19 +8065,7 @@ __metadata: languageName: node linkType: hard -"create-hash@npm:~1.1.3": - version: 1.1.3 - resolution: "create-hash@npm:1.1.3" - dependencies: - cipher-base: ^1.0.1 - inherits: ^2.0.1 - ripemd160: ^2.0.0 - sha.js: ^2.4.0 - checksum: 8d7d9bade6ab432f22737bf6f584155bab26d11b5abd98214034dda1e087bd2c395595f6729751b94d37f95f737dddffeb2db198bbbd5717a125906756ed3012 - languageName: node - linkType: hard - -"create-hmac@npm:^1.1.0, create-hmac@npm:^1.1.7": +"create-hmac@npm:^1.1.7": version: 1.1.7 resolution: "create-hmac@npm:1.1.7" dependencies: @@ -7967,15 +8080,24 @@ __metadata: linkType: hard "cross-fetch@npm:^3.1.5": - version: 3.1.5 - resolution: "cross-fetch@npm:3.1.5" + version: 3.2.0 + resolution: "cross-fetch@npm:3.2.0" + dependencies: + node-fetch: ^2.7.0 + checksum: 8ded5ea35f705e81e569e7db244a3f96e05e95996ff51877c89b0c1ec1163c76bb5dad77d0f8fba6bb35a0abacb36403d7271dc586d8b1f636110ee7a8d959fd + languageName: node + linkType: hard + +"cross-inspect@npm:1.0.1": + version: 1.0.1 + resolution: "cross-inspect@npm:1.0.1" dependencies: - node-fetch: 2.6.7 - checksum: f6b8c6ee3ef993ace6277fd789c71b6acf1b504fd5f5c7128df4ef2f125a429e29cd62dc8c127523f04a5f2fa4771ed80e3f3d9695617f441425045f505cf3bb + tslib: ^2.4.0 + checksum: 7c1e02e0a9670b62416a3ea1df7ae880fdad3aa0a857de8932c4e5f8acd71298c7e3db9da8e9da603f5692cd1879938f5e72e34a9f5d1345987bef656d117fc1 languageName: node linkType: hard -"cross-spawn@npm:^6.0.0, cross-spawn@npm:^6.0.5": +"cross-spawn@npm:^6.0.0": version: 6.0.6 resolution: "cross-spawn@npm:6.0.6" dependencies: @@ -7988,33 +8110,34 @@ __metadata: languageName: node linkType: hard -"cross-spawn@npm:^7.0.0, cross-spawn@npm:^7.0.2, cross-spawn@npm:^7.0.3": - version: 7.0.3 - resolution: "cross-spawn@npm:7.0.3" +"cross-spawn@npm:^7.0.2, cross-spawn@npm:^7.0.3, cross-spawn@npm:^7.0.6": + version: 7.0.6 + resolution: "cross-spawn@npm:7.0.6" dependencies: path-key: ^3.1.0 shebang-command: ^2.0.0 which: ^2.0.1 - checksum: 671cc7c7288c3a8406f3c69a3ae2fc85555c04169e9d611def9a675635472614f1c0ed0ef80955d5b6d4e724f6ced67f0ad1bb006c2ea643488fcfef994d7f52 + checksum: 8d306efacaf6f3f60e0224c287664093fa9185680b2d195852ba9a863f85d02dcc737094c6e512175f8ee0161f9b87c73c6826034c2422e39de7d6569cf4503b languageName: node linkType: hard "crypto-browserify@npm:^3.11.0": - version: 3.12.0 - resolution: "crypto-browserify@npm:3.12.0" + version: 3.12.1 + resolution: "crypto-browserify@npm:3.12.1" dependencies: - browserify-cipher: ^1.0.0 - browserify-sign: ^4.0.0 - create-ecdh: ^4.0.0 - create-hash: ^1.1.0 - create-hmac: ^1.1.0 - diffie-hellman: ^5.0.0 - inherits: ^2.0.1 - pbkdf2: ^3.0.3 - public-encrypt: ^4.0.0 - randombytes: ^2.0.0 - randomfill: ^1.0.3 - checksum: c1609af82605474262f3eaa07daa0b2140026bd264ab316d4bf1170272570dbe02f0c49e29407fe0d3634f96c507c27a19a6765fb856fed854a625f9d15618e2 + browserify-cipher: ^1.0.1 + browserify-sign: ^4.2.3 + create-ecdh: ^4.0.4 + create-hash: ^1.2.0 + create-hmac: ^1.1.7 + diffie-hellman: ^5.0.3 + hash-base: ~3.0.4 + inherits: ^2.0.4 + pbkdf2: ^3.1.2 + public-encrypt: ^4.0.3 + randombytes: ^2.1.0 + randomfill: ^1.0.4 + checksum: 4e643dd5acfff80fbe2cc567feb75a22d726cc4df34772c988f326976c3c1ee1f8a611a33498dab11568cff3e134f0bd44a0e1f4c216585e5877ab5327cdb6fc languageName: node linkType: hard @@ -8033,11 +8156,11 @@ __metadata: linkType: hard "css-declaration-sorter@npm:^6.3.1": - version: 6.3.1 - resolution: "css-declaration-sorter@npm:6.3.1" + version: 6.4.1 + resolution: "css-declaration-sorter@npm:6.4.1" peerDependencies: postcss: ^8.0.9 - checksum: ff0d9989ee21ec4c42430b9bb86c43f973ed5024d68f30edc1e3fb07a22828ce3c3e5b922019f2ccbff606722e43c407c5c76e3cddac523ac4afcb31e4b2601c + checksum: cbdc9e0d481011b1a28fd5b60d4eb55fe204391d31a0b1b490b2cecf4baa85810f9b8c48adab4df644f4718104ed3ed72c64a9745e3216173767bf4aeca7f9b8 languageName: node linkType: hard @@ -8097,15 +8220,15 @@ __metadata: linkType: hard "css-select@npm:^5.1.0": - version: 5.1.0 - resolution: "css-select@npm:5.1.0" + version: 5.2.2 + resolution: "css-select@npm:5.2.2" dependencies: boolbase: ^1.0.0 css-what: ^6.1.0 domhandler: ^5.0.2 domutils: ^3.0.1 nth-check: ^2.0.1 - checksum: 2772c049b188d3b8a8159907192e926e11824aea525b8282981f72ba3f349cf9ecd523fdf7734875ee2cb772246c22117fc062da105b6d59afe8dcd5c99c9bda + checksum: 0ab672620c6bdfe4129dfecf202f6b90f92018b24a1a93cfbb295c24026d0163130ba4b98d7443f87246a2c1d67413798a7a5920cd102b0cfecfbc89896515aa languageName: node linkType: hard @@ -8129,13 +8252,13 @@ __metadata: linkType: hard "css-to-react-native@npm:^3.0.0": - version: 3.0.0 - resolution: "css-to-react-native@npm:3.0.0" + version: 3.2.0 + resolution: "css-to-react-native@npm:3.2.0" dependencies: camelize: ^1.0.0 css-color-keywords: ^1.0.0 postcss-value-parser: ^4.0.2 - checksum: 98a2e9d4fbe9cabc8b744dfdd5ec108396ce497a7b860912a95b299bd52517461281810fcb707965a021a8be39adca9587184a26fb4e926211391a1557aca3c1 + checksum: 263be65e805aef02c3f20c064665c998a8c35293e1505dbe6e3054fb186b01a9897ac6cf121f9840e5a9dfe3fb3994f6fcd0af84a865f1df78ba5bf89e77adce languageName: node linkType: hard @@ -8157,9 +8280,9 @@ __metadata: linkType: hard "css-what@npm:^6.0.1, css-what@npm:^6.1.0": - version: 6.1.0 - resolution: "css-what@npm:6.1.0" - checksum: b975e547e1e90b79625918f84e67db5d33d896e6de846c9b584094e529f0c63e2ab85ee33b9daffd05bff3a146a1916bec664e18bb76dd5f66cbff9fc13b2bbe + version: 6.2.2 + resolution: "css-what@npm:6.2.2" + checksum: 4d1f07b348a638e1f8b4c72804a1e93881f35e0f541256aec5ac0497c5855df7db7ab02da030de950d4813044f6d029a14ca657e0f92c3987e4b604246235b2b languageName: node linkType: hard @@ -8186,21 +8309,21 @@ __metadata: languageName: node linkType: hard -"cssnano-preset-default@npm:^5.2.13": - version: 5.2.13 - resolution: "cssnano-preset-default@npm:5.2.13" +"cssnano-preset-default@npm:^5.2.14": + version: 5.2.14 + resolution: "cssnano-preset-default@npm:5.2.14" dependencies: css-declaration-sorter: ^6.3.1 cssnano-utils: ^3.1.0 postcss-calc: ^8.2.3 - postcss-colormin: ^5.3.0 + postcss-colormin: ^5.3.1 postcss-convert-values: ^5.1.3 postcss-discard-comments: ^5.1.2 postcss-discard-duplicates: ^5.1.0 postcss-discard-empty: ^5.1.1 postcss-discard-overridden: ^5.1.0 postcss-merge-longhand: ^5.1.7 - postcss-merge-rules: ^5.1.3 + postcss-merge-rules: ^5.1.4 postcss-minify-font-values: ^5.1.0 postcss-minify-gradients: ^5.1.1 postcss-minify-params: ^5.1.4 @@ -8215,13 +8338,13 @@ __metadata: postcss-normalize-url: ^5.1.0 postcss-normalize-whitespace: ^5.1.1 postcss-ordered-values: ^5.1.3 - postcss-reduce-initial: ^5.1.1 + postcss-reduce-initial: ^5.1.2 postcss-reduce-transforms: ^5.1.0 postcss-svgo: ^5.1.0 postcss-unique-selectors: ^5.1.1 peerDependencies: postcss: ^8.2.15 - checksum: f773de44f67f71e7301e1f4b4664b894c3a48bba4dadc16c559acd0b14ceafed228bdc76fe19d500b0ded9394732377069daadff2184465fa369f8dfd72d47e2 + checksum: d3bbbe3d50c6174afb28d0bdb65b511fdab33952ec84810aef58b87189f3891c34aaa8b6a6101acd5314f8acded839b43513e39a75f91a698ddc985a1b1d9e95 languageName: node linkType: hard @@ -8235,15 +8358,15 @@ __metadata: linkType: hard "cssnano@npm:^5.0.0": - version: 5.1.14 - resolution: "cssnano@npm:5.1.14" + version: 5.1.15 + resolution: "cssnano@npm:5.1.15" dependencies: - cssnano-preset-default: ^5.2.13 + cssnano-preset-default: ^5.2.14 lilconfig: ^2.0.3 yaml: ^1.10.2 peerDependencies: postcss: ^8.2.15 - checksum: 73463c723c5e598b37b8b4d2f014145bd72133e6581349a1b154904e0830e58de17afb1e801ed3ea3b18e386883964ce4d0299e43d4dc37d339214a956c6697f + checksum: ca9e1922178617c66c2f1548824b2c7af2ecf69cc3a187fc96bf8d29251c2e84d9e4966c69cf64a2a6a057a37dff7d6d057bc8a2a0957e6ea382e452ae9d0bbb languageName: node linkType: hard @@ -8288,20 +8411,20 @@ __metadata: languageName: node linkType: hard -"csstype@npm:^3.0.2": - version: 3.1.1 - resolution: "csstype@npm:3.1.1" - checksum: 1f7b4f5fdd955b7444b18ebdddf3f5c699159f13e9cf8ac9027ae4a60ae226aef9bbb14a6e12ca7dba3358b007cee6354b116e720262867c398de6c955ea451d +"csstype@npm:^3.0.2, csstype@npm:^3.2.2": + version: 3.2.3 + resolution: "csstype@npm:3.2.3" + checksum: cb882521b3398958a1ce6ca98c011aec0bde1c77ecaf8a1dd4db3b112a189939beae3b1308243b2fe50fc27eb3edeb0f73a5a4d91d928765dc6d5ecc7bda92ee languageName: node linkType: hard -"d@npm:1, d@npm:^1.0.1": - version: 1.0.1 - resolution: "d@npm:1.0.1" +"d@npm:1, d@npm:^1.0.1, d@npm:^1.0.2": + version: 1.0.2 + resolution: "d@npm:1.0.2" dependencies: - es5-ext: ^0.10.50 - type: ^1.0.1 - checksum: 49ca0639c7b822db670de93d4fbce44b4aa072cd848c76292c9978a8cd0fff1028763020ff4b0f147bd77bfe29b4c7f82e0f71ade76b2a06100543cdfd948d19 + es5-ext: ^0.10.64 + type: ^2.7.2 + checksum: 775db1e8ced6707cddf64a5840522fcf5475d38ef49a5d615be0ac47f86ef64d15f5a73de1522b09327cc466d4dc35ea83dbfeed456f7a0fdcab138deb800355 languageName: node linkType: hard @@ -8343,6 +8466,39 @@ __metadata: languageName: node linkType: hard +"data-view-buffer@npm:^1.0.2": + version: 1.0.2 + resolution: "data-view-buffer@npm:1.0.2" + dependencies: + call-bound: ^1.0.3 + es-errors: ^1.3.0 + is-data-view: ^1.0.2 + checksum: 1e1cd509c3037ac0f8ba320da3d1f8bf1a9f09b0be09394b5e40781b8cc15ff9834967ba7c9f843a425b34f9fe14ce44cf055af6662c44263424c1eb8d65659b + languageName: node + linkType: hard + +"data-view-byte-length@npm:^1.0.2": + version: 1.0.2 + resolution: "data-view-byte-length@npm:1.0.2" + dependencies: + call-bound: ^1.0.3 + es-errors: ^1.3.0 + is-data-view: ^1.0.2 + checksum: 3600c91ced1cfa935f19ef2abae11029e01738de8d229354d3b2a172bf0d7e4ed08ff8f53294b715569fdf72dfeaa96aa7652f479c0f60570878d88e7e8bddf6 + languageName: node + linkType: hard + +"data-view-byte-offset@npm:^1.0.1": + version: 1.0.1 + resolution: "data-view-byte-offset@npm:1.0.1" + dependencies: + call-bound: ^1.0.2 + es-errors: ^1.3.0 + is-data-view: ^1.0.1 + checksum: 8dd492cd51d19970876626b5b5169fbb67ca31ec1d1d3238ee6a71820ca8b80cafb141c485999db1ee1ef02f2cc3b99424c5eda8d59e852d9ebb79ab290eb5ee + languageName: node + linkType: hard + "dataloader@npm:^1.4.0": version: 1.4.0 resolution: "dataloader@npm:1.4.0" @@ -8351,9 +8507,11 @@ __metadata: linkType: hard "date-fns@npm:^2.25.0": - version: 2.29.3 - resolution: "date-fns@npm:2.29.3" - checksum: e01cf5b62af04e05dfff921bb9c9933310ed0e1ae9a81eb8653452e64dc841acf7f6e01e1a5ae5644d0337e9a7f936175fd2cb6819dc122fdd9c5e86c56be484 + version: 2.30.0 + resolution: "date-fns@npm:2.30.0" + dependencies: + "@babel/runtime": ^7.21.0 + checksum: f7be01523282e9bb06c0cd2693d34f245247a29098527d4420628966a2d9aad154bd0e90a6b1cf66d37adcb769cd108cf8a7bd49d76db0fb119af5cdd13644f4 languageName: node linkType: hard @@ -8364,7 +8522,7 @@ __metadata: languageName: node linkType: hard -"debug@npm:2, debug@npm:2.6.9, debug@npm:^2.2.0, debug@npm:^2.6.0, debug@npm:^2.6.9": +"debug@npm:2, debug@npm:2.6.9, debug@npm:^2.2.0, debug@npm:^2.6.0": version: 2.6.9 resolution: "debug@npm:2.6.9" dependencies: @@ -8373,15 +8531,15 @@ __metadata: languageName: node linkType: hard -"debug@npm:4, debug@npm:^4.0.0, debug@npm:^4.0.1, debug@npm:^4.1.0, debug@npm:^4.1.1, debug@npm:^4.3.1, debug@npm:^4.3.3, debug@npm:^4.3.4, debug@npm:~4.3.1": - version: 4.3.4 - resolution: "debug@npm:4.3.4" +"debug@npm:4, debug@npm:^4.0.0, debug@npm:^4.0.1, debug@npm:^4.1.0, debug@npm:^4.1.1, debug@npm:^4.3.1, debug@npm:^4.3.4, debug@npm:^4.4.1": + version: 4.4.3 + resolution: "debug@npm:4.4.3" dependencies: - ms: 2.1.2 + ms: ^2.1.3 peerDependenciesMeta: supports-color: optional: true - checksum: 3dbad3f94ea64f34431a9cbf0bafb61853eda57bff2880036153438f50fb5a84f27683ba0d8e5426bf41a8c6ff03879488120cf5b3a761e77953169c0600a708 + checksum: 4805abd570e601acdca85b6aa3757186084a45cff9b2fa6eee1f3b173caa776b45f478b2a71a572d616d2010cea9211d0ac4a02a610e4c18ac4324bde3760834 languageName: node linkType: hard @@ -8394,6 +8552,18 @@ __metadata: languageName: node linkType: hard +"debug@npm:~4.3.1": + version: 4.3.7 + resolution: "debug@npm:4.3.7" + dependencies: + ms: ^2.1.3 + peerDependenciesMeta: + supports-color: + optional: true + checksum: 822d74e209cd910ef0802d261b150314bbcf36c582ccdbb3e70f0894823c17e49a50d3e66d96b633524263975ca16b6a833f3e3b7e030c157169a5fabac63160 + languageName: node + linkType: hard + "decamelize@npm:^1.2.0": version: 1.2.0 resolution: "decamelize@npm:1.2.0" @@ -8401,10 +8571,10 @@ __metadata: languageName: node linkType: hard -"decimal.js@npm:^10.4.1": - version: 10.4.2 - resolution: "decimal.js@npm:10.4.2" - checksum: 536cd6816a3197f2e1aa3da4860856cb5a2db73f6fafe8cb3b924ccc63f9b7d78296acc13dccbd419bd958ccc6357921fb15467f883b37cab04bfba7044cada2 +"decimal.js@npm:^10.4.2": + version: 10.6.0 + resolution: "decimal.js@npm:10.6.0" + checksum: 9302b990cd6f4da1c7602200002e40e15d15660374432963421d3cd6d81cc6e27e0a488356b030fee64650947e32e78bdbea245d596dadfeeeb02e146d485999 languageName: node linkType: hard @@ -8416,15 +8586,15 @@ __metadata: linkType: hard "decode-named-character-reference@npm:^1.0.0": - version: 1.0.2 - resolution: "decode-named-character-reference@npm:1.0.2" + version: 1.2.0 + resolution: "decode-named-character-reference@npm:1.2.0" dependencies: character-entities: ^2.0.0 - checksum: f4c71d3b93105f20076052f9cb1523a22a9c796b8296cd35eef1ca54239c78d182c136a848b83ff8da2071e3ae2b1d300bf29d00650a6d6e675438cc31b11d78 + checksum: f26b23046c1a137c0b41fa51e3ce07ba8364640322c742a31570999784abc8572fc24cb108a76b14ff72ddb75d35aad3d14b10d7743639112145a2664b9d1864 languageName: node linkType: hard -"decode-uri-component@npm:^0.2.0": +"decode-uri-component@npm:^0.2.0, decode-uri-component@npm:^0.2.2": version: 0.2.2 resolution: "decode-uri-component@npm:0.2.2" checksum: 95476a7d28f267292ce745eac3524a9079058bbb35767b76e3ee87d42e34cd0275d2eb19d9d08c3e167f97556e8a2872747f5e65cbebcac8b0c98d83e285f139 @@ -8459,25 +8629,28 @@ __metadata: linkType: hard "deep-equal@npm:^2.0.5": - version: 2.1.0 - resolution: "deep-equal@npm:2.1.0" + version: 2.2.3 + resolution: "deep-equal@npm:2.2.3" dependencies: - call-bind: ^1.0.2 - es-get-iterator: ^1.1.2 - get-intrinsic: ^1.1.3 + array-buffer-byte-length: ^1.0.0 + call-bind: ^1.0.5 + es-get-iterator: ^1.1.3 + get-intrinsic: ^1.2.2 is-arguments: ^1.1.1 + is-array-buffer: ^3.0.2 is-date-object: ^1.0.5 is-regex: ^1.1.4 + is-shared-array-buffer: ^1.0.2 isarray: ^2.0.5 object-is: ^1.1.5 object-keys: ^1.1.1 object.assign: ^4.1.4 - regexp.prototype.flags: ^1.4.3 + regexp.prototype.flags: ^1.5.1 side-channel: ^1.0.4 which-boxed-primitive: ^1.0.2 which-collection: ^1.0.1 - which-typed-array: ^1.1.8 - checksum: a3efc772f14372d2a88bb1e414ab2218cf23cc77673521bbccbb2fc128dd8b6cccfad05eb35b9a8a4669bd7f3ecebaa137beebdf549b7be56c617bd5488ca987 + which-typed-array: ^1.1.13 + checksum: ee8852f23e4d20a5626c13b02f415ba443a1b30b4b3d39eaf366d59c4a85e6545d7ec917db44d476a85ae5a86064f7e5f7af7479f38f113995ba869f3a1ddc53 languageName: node linkType: hard @@ -8496,9 +8669,9 @@ __metadata: linkType: hard "deepmerge@npm:^4.2.2": - version: 4.2.2 - resolution: "deepmerge@npm:4.2.2" - checksum: a8c43a1ed8d6d1ed2b5bf569fa4c8eb9f0924034baf75d5d406e47e157a451075c4db353efea7b6bcc56ec48116a8ce72fccf867b6e078e7c561904b5897530b + version: 4.3.1 + resolution: "deepmerge@npm:4.3.1" + checksum: 2024c6a980a1b7128084170c4cf56b0fd58a63f2da1660dcfe977415f27b17dbe5888668b59d0b063753f3220719d5e400b7f113609489c90160bb9a5518d052 languageName: node linkType: hard @@ -8516,7 +8689,7 @@ __metadata: languageName: node linkType: hard -"define-data-property@npm:^1.1.4": +"define-data-property@npm:^1.0.1, define-data-property@npm:^1.1.4": version: 1.1.4 resolution: "define-data-property@npm:1.1.4" dependencies: @@ -8534,13 +8707,14 @@ __metadata: languageName: node linkType: hard -"define-properties@npm:^1.1.3, define-properties@npm:^1.1.4": - version: 1.1.4 - resolution: "define-properties@npm:1.1.4" +"define-properties@npm:^1.1.3, define-properties@npm:^1.2.1": + version: 1.2.1 + resolution: "define-properties@npm:1.2.1" dependencies: + define-data-property: ^1.0.1 has-property-descriptors: ^1.0.0 object-keys: ^1.1.1 - checksum: ce0aef3f9eb193562b5cfb79b2d2c86b6a109dfc9fdcb5f45d680631a1a908c06824ddcdb72b7573b54e26ace07f0a23420aaba0d5c627b34d2c1de8ef527e2b + checksum: b4ccd00597dd46cb2d4a379398f5b19fca84a16f3374e2249201992f36b30f6835949a9429669ee6b41b6e837205a163eadd745e472069e70dfc10f03e5fcc12 languageName: node linkType: hard @@ -8551,13 +8725,6 @@ __metadata: languageName: node linkType: hard -"delegates@npm:^1.0.0": - version: 1.0.0 - resolution: "delegates@npm:1.0.0" - checksum: a51744d9b53c164ba9c0492471a1a2ffa0b6727451bdc89e31627fdf4adda9d51277cfcbfb20f0a6f08ccb3c436f341df3e92631a3440226d93a8971724771fd - languageName: node - linkType: hard - "depd@npm:2.0.0, depd@npm:~2.0.0": version: 2.0.0 resolution: "depd@npm:2.0.0" @@ -8565,7 +8732,7 @@ __metadata: languageName: node linkType: hard -"depd@npm:^1.1.2, depd@npm:~1.1.2": +"depd@npm:~1.1.2": version: 1.1.2 resolution: "depd@npm:1.1.2" checksum: 6b406620d269619852885ce15965272b829df6f409724415e0002c8632ab6a8c0a08ec1f0bd2add05dc7bd7507606f7e2cc034fa24224ab829580040b835ecd9 @@ -8587,16 +8754,16 @@ __metadata: linkType: hard "des.js@npm:^1.0.0": - version: 1.0.1 - resolution: "des.js@npm:1.0.1" + version: 1.1.0 + resolution: "des.js@npm:1.1.0" dependencies: inherits: ^2.0.1 minimalistic-assert: ^1.0.0 - checksum: 1ec2eedd7ed6bd61dd5e0519fd4c96124e93bb22de8a9d211b02d63e5dd152824853d919bb2090f965cc0e3eb9c515950a9836b332020d810f9c71feb0fd7df4 + checksum: 0e9c1584b70d31e20f20a613fc9ef60fbc6a147dfec9e448a168794a4b97ac04d8dc47ea008f1fa93b0f8aaf7c1ead632a5e59ce1913a6079d2d244c9f5ebe33 languageName: node linkType: hard -"destroy@npm:1.2.0": +"destroy@npm:1.2.0, destroy@npm:~1.2.0": version: 1.2.0 resolution: "destroy@npm:1.2.0" checksum: 0acb300b7478a08b92d810ab229d5afe0d2f4399272045ab22affa0d99dbaf12637659411530a6fcd597a9bdac718fc94373a61a95b4651bbc7b83684a565e38 @@ -8628,17 +8795,10 @@ __metadata: languageName: node linkType: hard -"detect-libc@npm:^2.0.0, detect-libc@npm:^2.0.1": - version: 2.0.1 - resolution: "detect-libc@npm:2.0.1" - checksum: ccb05fcabbb555beb544d48080179c18523a343face9ee4e1a86605a8715b4169f94d663c21a03c310ac824592f2ba9a5270218819bb411ad7be578a527593d7 - languageName: node - linkType: hard - -"detect-libc@npm:^2.0.2": - version: 2.0.2 - resolution: "detect-libc@npm:2.0.2" - checksum: 2b2cd3649b83d576f4be7cc37eb3b1815c79969c8b1a03a40a4d55d83bc74d010753485753448eacb98784abf22f7dbd3911fd3b60e29fda28fed2d1a997944d +"detect-libc@npm:^2.0.0, detect-libc@npm:^2.0.1, detect-libc@npm:^2.0.2": + version: 2.1.2 + resolution: "detect-libc@npm:2.1.2" + checksum: 471740d52365084c4b2ae359e507b863f2b1d79b08a92835ebdf701918e08fc9cfba175b3db28483ca33b155e1311a91d69dc42c6d192b476f41a9e1f094ce6a languageName: node linkType: hard @@ -8656,15 +8816,15 @@ __metadata: linkType: hard "detect-port@npm:^1.3.0": - version: 1.5.1 - resolution: "detect-port@npm:1.5.1" + version: 1.6.1 + resolution: "detect-port@npm:1.6.1" dependencies: address: ^1.0.1 debug: 4 bin: detect: bin/detect-port.js detect-port: bin/detect-port.js - checksum: b48da9340481742547263d5d985e65d078592557863402ecf538511735e83575867e94f91fe74405ea19b61351feb99efccae7e55de9a151d5654e3417cea05b + checksum: 0429fa423abb15fc453face64e6ffa406e375f51f5b4421a7886962e680dc05824eae9b6ee4594ba273685c3add415ad00982b5da54802ac3de6f846173284c3 languageName: node linkType: hard @@ -8708,7 +8868,7 @@ __metadata: languageName: node linkType: hard -"diffie-hellman@npm:^5.0.0": +"diffie-hellman@npm:^5.0.3": version: 5.0.3 resolution: "diffie-hellman@npm:5.0.3" dependencies: @@ -8805,11 +8965,11 @@ __metadata: linkType: hard "dom7@npm:^4.0.4": - version: 4.0.4 - resolution: "dom7@npm:4.0.4" + version: 4.0.6 + resolution: "dom7@npm:4.0.6" dependencies: ssr-window: ^4.0.0 - checksum: b38604f74e915b4d05b6634f9ff239a708c468180f498a28ff67f2a61233697d9bd7192703b788a24541c3591e7f1a6e83a2cbf70bc871a85e033f82e19abc31 + checksum: 616a68cbae59eaea2e717ada5855346f0ffa4ac10ab96713bb42b90efabce367213c3c491c4bf5502d177b0865c63d8abd298cc8e12bdda171340c853d6b515a languageName: node linkType: hard @@ -8879,7 +9039,7 @@ __metadata: languageName: node linkType: hard -"domhandler@npm:^5.0.1, domhandler@npm:^5.0.2, domhandler@npm:^5.0.3": +"domhandler@npm:^5.0.2, domhandler@npm:^5.0.3": version: 5.0.3 resolution: "domhandler@npm:5.0.3" dependencies: @@ -8920,31 +9080,20 @@ __metadata: resolution: "domutils@npm:2.8.0" dependencies: dom-serializer: ^1.0.1 - domelementtype: ^2.2.0 - domhandler: ^4.2.0 - checksum: abf7434315283e9aadc2a24bac0e00eab07ae4313b40cc239f89d84d7315ebdfd2fb1b5bf750a96bc1b4403d7237c7b2ebf60459be394d625ead4ca89b934391 - languageName: node - linkType: hard - -"domutils@npm:^3.0.1": - version: 3.0.1 - resolution: "domutils@npm:3.0.1" - dependencies: - dom-serializer: ^2.0.0 - domelementtype: ^2.3.0 - domhandler: ^5.0.1 - checksum: 23aa7a840572d395220e173cb6263b0d028596e3950100520870a125af33ff819e6f609e1606d6f7d73bd9e7feb03bb404286e57a39063b5384c62b724d987b3 + domelementtype: ^2.2.0 + domhandler: ^4.2.0 + checksum: abf7434315283e9aadc2a24bac0e00eab07ae4313b40cc239f89d84d7315ebdfd2fb1b5bf750a96bc1b4403d7237c7b2ebf60459be394d625ead4ca89b934391 languageName: node linkType: hard -"domutils@npm:^3.1.0": - version: 3.1.0 - resolution: "domutils@npm:3.1.0" +"domutils@npm:^3.0.1, domutils@npm:^3.1.0, domutils@npm:^3.2.1, domutils@npm:^3.2.2": + version: 3.2.2 + resolution: "domutils@npm:3.2.2" dependencies: dom-serializer: ^2.0.0 domelementtype: ^2.3.0 domhandler: ^5.0.3 - checksum: e5757456ddd173caa411cfc02c2bb64133c65546d2c4081381a3bafc8a57411a41eed70494551aa58030be9e58574fcc489828bebd673863d39924fb4878f416 + checksum: ae941d56f03d857077d55dde9297e960a625229fc2b933187cc4123084d7c2d2517f58283a7336567127029f1e008449bac8ac8506d44341e29e3bb18e02f906 languageName: node linkType: hard @@ -8997,7 +9146,7 @@ __metadata: languageName: node linkType: hard -"dunder-proto@npm:^1.0.1": +"dunder-proto@npm:^1.0.0, dunder-proto@npm:^1.0.1": version: 1.0.1 resolution: "dunder-proto@npm:1.0.1" dependencies: @@ -9060,21 +9209,14 @@ __metadata: languageName: node linkType: hard -"electron-to-chromium@npm:^1.4.251": - version: 1.4.284 - resolution: "electron-to-chromium@npm:1.4.284" - checksum: be496e9dca6509dbdbb54dc32146fc99f8eb716d28a7ee8ccd3eba0066561df36fc51418d8bd7cf5a5891810bf56c0def3418e74248f51ea4a843d423603d10a - languageName: node - linkType: hard - -"electron-to-chromium@npm:^1.4.820": - version: 1.5.0 - resolution: "electron-to-chromium@npm:1.5.0" - checksum: 82e362dd5851f5ad312ab6699c5d36221deb1fbd4ab2c28f43c3244dd7d28aee28c3239491564dd4bb57f3ed8291a88c4f7983c61aad6db98459e96400923b8d +"electron-to-chromium@npm:^1.5.263": + version: 1.5.267 + resolution: "electron-to-chromium@npm:1.5.267" + checksum: 923a21ea4c3f2536eb7ccf80e92d9368a2e5a13e6deccb1d94c31b5a5b4e10e722149b85db9892e9819150f1c43462692a92dc85ba0c205a4eb578e173b3ab36 languageName: node linkType: hard -"elliptic@npm:^6.5.3, elliptic@npm:^6.5.5": +"elliptic@npm:^6.5.3, elliptic@npm:^6.6.1": version: 6.6.1 resolution: "elliptic@npm:6.6.1" dependencies: @@ -9090,9 +9232,9 @@ __metadata: linkType: hard "emoji-regex@npm:^10.2.1": - version: 10.3.0 - resolution: "emoji-regex@npm:10.3.0" - checksum: 5da48edfeb9462fb1ae5495cff2d79129974c696853fb0ce952cbf560f29a2756825433bf51cfd5157ec7b9f93f46f31d712e896d63e3d8ac9c3832bdb45ab73 + version: 10.6.0 + resolution: "emoji-regex@npm:10.6.0" + checksum: 8785f6a7ec4559c931bd6640f748fe23791f5af4c743b131d458c5551b4aa7da2a9cd882518723cb3859e8b0b59b0cc08f2ce0f8e65c61a026eed71c2dc407d5 languageName: node linkType: hard @@ -9131,6 +9273,16 @@ __metadata: languageName: node linkType: hard +"encoding-sniffer@npm:^0.2.1": + version: 0.2.1 + resolution: "encoding-sniffer@npm:0.2.1" + dependencies: + iconv-lite: ^0.6.3 + whatwg-encoding: ^3.1.1 + checksum: d96cc88bbab6a88f57805491fa948b7b1c30f8488939fe4397c58c79ce766a1027f4c10de1893a9b5e489c4ad8ed927f6a8a87f1d114b6f3d5cb3bbbc73601d7 + languageName: node + linkType: hard + "encoding@npm:^0.1.11, encoding@npm:^0.1.13": version: 0.1.13 resolution: "encoding@npm:0.1.13" @@ -9141,11 +9293,11 @@ __metadata: linkType: hard "end-of-stream@npm:^1.1.0, end-of-stream@npm:^1.4.1": - version: 1.4.4 - resolution: "end-of-stream@npm:1.4.4" + version: 1.4.5 + resolution: "end-of-stream@npm:1.4.5" dependencies: once: ^1.4.0 - checksum: 530a5a5a1e517e962854a31693dbb5c0b2fc40b46dad2a56a2deec656ca040631124f4795823acc68238147805f8b021abbe221f4afed5ef3c8e8efc2024908b + checksum: 1e0cfa6e7f49887544e03314f9dfc56a8cb6dde910cbb445983ecc2ff426fc05946df9d75d8a21a3a64f2cecfe1bf88f773952029f46756b2ed64a24e95b1fb8 languageName: node linkType: hard @@ -9191,32 +9343,23 @@ __metadata: languageName: node linkType: hard -"enhanced-resolve@npm:^5.17.1": - version: 5.17.1 - resolution: "enhanced-resolve@npm:5.17.1" - dependencies: - graceful-fs: ^4.2.4 - tapable: ^2.2.0 - checksum: 4bc38cf1cea96456f97503db7280394177d1bc46f8f87c267297d04f795ac5efa81e48115a2f5b6273c781027b5b6bfc5f62b54df629e4d25fa7001a86624f59 - languageName: node - linkType: hard - -"enhanced-resolve@npm:^5.8.3": - version: 5.10.0 - resolution: "enhanced-resolve@npm:5.10.0" +"enhanced-resolve@npm:^5.17.4, enhanced-resolve@npm:^5.8.3": + version: 5.18.4 + resolution: "enhanced-resolve@npm:5.18.4" dependencies: graceful-fs: ^4.2.4 tapable: ^2.2.0 - checksum: 0bb9830704db271610f900e8d79d70a740ea16f251263362b0c91af545576d09fe50103496606c1300a05e588372d6f9780a9bc2e30ce8ef9b827ec8f44687ff + checksum: 8e8a1e8efd2361d32c8a4ea00523b52311ea47e66abebda159f1e60d8849161550821f44fde51fca20261b70a0b3f61dec6d4425816934a2adb65a9ea0574ec8 languageName: node linkType: hard "enquirer@npm:^2.3.5": - version: 2.3.6 - resolution: "enquirer@npm:2.3.6" + version: 2.4.1 + resolution: "enquirer@npm:2.4.1" dependencies: ansi-colors: ^4.1.1 - checksum: 1c0911e14a6f8d26721c91e01db06092a5f7675159f0261d69c403396a385afd13dd76825e7678f66daffa930cfaa8d45f506fb35f818a2788463d022af1b884 + strip-ansi: ^6.0.1 + checksum: f080f11a74209647dbf347a7c6a83c8a47ae1ebf1e75073a808bc1088eb780aa54075bfecd1bcdb3e3c724520edb8e6ee05da031529436b421b71066fcc48cb5 languageName: node linkType: hard @@ -9234,20 +9377,20 @@ __metadata: languageName: node linkType: hard -"entities@npm:^4.2.0, entities@npm:^4.3.0, entities@npm:^4.4.0": - version: 4.4.0 - resolution: "entities@npm:4.4.0" - checksum: 84d250329f4b56b40fa93ed067b194db21e8815e4eb9b59f43a086f0ecd342814f6bc483de8a77da5d64e0f626033192b1b4f1792232a7ea6b970ebe0f3187c2 - languageName: node - linkType: hard - -"entities@npm:^4.5.0": +"entities@npm:^4.2.0, entities@npm:^4.4.0, entities@npm:^4.5.0": version: 4.5.0 resolution: "entities@npm:4.5.0" checksum: 853f8ebd5b425d350bffa97dd6958143179a5938352ccae092c62d1267c4e392a039be1bae7d51b6e4ffad25f51f9617531fedf5237f15df302ccfb452cbf2d7 languageName: node linkType: hard +"entities@npm:^6.0.0": + version: 6.0.1 + resolution: "entities@npm:6.0.1" + checksum: 937b952e81aca641660a6a07f70001c6821973dea3ae7f6a5013eadce94620f3ed2e9c745832d503c8811ce6e97704d8a0396159580c0e567d815234de7fdecf + languageName: node + linkType: hard + "env-paths@npm:^2.2.0": version: 2.2.1 resolution: "env-paths@npm:2.2.1" @@ -9256,11 +9399,11 @@ __metadata: linkType: hard "envinfo@npm:^7.8.1": - version: 7.8.1 - resolution: "envinfo@npm:7.8.1" + version: 7.21.0 + resolution: "envinfo@npm:7.21.0" bin: envinfo: dist/cli.js - checksum: de736c98d6311c78523628ff127af138451b162e57af5293c1b984ca821d0aeb9c849537d2fde0434011bed33f6bca5310ca2aab8a51a3f28fc719e89045d648 + checksum: c9526266810a328396c387c0580d6fc10f6ce8464074ae6eaef6798e2a05b5800b480b2eaf739cf523e3bfb407baba2ef23ff8edebb76c2b8fa7fbac995b3b9b languageName: node linkType: hard @@ -9279,11 +9422,11 @@ __metadata: linkType: hard "error-ex@npm:^1.3.1, error-ex@npm:^1.3.2": - version: 1.3.2 - resolution: "error-ex@npm:1.3.2" + version: 1.3.4 + resolution: "error-ex@npm:1.3.4" dependencies: is-arrayish: ^0.2.1 - checksum: c1c2b8b65f9c91b0f9d75f0debaa7ec5b35c266c2cac5de412c1a6de86d4cbae04ae44e510378cb14d032d0645a36925d0186f8bb7367bcc629db256b743a001 + checksum: 25136c0984569c8d68417036a9a1624804314296f24675199a391e5d20b2e26fe6d9304d40901293fa86900603a229983c9a8921ea7f1d16f814c2db946ff4ef languageName: node linkType: hard @@ -9305,48 +9448,69 @@ __metadata: languageName: node linkType: hard -"es-abstract@npm:^1.19.0, es-abstract@npm:^1.20.4": - version: 1.20.4 - resolution: "es-abstract@npm:1.20.4" +"es-abstract@npm:^1.17.5, es-abstract@npm:^1.23.2, es-abstract@npm:^1.23.3, es-abstract@npm:^1.23.5, es-abstract@npm:^1.23.6, es-abstract@npm:^1.23.9, es-abstract@npm:^1.24.0, es-abstract@npm:^1.24.1": + version: 1.24.1 + resolution: "es-abstract@npm:1.24.1" dependencies: - call-bind: ^1.0.2 - es-to-primitive: ^1.2.1 - function-bind: ^1.1.1 - function.prototype.name: ^1.1.5 - get-intrinsic: ^1.1.3 - get-symbol-description: ^1.0.0 - has: ^1.0.3 - has-property-descriptors: ^1.0.0 - has-symbols: ^1.0.3 - internal-slot: ^1.0.3 + array-buffer-byte-length: ^1.0.2 + arraybuffer.prototype.slice: ^1.0.4 + available-typed-arrays: ^1.0.7 + call-bind: ^1.0.8 + call-bound: ^1.0.4 + data-view-buffer: ^1.0.2 + data-view-byte-length: ^1.0.2 + data-view-byte-offset: ^1.0.1 + es-define-property: ^1.0.1 + es-errors: ^1.3.0 + es-object-atoms: ^1.1.1 + es-set-tostringtag: ^2.1.0 + es-to-primitive: ^1.3.0 + function.prototype.name: ^1.1.8 + get-intrinsic: ^1.3.0 + get-proto: ^1.0.1 + get-symbol-description: ^1.1.0 + globalthis: ^1.0.4 + gopd: ^1.2.0 + has-property-descriptors: ^1.0.2 + has-proto: ^1.2.0 + has-symbols: ^1.1.0 + hasown: ^2.0.2 + internal-slot: ^1.1.0 + is-array-buffer: ^3.0.5 is-callable: ^1.2.7 - is-negative-zero: ^2.0.2 - is-regex: ^1.1.4 - is-shared-array-buffer: ^1.0.2 - is-string: ^1.0.7 - is-weakref: ^1.0.2 - object-inspect: ^1.12.2 + is-data-view: ^1.0.2 + is-negative-zero: ^2.0.3 + is-regex: ^1.2.1 + is-set: ^2.0.3 + is-shared-array-buffer: ^1.0.4 + is-string: ^1.1.1 + is-typed-array: ^1.1.15 + is-weakref: ^1.1.1 + math-intrinsics: ^1.1.0 + object-inspect: ^1.13.4 object-keys: ^1.1.1 - object.assign: ^4.1.4 - regexp.prototype.flags: ^1.4.3 - safe-regex-test: ^1.0.0 - string.prototype.trimend: ^1.0.5 - string.prototype.trimstart: ^1.0.5 - unbox-primitive: ^1.0.2 - checksum: 89297cc785c31aedf961a603d5a07ed16471e435d3a1b6d070b54f157cf48454b95cda2ac55e4b86ff4fe3276e835fcffd2771578e6fa634337da49b26826141 - languageName: node - linkType: hard - -"es-define-property@npm:^1.0.0": - version: 1.0.0 - resolution: "es-define-property@npm:1.0.0" - dependencies: - get-intrinsic: ^1.2.4 - checksum: f66ece0a887b6dca71848fa71f70461357c0e4e7249696f81bad0a1f347eed7b31262af4a29f5d726dc026426f085483b6b90301855e647aa8e21936f07293c6 + object.assign: ^4.1.7 + own-keys: ^1.0.1 + regexp.prototype.flags: ^1.5.4 + safe-array-concat: ^1.1.3 + safe-push-apply: ^1.0.0 + safe-regex-test: ^1.1.0 + set-proto: ^1.0.0 + stop-iteration-iterator: ^1.1.0 + string.prototype.trim: ^1.2.10 + string.prototype.trimend: ^1.0.9 + string.prototype.trimstart: ^1.0.8 + typed-array-buffer: ^1.0.3 + typed-array-byte-length: ^1.0.3 + typed-array-byte-offset: ^1.0.4 + typed-array-length: ^1.0.7 + unbox-primitive: ^1.1.0 + which-typed-array: ^1.1.19 + checksum: 84896f97ac812bd9d884f1e5372ae71dbdbef364d2e178defdb712a0aae8c9df66f447b472ad54e3e1fa5aa9a84f3c11b5f35007d629cf975699c5f885aeb0c5 languageName: node linkType: hard -"es-define-property@npm:^1.0.1": +"es-define-property@npm:^1.0.0, es-define-property@npm:^1.0.1": version: 1.0.1 resolution: "es-define-property@npm:1.0.1" checksum: 0512f4e5d564021c9e3a644437b0155af2679d10d80f21adaf868e64d30efdfbd321631956f20f42d655fedb2e3a027da479fad3fa6048f768eb453a80a5f80a @@ -9360,26 +9524,51 @@ __metadata: languageName: node linkType: hard -"es-get-iterator@npm:^1.1.2": - version: 1.1.2 - resolution: "es-get-iterator@npm:1.1.2" +"es-get-iterator@npm:^1.1.3": + version: 1.1.3 + resolution: "es-get-iterator@npm:1.1.3" dependencies: call-bind: ^1.0.2 - get-intrinsic: ^1.1.0 - has-symbols: ^1.0.1 - is-arguments: ^1.1.0 + get-intrinsic: ^1.1.3 + has-symbols: ^1.0.3 + is-arguments: ^1.1.1 is-map: ^2.0.2 is-set: ^2.0.2 - is-string: ^1.0.5 + is-string: ^1.0.7 isarray: ^2.0.5 - checksum: f75e66acb6a45686fa08b3ade9c9421a70d36a0c43ed4363e67f4d7aab2226cb73dd977cb48abbaf75721b946d3cd810682fcf310c7ad0867802fbf929b17dcf + stop-iteration-iterator: ^1.0.0 + checksum: 8fa118da42667a01a7c7529f8a8cca514feeff243feec1ce0bb73baaa3514560bd09d2b3438873cf8a5aaec5d52da248131de153b28e2638a061b6e4df13267d languageName: node linkType: hard -"es-module-lexer@npm:^1.2.1": - version: 1.5.4 - resolution: "es-module-lexer@npm:1.5.4" - checksum: a0cf04fb92d052647ac7d818d1913b98d3d3d0f5b9d88f0eafb993436e4c3e2c958599db68839d57f2dfa281fdf0f60e18d448eb78fc292c33c0f25635b6854f +"es-iterator-helpers@npm:^1.2.1": + version: 1.2.2 + resolution: "es-iterator-helpers@npm:1.2.2" + dependencies: + call-bind: ^1.0.8 + call-bound: ^1.0.4 + define-properties: ^1.2.1 + es-abstract: ^1.24.1 + es-errors: ^1.3.0 + es-set-tostringtag: ^2.1.0 + function-bind: ^1.1.2 + get-intrinsic: ^1.3.0 + globalthis: ^1.0.4 + gopd: ^1.2.0 + has-property-descriptors: ^1.0.2 + has-proto: ^1.2.0 + has-symbols: ^1.1.0 + internal-slot: ^1.1.0 + iterator.prototype: ^1.1.5 + safe-array-concat: ^1.1.3 + checksum: 33e148b592d41630ea53b20ec8d6f2ca7516871c43bdf1619fdb4c770361c625f134ff4276332d6e08e9f59d1cd75532a74723f56176c4599e0387f51750e286 + languageName: node + linkType: hard + +"es-module-lexer@npm:^2.0.0": + version: 2.0.0 + resolution: "es-module-lexer@npm:2.0.0" + checksum: 6290c43cc9bf6c9f9167b4be8c0105137401fbbd9d503d89880f7e811286cd33ab628407e7dea3c14d41cf9e634e580e5d9952907003a88c7fb2461de6f1b2c1 languageName: node linkType: hard @@ -9392,27 +9581,39 @@ __metadata: languageName: node linkType: hard -"es-shim-unscopables@npm:^1.0.0": - version: 1.0.0 - resolution: "es-shim-unscopables@npm:1.0.0" +"es-set-tostringtag@npm:^2.1.0": + version: 2.1.0 + resolution: "es-set-tostringtag@npm:2.1.0" + dependencies: + es-errors: ^1.3.0 + get-intrinsic: ^1.2.6 + has-tostringtag: ^1.0.2 + hasown: ^2.0.2 + checksum: 789f35de4be3dc8d11fdcb91bc26af4ae3e6d602caa93299a8c45cf05d36cc5081454ae2a6d3afa09cceca214b76c046e4f8151e092e6fc7feeb5efb9e794fc6 + languageName: node + linkType: hard + +"es-shim-unscopables@npm:^1.0.2, es-shim-unscopables@npm:^1.1.0": + version: 1.1.0 + resolution: "es-shim-unscopables@npm:1.1.0" dependencies: - has: ^1.0.3 - checksum: 83e95cadbb6ee44d3644dfad60dcad7929edbc42c85e66c3e99aefd68a3a5c5665f2686885cddb47dfeabfd77bd5ea5a7060f2092a955a729bbd8834f0d86fa1 + hasown: ^2.0.2 + checksum: 33cfb1ebcb2f869f0bf528be1a8660b4fe8b6cec8fc641f330e508db2284b58ee2980fad6d0828882d22858c759c0806076427a3673b6daa60f753e3b558ee15 languageName: node linkType: hard -"es-to-primitive@npm:^1.2.1": - version: 1.2.1 - resolution: "es-to-primitive@npm:1.2.1" +"es-to-primitive@npm:^1.3.0": + version: 1.3.0 + resolution: "es-to-primitive@npm:1.3.0" dependencies: - is-callable: ^1.1.4 - is-date-object: ^1.0.1 - is-symbol: ^1.0.2 - checksum: 4ead6671a2c1402619bdd77f3503991232ca15e17e46222b0a41a5d81aebc8740a77822f5b3c965008e631153e9ef0580540007744521e72de8e33599fca2eed + is-callable: ^1.2.7 + is-date-object: ^1.0.5 + is-symbol: ^1.0.4 + checksum: 966965880356486cd4d1fe9a523deda2084c81b3702d951212c098f5f2ee93605d1b7c1840062efb48a07d892641c7ed1bc194db563645c0dd2b919cb6d65b93 languageName: node linkType: hard -"es5-ext@npm:^0.10.35, es5-ext@npm:^0.10.46, es5-ext@npm:^0.10.50, es5-ext@npm:^0.10.53, es5-ext@npm:^0.10.62, es5-ext@npm:~0.10.14, es5-ext@npm:~0.10.2, es5-ext@npm:~0.10.46": +"es5-ext@npm:^0.10.35, es5-ext@npm:^0.10.46, es5-ext@npm:^0.10.62, es5-ext@npm:^0.10.64, es5-ext@npm:~0.10.14, es5-ext@npm:~0.10.2": version: 0.10.64 resolution: "es5-ext@npm:0.10.64" dependencies: @@ -9450,12 +9651,12 @@ __metadata: linkType: hard "es6-symbol@npm:^3.1.1, es6-symbol@npm:^3.1.3": - version: 3.1.3 - resolution: "es6-symbol@npm:3.1.3" + version: 3.1.4 + resolution: "es6-symbol@npm:3.1.4" dependencies: - d: ^1.0.1 - ext: ^1.1.2 - checksum: cd49722c2a70f011eb02143ef1c8c70658d2660dead6641e160b94619f408b9cf66425515787ffe338affdf0285ad54f4eae30ea5bd510e33f8659ec53bcaa70 + d: ^1.0.2 + ext: ^1.7.0 + checksum: 52125ec4b5d1b6b93b8d3d42830bb19f8da21080ffcf45253b614bc6ff3e31349be202fb745d4d1af6778cdf5e38fea30e0c7e7dc37e2aecd44acc43502055f9 languageName: node linkType: hard @@ -9471,17 +9672,10 @@ __metadata: languageName: node linkType: hard -"escalade@npm:^3.1.1": - version: 3.1.1 - resolution: "escalade@npm:3.1.1" - checksum: a3e2a99f07acb74b3ad4989c48ca0c3140f69f923e56d0cba0526240ee470b91010f9d39001f2a4a313841d237ede70a729e92125191ba5d21e74b106800b133 - languageName: node - linkType: hard - -"escalade@npm:^3.1.2": - version: 3.1.2 - resolution: "escalade@npm:3.1.2" - checksum: 1ec0977aa2772075493002bdbd549d595ff6e9393b1cb0d7d6fcaf78c750da0c158f180938365486f75cb69fba20294351caddfce1b46552a7b6c3cde52eaa02 +"escalade@npm:^3.1.1, escalade@npm:^3.2.0": + version: 3.2.0 + resolution: "escalade@npm:3.2.0" + checksum: 47b029c83de01b0d17ad99ed766347b974b0d628e848de404018f3abee728e987da0d2d370ad4574aa3d5b5bfc368754fd085d69a30f8e75903486ec4b5b709e languageName: node linkType: hard @@ -9547,13 +9741,12 @@ __metadata: linkType: hard "escodegen@npm:^2.0.0": - version: 2.0.0 - resolution: "escodegen@npm:2.0.0" + version: 2.1.0 + resolution: "escodegen@npm:2.1.0" dependencies: esprima: ^4.0.1 estraverse: ^5.2.0 esutils: ^2.0.2 - optionator: ^0.8.1 source-map: ~0.6.1 dependenciesMeta: source-map: @@ -9561,7 +9754,7 @@ __metadata: bin: escodegen: bin/escodegen.js esgenerate: bin/esgenerate.js - checksum: 5aa6b2966fafe0545e4e77936300cc94ad57cfe4dc4ebff9950492eaba83eef634503f12d7e3cbd644ecc1bab388ad0e92b06fd32222c9281a75d1cf02ec6cef + checksum: 096696407e161305cd05aebb95134ad176708bc5cb13d0dcc89a5fcbb959b8ed757e7f2591a5f8036f8f4952d4a724de0df14cd419e29212729fa6df5ce16bf6 languageName: node linkType: hard @@ -9591,25 +9784,26 @@ __metadata: languageName: node linkType: hard -"eslint-import-resolver-node@npm:^0.3.6": - version: 0.3.6 - resolution: "eslint-import-resolver-node@npm:0.3.6" +"eslint-import-resolver-node@npm:^0.3.9": + version: 0.3.9 + resolution: "eslint-import-resolver-node@npm:0.3.9" dependencies: debug: ^3.2.7 - resolve: ^1.20.0 - checksum: 6266733af1e112970e855a5bcc2d2058fb5ae16ad2a6d400705a86b29552b36131ffc5581b744c23d550de844206fb55e9193691619ee4dbf225c4bde526b1c8 + is-core-module: ^2.13.0 + resolve: ^1.22.4 + checksum: 439b91271236b452d478d0522a44482e8c8540bf9df9bd744062ebb89ab45727a3acd03366a6ba2bdbcde8f9f718bab7fe8db64688aca75acf37e04eafd25e22 languageName: node linkType: hard -"eslint-module-utils@npm:^2.7.3": - version: 2.7.4 - resolution: "eslint-module-utils@npm:2.7.4" +"eslint-module-utils@npm:^2.12.1": + version: 2.12.1 + resolution: "eslint-module-utils@npm:2.12.1" dependencies: debug: ^3.2.7 peerDependenciesMeta: eslint: optional: true - checksum: 5da13645daff145a5c922896b258f8bba560722c3767254e458d894ff5fbb505d6dfd945bffa932a5b0ae06714da2379bd41011c4c20d2d59cc83e23895360f7 + checksum: 2f074670d8c934687820a83140048776b28bbaf35fc37f35623f63cc9c438d496d11f0683b4feabb9a120435435d4a69604b1c6c567f118be2c9a0aba6760fc1 languageName: node linkType: hard @@ -9626,84 +9820,93 @@ __metadata: linkType: hard "eslint-plugin-import@npm:^2.26.0": - version: 2.26.0 - resolution: "eslint-plugin-import@npm:2.26.0" - dependencies: - array-includes: ^3.1.4 - array.prototype.flat: ^1.2.5 - debug: ^2.6.9 + version: 2.32.0 + resolution: "eslint-plugin-import@npm:2.32.0" + dependencies: + "@rtsao/scc": ^1.1.0 + array-includes: ^3.1.9 + array.prototype.findlastindex: ^1.2.6 + array.prototype.flat: ^1.3.3 + array.prototype.flatmap: ^1.3.3 + debug: ^3.2.7 doctrine: ^2.1.0 - eslint-import-resolver-node: ^0.3.6 - eslint-module-utils: ^2.7.3 - has: ^1.0.3 - is-core-module: ^2.8.1 + eslint-import-resolver-node: ^0.3.9 + eslint-module-utils: ^2.12.1 + hasown: ^2.0.2 + is-core-module: ^2.16.1 is-glob: ^4.0.3 minimatch: ^3.1.2 - object.values: ^1.1.5 - resolve: ^1.22.0 - tsconfig-paths: ^3.14.1 + object.fromentries: ^2.0.8 + object.groupby: ^1.0.3 + object.values: ^1.2.1 + semver: ^6.3.1 + string.prototype.trimend: ^1.0.9 + tsconfig-paths: ^3.15.0 peerDependencies: - eslint: ^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8 - checksum: 0bf77ad80339554481eafa2b1967449e1f816b94c7a6f9614ce33fb4083c4e6c050f10d241dd50b4975d47922880a34de1e42ea9d8e6fd663ebb768baa67e655 + eslint: ^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8 || ^9 + checksum: 8cd40595b5e4346d3698eb577014b4b6d0ba57b7b9edf975be4f052a89330ec202d0cc5c3861d37ebeafa151b6264821410243889b0c31710911a6b625bcf76b languageName: node linkType: hard "eslint-plugin-jsx-a11y@npm:^6.5.1": - version: 6.7.1 - resolution: "eslint-plugin-jsx-a11y@npm:6.7.1" - dependencies: - "@babel/runtime": ^7.20.7 - aria-query: ^5.1.3 - array-includes: ^3.1.6 - array.prototype.flatmap: ^1.3.1 - ast-types-flow: ^0.0.7 - axe-core: ^4.6.2 - axobject-query: ^3.1.1 + version: 6.10.2 + resolution: "eslint-plugin-jsx-a11y@npm:6.10.2" + dependencies: + aria-query: ^5.3.2 + array-includes: ^3.1.8 + array.prototype.flatmap: ^1.3.2 + ast-types-flow: ^0.0.8 + axe-core: ^4.10.0 + axobject-query: ^4.1.0 damerau-levenshtein: ^1.0.8 emoji-regex: ^9.2.2 - has: ^1.0.3 - jsx-ast-utils: ^3.3.3 - language-tags: =1.0.5 + hasown: ^2.0.2 + jsx-ast-utils: ^3.3.5 + language-tags: ^1.0.9 minimatch: ^3.1.2 - object.entries: ^1.1.6 - object.fromentries: ^2.0.6 - semver: ^6.3.0 + object.fromentries: ^2.0.8 + safe-regex-test: ^1.0.3 + string.prototype.includes: ^2.0.1 peerDependencies: - eslint: ^3 || ^4 || ^5 || ^6 || ^7 || ^8 - checksum: f166dd5fe7257c7b891c6692e6a3ede6f237a14043ae3d97581daf318fc5833ddc6b4871aa34ab7656187430170500f6d806895747ea17ecdf8231a666c3c2fd + eslint: ^3 || ^4 || ^5 || ^6 || ^7 || ^8 || ^9 + checksum: 0cc861398fa26ada61ed5703eef5b335495fcb96253263dcd5e399488ff019a2636372021baacc040e3560d1a34bfcd5d5ad9f1754f44cd0509c956f7df94050 languageName: node linkType: hard "eslint-plugin-react-hooks@npm:^4.5.0": - version: 4.6.0 - resolution: "eslint-plugin-react-hooks@npm:4.6.0" + version: 4.6.2 + resolution: "eslint-plugin-react-hooks@npm:4.6.2" peerDependencies: eslint: ^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0-0 - checksum: 23001801f14c1d16bf0a837ca7970d9dd94e7b560384b41db378b49b6e32dc43d6e2790de1bd737a652a86f81a08d6a91f402525061b47719328f586a57e86c3 + checksum: 395c433610f59577cfcf3f2e42bcb130436c8a0b3777ac64f441d88c5275f4fcfc89094cedab270f2822daf29af1079151a7a6579a8e9ea8cee66540ba0384c4 languageName: node linkType: hard "eslint-plugin-react@npm:^7.30.1": - version: 7.31.10 - resolution: "eslint-plugin-react@npm:7.31.10" + version: 7.37.5 + resolution: "eslint-plugin-react@npm:7.37.5" dependencies: - array-includes: ^3.1.5 - array.prototype.flatmap: ^1.3.0 + array-includes: ^3.1.8 + array.prototype.findlast: ^1.2.5 + array.prototype.flatmap: ^1.3.3 + array.prototype.tosorted: ^1.1.4 doctrine: ^2.1.0 + es-iterator-helpers: ^1.2.1 estraverse: ^5.3.0 + hasown: ^2.0.2 jsx-ast-utils: ^2.4.1 || ^3.0.0 minimatch: ^3.1.2 - object.entries: ^1.1.5 - object.fromentries: ^2.0.5 - object.hasown: ^1.1.1 - object.values: ^1.1.5 + object.entries: ^1.1.9 + object.fromentries: ^2.0.8 + object.values: ^1.2.1 prop-types: ^15.8.1 - resolve: ^2.0.0-next.3 - semver: ^6.3.0 - string.prototype.matchall: ^4.0.7 + resolve: ^2.0.0-next.5 + semver: ^6.3.1 + string.prototype.matchall: ^4.0.12 + string.prototype.repeat: ^1.0.0 peerDependencies: - eslint: ^3 || ^4 || ^5 || ^6 || ^7 || ^8 - checksum: f013669c296483559a760648fa06425f161b1aff93c668f14c4561c933d22a7836b745b88a795c53cab929c71513d5fd1f2ffdddff915709f01b77ac25f5b71b + eslint: ^3 || ^4 || ^5 || ^6 || ^7 || ^8 || ^9.7 + checksum: 8675e7558e646e3c2fcb04bb60cfe416000b831ef0b363f0117838f5bfc799156113cb06058ad4d4b39fc730903b7360b05038da11093064ca37caf76b7cf2ca languageName: node linkType: hard @@ -9852,11 +10055,11 @@ __metadata: linkType: hard "esquery@npm:^1.4.0": - version: 1.4.0 - resolution: "esquery@npm:1.4.0" + version: 1.7.0 + resolution: "esquery@npm:1.7.0" dependencies: estraverse: ^5.1.0 - checksum: a0807e17abd7fbe5fbd4fab673038d6d8a50675cdae6b04fbaa520c34581be0c5fa24582990e8acd8854f671dd291c78bb2efb9e0ed5b62f33bac4f9cf820210 + checksum: 3239792b68cf39fe18966d0ca01549bb15556734f0144308fd213739b0f153671ae916013fce0bca032044a4dbcda98b43c1c667f20c20a54dec3597ac0d7c27 languageName: node linkType: hard @@ -9883,6 +10086,13 @@ __metadata: languageName: node linkType: hard +"estree-walker@npm:^0.6.1": + version: 0.6.1 + resolution: "estree-walker@npm:0.6.1" + checksum: 9d6f82a4921f11eec18f8089fb3cce6e53bcf45a8e545c42a2674d02d055fb30f25f90495f8be60803df6c39680c80dcee7f944526867eb7aa1fc9254883b23d + languageName: node + linkType: hard + "esutils@npm:^2.0.2": version: 2.0.3 resolution: "esutils@npm:2.0.3" @@ -9924,6 +10134,13 @@ __metadata: languageName: node linkType: hard +"event-target-shim@npm:^5.0.0": + version: 5.0.1 + resolution: "event-target-shim@npm:5.0.1" + checksum: 1ffe3bb22a6d51bdeb6bf6f7cf97d2ff4a74b017ad12284cc9e6a279e727dc30a5de6bb613e5596ff4dc3e517841339ad09a7eec44266eccb1aa201a30448166 + languageName: node + linkType: hard + "eventemitter2@npm:~0.4.13": version: 0.4.14 resolution: "eventemitter2@npm:0.4.14" @@ -9938,7 +10155,7 @@ __metadata: languageName: node linkType: hard -"events@npm:^3.0.0, events@npm:^3.2.0": +"events@npm:^3.0.0, events@npm:^3.2.0, events@npm:^3.3.0": version: 3.3.0 resolution: "events@npm:3.3.0" checksum: f6f487ad2198aa41d878fa31452f1a3c00958f46e9019286ff4787c84aac329332ab45c9cdc8c445928fc6d7ded294b9e005a7fce9426488518017831b272780 @@ -10018,6 +10235,13 @@ __metadata: languageName: node linkType: hard +"exponential-backoff@npm:^3.1.1": + version: 3.1.3 + resolution: "exponential-backoff@npm:3.1.3" + checksum: 471fdb70fd3d2c08a74a026973bdd4105b7832911f610ca67bbb74e39279411c1eed2f2a110c9d41c2edd89459ba58fdaba1c174beed73e7a42d773882dcff82 + languageName: node + linkType: hard + "express-graphql@npm:^0.12.0": version: 0.12.0 resolution: "express-graphql@npm:0.12.0" @@ -10044,45 +10268,45 @@ __metadata: linkType: hard "express@npm:^4.17.1": - version: 4.21.0 - resolution: "express@npm:4.21.0" + version: 4.22.1 + resolution: "express@npm:4.22.1" dependencies: accepts: ~1.3.8 array-flatten: 1.1.1 - body-parser: 1.20.3 - content-disposition: 0.5.4 + body-parser: ~1.20.3 + content-disposition: ~0.5.4 content-type: ~1.0.4 - cookie: 0.6.0 - cookie-signature: 1.0.6 + cookie: ~0.7.1 + cookie-signature: ~1.0.6 debug: 2.6.9 depd: 2.0.0 encodeurl: ~2.0.0 escape-html: ~1.0.3 etag: ~1.8.1 - finalhandler: 1.3.1 - fresh: 0.5.2 - http-errors: 2.0.0 + finalhandler: ~1.3.1 + fresh: ~0.5.2 + http-errors: ~2.0.0 merge-descriptors: 1.0.3 methods: ~1.1.2 - on-finished: 2.4.1 + on-finished: ~2.4.1 parseurl: ~1.3.3 - path-to-regexp: 0.1.10 + path-to-regexp: ~0.1.12 proxy-addr: ~2.0.7 - qs: 6.13.0 + qs: ~6.14.0 range-parser: ~1.2.1 safe-buffer: 5.2.1 - send: 0.19.0 - serve-static: 1.16.2 + send: ~0.19.0 + serve-static: ~1.16.2 setprototypeof: 1.2.0 - statuses: 2.0.1 + statuses: ~2.0.1 type-is: ~1.6.18 utils-merge: 1.0.1 vary: ~1.1.2 - checksum: 1c5212993f665809c249bf00ab550b989d1365a5b9171cdfaa26d93ee2ef10cd8add520861ec8d5da74b3194d8374e1d9d53e85ef69b89fd9c4196b87045a5d4 + checksum: 38fd76585f6a2394e02d499f852fc70c94c9b1527bd5812eb5ee45c23b7f1297baaf13c55162253b14c1e36939b8401429d6594095e63d01ca77447dac72894e languageName: node linkType: hard -"ext@npm:^1.1.2": +"ext@npm:^1.7.0": version: 1.7.0 resolution: "ext@npm:1.7.0" dependencies: @@ -10139,29 +10363,16 @@ __metadata: languageName: node linkType: hard -"fast-glob@npm:^3.2.12": - version: 3.3.2 - resolution: "fast-glob@npm:3.3.2" - dependencies: - "@nodelib/fs.stat": ^2.0.2 - "@nodelib/fs.walk": ^1.2.3 - glob-parent: ^5.1.2 - merge2: ^1.3.0 - micromatch: ^4.0.4 - checksum: 900e4979f4dbc3313840078419245621259f349950411ca2fa445a2f9a1a6d98c3b5e7e0660c5ccd563aa61abe133a21765c6c0dec8e57da1ba71d8000b05ec1 - languageName: node - linkType: hard - -"fast-glob@npm:^3.2.9": - version: 3.2.12 - resolution: "fast-glob@npm:3.2.12" +"fast-glob@npm:^3.2.12, fast-glob@npm:^3.2.9": + version: 3.3.3 + resolution: "fast-glob@npm:3.3.3" dependencies: "@nodelib/fs.stat": ^2.0.2 "@nodelib/fs.walk": ^1.2.3 glob-parent: ^5.1.2 merge2: ^1.3.0 - micromatch: ^4.0.4 - checksum: 0b1990f6ce831c7e28c4d505edcdaad8e27e88ab9fa65eedadb730438cfc7cde4910d6c975d6b7b8dc8a73da4773702ebcfcd6e3518e73938bb1383badfe01c2 + micromatch: ^4.0.8 + checksum: 0704d7b85c0305fd2cef37777337dfa26230fdd072dce9fb5c82a4b03156f3ffb8ed3e636033e65d45d2a5805a4e475825369a27404c0307f2db0c8eb3366fbd languageName: node linkType: hard @@ -10186,6 +10397,24 @@ __metadata: languageName: node linkType: hard +"fast-uri@npm:^3.0.1": + version: 3.1.0 + resolution: "fast-uri@npm:3.1.0" + checksum: daab0efd3548cc53d0db38ecc764d125773f8bd70c34552ff21abdc6530f26fa4cb1771f944222ca5e61a0a1a85d01a104848ff88c61736de445d97bd616ea7e + languageName: node + linkType: hard + +"fast-xml-parser@npm:^4.5.0": + version: 4.5.3 + resolution: "fast-xml-parser@npm:4.5.3" + dependencies: + strnum: ^1.1.1 + bin: + fxparser: src/cli/cli.js + checksum: cd6a184941ec6c23f9e6b514421a3f396cfdff5f4a8c7c27bd0eff896edb4a2b55c27da16f09b789663613dfc4933602b9b71ac3e9d1d2ddcc0492fc46c8fa52 + languageName: node + linkType: hard + "fastest-levenshtein@npm:^1.0.12": version: 1.0.16 resolution: "fastest-levenshtein@npm:1.0.16" @@ -10194,11 +10423,11 @@ __metadata: linkType: hard "fastq@npm:^1.13.0, fastq@npm:^1.6.0": - version: 1.13.0 - resolution: "fastq@npm:1.13.0" + version: 1.20.1 + resolution: "fastq@npm:1.20.1" dependencies: reusify: ^1.0.4 - checksum: 32cf15c29afe622af187d12fc9cd93e160a0cb7c31a3bb6ace86b7dea3b28e7b72acde89c882663f307b2184e14782c6c664fa315973c03626c7d4bff070bb0b + checksum: 49128edbf05e682bee3c1db3d2dfc7da195469065ef014d8368c555d829932313ae2ddf584bb03146409b0d5d9fdb387c471075483a7319b52f777ad91128ed8 languageName: node linkType: hard @@ -10237,8 +10466,8 @@ __metadata: linkType: hard "fbjs@npm:^3.0.0": - version: 3.0.4 - resolution: "fbjs@npm:3.0.4" + version: 3.0.5 + resolution: "fbjs@npm:3.0.5" dependencies: cross-fetch: ^3.1.5 fbjs-css-vars: ^1.0.0 @@ -10246,8 +10475,8 @@ __metadata: object-assign: ^4.1.0 promise: ^7.1.1 setimmediate: ^1.0.5 - ua-parser-js: ^0.7.30 - checksum: 8b23a3550fcda8a9109fca9475a3416590c18bb6825ea884192864ed686f67fcd618e308a140c9e5444fbd0168732e1ff3c092ba3d0c0ae1768969f32ba280c7 + ua-parser-js: ^1.0.35 + checksum: e609b5b64686bc96495a5c67728ed9b2710b9b3d695c5759c5f5e47c9483d1c323543ac777a86459e3694efc5712c6ce7212e944feb19752867d699568bb0e54 languageName: node linkType: hard @@ -10258,6 +10487,18 @@ __metadata: languageName: node linkType: hard +"fdir@npm:^6.5.0": + version: 6.5.0 + resolution: "fdir@npm:6.5.0" + peerDependencies: + picomatch: ^3 || ^4 + peerDependenciesMeta: + picomatch: + optional: true + checksum: bd537daa9d3cd53887eed35efa0eab2dbb1ca408790e10e024120e7a36c6e9ae2b33710cb8381e35def01bc9c1d7eaba746f886338413e68ff6ebaee07b9a6e8 + languageName: node + linkType: hard + "figures@npm:^3.0.0, figures@npm:^3.2.0": version: 3.2.0 resolution: "figures@npm:3.2.0" @@ -10320,6 +10561,13 @@ __metadata: languageName: node linkType: hard +"file-uri-to-path@npm:1.0.0": + version: 1.0.0 + resolution: "file-uri-to-path@npm:1.0.0" + checksum: b648580bdd893a008c92c7ecc96c3ee57a5e7b6c4c18a9a09b44fb5d36d79146f8e442578bc0e173dc027adf3987e254ba1dfd6e3ec998b7c282873010502144 + languageName: node + linkType: hard + "filename-reserved-regex@npm:^2.0.0": version: 2.0.0 resolution: "filename-reserved-regex@npm:2.0.0" @@ -10376,18 +10624,18 @@ __metadata: languageName: node linkType: hard -"finalhandler@npm:1.3.1": - version: 1.3.1 - resolution: "finalhandler@npm:1.3.1" +"finalhandler@npm:~1.3.1": + version: 1.3.2 + resolution: "finalhandler@npm:1.3.2" dependencies: debug: 2.6.9 encodeurl: ~2.0.0 escape-html: ~1.0.3 - on-finished: 2.4.1 + on-finished: ~2.4.1 parseurl: ~1.3.3 - statuses: 2.0.1 + statuses: ~2.0.2 unpipe: ~1.0.0 - checksum: a8c58cd97c9cd47679a870f6833a7b417043f5a288cd6af6d0f49b476c874a506100303a128b6d3b654c3d74fa4ff2ffed68a48a27e8630cda5c918f2977dcf4 + checksum: 4bce6b3e1f6998497a8ef8418bc307ef09daee05acc5a69a36da665565cbeb86218de1932e42dbf2eebf18f580053d2061eddbdeff9e312de45d46fbf4dd36ec languageName: node linkType: hard @@ -10490,42 +10738,43 @@ __metadata: linkType: hard "flat-cache@npm:^3.0.4": - version: 3.0.4 - resolution: "flat-cache@npm:3.0.4" + version: 3.2.0 + resolution: "flat-cache@npm:3.2.0" dependencies: - flatted: ^3.1.0 + flatted: ^3.2.9 + keyv: ^4.5.3 rimraf: ^3.0.2 - checksum: 4fdd10ecbcbf7d520f9040dd1340eb5dfe951e6f0ecf2252edeec03ee68d989ec8b9a20f4434270e71bcfd57800dc09b3344fca3966b2eb8f613072c7d9a2365 + checksum: e7e0f59801e288b54bee5cb9681e9ee21ee28ef309f886b312c9d08415b79fc0f24ac842f84356ce80f47d6a53de62197ce0e6e148dc42d5db005992e2a756ec languageName: node linkType: hard -"flatted@npm:^3.1.0": - version: 3.2.7 - resolution: "flatted@npm:3.2.7" - checksum: 427633049d55bdb80201c68f7eb1cbd533e03eac541f97d3aecab8c5526f12a20ccecaeede08b57503e772c769e7f8680b37e8d482d1e5f8d7e2194687f9ea35 +"flat@npm:^5.0.2": + version: 5.0.2 + resolution: "flat@npm:5.0.2" + bin: + flat: cli.js + checksum: 12a1536ac746db74881316a181499a78ef953632ddd28050b7a3a43c62ef5462e3357c8c29d76072bb635f147f7a9a1f0c02efef6b4be28f8db62ceb3d5c7f5d languageName: node linkType: hard -"follow-redirects@npm:^1.14.0": - version: 1.15.6 - resolution: "follow-redirects@npm:1.15.6" - peerDependenciesMeta: - debug: - optional: true - checksum: a62c378dfc8c00f60b9c80cab158ba54e99ba0239a5dd7c81245e5a5b39d10f0c35e249c3379eae719ff0285fff88c365dd446fab19dee771f1d76252df1bbf5 +"flatted@npm:^3.2.9": + version: 3.3.3 + resolution: "flatted@npm:3.3.3" + checksum: 8c96c02fbeadcf4e8ffd0fa24983241e27698b0781295622591fc13585e2f226609d95e422bcf2ef044146ffacb6b68b1f20871454eddf75ab3caa6ee5f4a1fe languageName: node linkType: hard -"for-each@npm:^0.3.3": - version: 0.3.3 - resolution: "for-each@npm:0.3.3" - dependencies: - is-callable: ^1.1.3 - checksum: 6c48ff2bc63362319c65e2edca4a8e1e3483a2fabc72fbe7feaf8c73db94fc7861bd53bc02c8a66a0c1dd709da6b04eec42e0abdd6b40ce47305ae92a25e5d28 +"follow-redirects@npm:^1.14.0, follow-redirects@npm:^1.15.6": + version: 1.15.11 + resolution: "follow-redirects@npm:1.15.11" + peerDependenciesMeta: + debug: + optional: true + checksum: 20bf55e9504f59e6cc3743ba27edb2ebf41edea1baab34799408f2c050f73f0c612728db21c691276296d2795ea8a812dc532a98e8793619fcab91abe06d017f languageName: node linkType: hard -"for-each@npm:^0.3.5": +"for-each@npm:^0.3.3, for-each@npm:^0.3.5": version: 0.3.5 resolution: "for-each@npm:0.3.5" dependencies: @@ -10558,12 +10807,12 @@ __metadata: linkType: hard "foreground-child@npm:^3.1.0": - version: 3.2.1 - resolution: "foreground-child@npm:3.2.1" + version: 3.3.1 + resolution: "foreground-child@npm:3.3.1" dependencies: - cross-spawn: ^7.0.0 + cross-spawn: ^7.0.6 signal-exit: ^4.0.1 - checksum: 3e2e844d6003c96d70affe8ae98d7eaaba269a868c14d997620c088340a8775cd5d2d9043e6ceebae1928d8d9a874911c4d664b9a267e8995945df20337aebc0 + checksum: b2c1a6fc0bf0233d645d9fefdfa999abf37db1b33e5dab172b3cbfb0662b88bfbd2c9e7ab853533d199050ec6b65c03fcf078fc212d26e4990220e98c6930eef languageName: node linkType: hard @@ -10575,8 +10824,8 @@ __metadata: linkType: hard "fork-ts-checker-webpack-plugin@npm:^6.5.0": - version: 6.5.2 - resolution: "fork-ts-checker-webpack-plugin@npm:6.5.2" + version: 6.5.3 + resolution: "fork-ts-checker-webpack-plugin@npm:6.5.3" dependencies: "@babel/code-frame": ^7.8.3 "@types/json-schema": ^7.0.5 @@ -10601,40 +10850,34 @@ __metadata: optional: true vue-template-compiler: optional: true - checksum: c823de02ee258a26ea5c0c488b2f1825b941f72292417478689862468a9140b209ad7df52f67bd134228fe9f40e9115b604fc8f88a69338929fe52be869469b6 + checksum: 9732a49bfeed8fc23e6e8a59795fa7c238edeba91040a9b520db54b4d316dda27f9f1893d360e296fd0ad8930627d364417d28a8c7007fba60cc730ebfce4956 languageName: node linkType: hard "form-data@npm:^2.2.0": - version: 2.5.1 - resolution: "form-data@npm:2.5.1" - dependencies: - asynckit: ^0.4.0 - combined-stream: ^1.0.6 - mime-types: ^2.1.12 - checksum: 5134ada56cc246b293a1ac7678dba6830000603a3979cf83ff7b2f21f2e3725202237cfb89e32bcb38a1d35727efbd3c3a22e65b42321e8ade8eec01ce755d08 - languageName: node - linkType: hard - -"form-data@npm:^3.0.0": - version: 3.0.1 - resolution: "form-data@npm:3.0.1" + version: 2.5.5 + resolution: "form-data@npm:2.5.5" dependencies: asynckit: ^0.4.0 combined-stream: ^1.0.8 - mime-types: ^2.1.12 - checksum: b019e8d35c8afc14a2bd8a7a92fa4f525a4726b6d5a9740e8d2623c30e308fbb58dc8469f90415a856698933c8479b01646a9dff33c87cc4e76d72aedbbf860d + es-set-tostringtag: ^2.1.0 + hasown: ^2.0.2 + mime-types: ^2.1.35 + safe-buffer: ^5.2.1 + checksum: ba6d8467f959c9bf36a52e423256c1e8055a8e650416760f54fa5db261529c3de698a4ce8378dd4fdb71b44be190906d6b73446556cc74e58de8bda01d09e9e7 languageName: node linkType: hard -"form-data@npm:^4.0.0": - version: 4.0.0 - resolution: "form-data@npm:4.0.0" +"form-data@npm:^4.0.0, form-data@npm:^4.0.4": + version: 4.0.5 + resolution: "form-data@npm:4.0.5" dependencies: asynckit: ^0.4.0 combined-stream: ^1.0.8 + es-set-tostringtag: ^2.1.0 + hasown: ^2.0.2 mime-types: ^2.1.12 - checksum: 01135bf8675f9d5c61ff18e2e2932f719ca4de964e3be90ef4c36aacfc7b9cb2fceb5eca0b7e0190e3383fe51c5b37f4cb80b62ca06a99aaabfcfd6ac7c9328c + checksum: af8328413c16d0cded5fccc975a44d227c5120fd46a9e81de8acf619d43ed838414cc6d7792195b30b248f76a65246949a129a4dadd148721948f90cd6d4fb69 languageName: node linkType: hard @@ -10663,14 +10906,14 @@ __metadata: languageName: node linkType: hard -"fraction.js@npm:^4.2.0": - version: 4.2.0 - resolution: "fraction.js@npm:4.2.0" - checksum: 8c76a6e21dedea87109d6171a0ac77afa14205794a565d71cb10d2925f629a3922da61bf45ea52dbc30bce4d8636dc0a27213a88cbd600eab047d82f9a3a94c5 +"fraction.js@npm:^5.3.4": + version: 5.3.4 + resolution: "fraction.js@npm:5.3.4" + checksum: 6ac88ecfdb5fabe3566ae30f79828d448288efbb852cd43ad83afc961fb6923e1d77bc65fbcba8ccda10894114edd419581a050c73d61e368fdd4c3ff416a65a languageName: node linkType: hard -"fresh@npm:0.5.2": +"fresh@npm:~0.5.2": version: 0.5.2 resolution: "fresh@npm:0.5.2" checksum: 13ea8b08f91e669a64e3ba3a20eb79d7ca5379a81f1ff7f4310d54e2320645503cc0c78daedc93dfb6191287295f6479544a649c64d8e41a1c0fb0c221552346 @@ -10714,19 +10957,19 @@ __metadata: languageName: node linkType: hard -"fs-minipass@npm:^2.0.0, fs-minipass@npm:^2.1.0": - version: 2.1.0 - resolution: "fs-minipass@npm:2.1.0" +"fs-minipass@npm:^3.0.0": + version: 3.0.3 + resolution: "fs-minipass@npm:3.0.3" dependencies: - minipass: ^3.0.0 - checksum: 1b8d128dae2ac6cc94230cc5ead341ba3e0efaef82dab46a33d171c044caaa6ca001364178d42069b2809c35a1c3c35079a32107c770e9ffab3901b59af8c8b1 + minipass: ^7.0.3 + checksum: 8722a41109130851d979222d3ec88aabaceeaaf8f57b2a8f744ef8bd2d1ce95453b04a61daa0078822bc5cd21e008814f06fe6586f56fef511e71b8d2394d802 languageName: node linkType: hard -"fs-monkey@npm:^1.0.3": - version: 1.0.3 - resolution: "fs-monkey@npm:1.0.3" - checksum: cf50804833f9b88a476911ae911fe50f61a98d986df52f890bd97e7262796d023698cb2309fa9b74fdd8974f04315b648748a0a8ee059e7d5257b293bfc409c0 +"fs-monkey@npm:^1.0.4": + version: 1.1.0 + resolution: "fs-monkey@npm:1.1.0" + checksum: ebb6305a37ca4731ffe9aceae21be40992fe5384f7a25819a1d64d17c649e7eeac3fc9ad6269cad6fffc409df0f4583253c93a930549fd82d5f8aed46beb5b9b languageName: node linkType: hard @@ -10738,31 +10981,24 @@ __metadata: linkType: hard "fsevents@npm:~2.3.2": - version: 2.3.2 - resolution: "fsevents@npm:2.3.2" + version: 2.3.3 + resolution: "fsevents@npm:2.3.3" dependencies: node-gyp: latest - checksum: 97ade64e75091afee5265e6956cb72ba34db7819b4c3e94c431d4be2b19b8bb7a2d4116da417950c3425f17c8fe693d25e20212cac583ac1521ad066b77ae31f + checksum: 11e6ea6fea15e42461fc55b4b0e4a0a3c654faa567f1877dbd353f39156f69def97a69936d1746619d656c4b93de2238bf731f6085a03a50cabf287c9d024317 conditions: os=darwin languageName: node linkType: hard "fsevents@patch:fsevents@~2.3.2#~builtin": - version: 2.3.2 - resolution: "fsevents@patch:fsevents@npm%3A2.3.2#~builtin::version=2.3.2&hash=18f3a7" + version: 2.3.3 + resolution: "fsevents@patch:fsevents@npm%3A2.3.3#~builtin::version=2.3.3&hash=18f3a7" dependencies: node-gyp: latest conditions: os=darwin languageName: node linkType: hard -"function-bind@npm:^1.1.1": - version: 1.1.1 - resolution: "function-bind@npm:1.1.1" - checksum: b32fbaebb3f8ec4969f033073b43f5c8befbb58f1a79e12f1d7490358150359ebd92f49e72ff0144f65f2c48ea2a605bff2d07965f548f6474fd8efd95bf361a - languageName: node - linkType: hard - "function-bind@npm:^1.1.2": version: 1.1.2 resolution: "function-bind@npm:1.1.2" @@ -10770,15 +11006,17 @@ __metadata: languageName: node linkType: hard -"function.prototype.name@npm:^1.1.5": - version: 1.1.5 - resolution: "function.prototype.name@npm:1.1.5" +"function.prototype.name@npm:^1.1.6, function.prototype.name@npm:^1.1.8": + version: 1.1.8 + resolution: "function.prototype.name@npm:1.1.8" dependencies: - call-bind: ^1.0.2 - define-properties: ^1.1.3 - es-abstract: ^1.19.0 - functions-have-names: ^1.2.2 - checksum: acd21d733a9b649c2c442f067567743214af5fa248dbeee69d8278ce7df3329ea5abac572be9f7470b4ec1cd4d8f1040e3c5caccf98ebf2bf861a0deab735c27 + call-bind: ^1.0.8 + call-bound: ^1.0.3 + define-properties: ^1.2.1 + functions-have-names: ^1.2.3 + hasown: ^2.0.2 + is-callable: ^1.2.7 + checksum: 3a366535dc08b25f40a322efefa83b2da3cd0f6da41db7775f2339679120ef63b6c7e967266182609e655b8f0a8f65596ed21c7fd72ad8bd5621c2340edd4010 languageName: node linkType: hard @@ -10789,7 +11027,7 @@ __metadata: languageName: node linkType: hard -"functions-have-names@npm:^1.2.2": +"functions-have-names@npm:^1.2.3": version: 1.2.3 resolution: "functions-have-names@npm:1.2.3" checksum: c3f1f5ba20f4e962efb71344ce0a40722163e85bee2101ce25f88214e78182d2d2476aa85ef37950c579eb6cf6ee811c17b3101bb84004bb75655f3e33f3fdb5 @@ -10834,44 +11072,21 @@ __metadata: prompts: ^2.4.2 redux: 4.1.2 resolve-cwd: ^3.0.0 - semver: ^7.3.7 - signal-exit: ^3.0.6 - stack-trace: ^0.0.10 - strip-ansi: ^6.0.1 - update-notifier: ^5.1.0 - yargs: ^15.4.1 - yoga-layout-prebuilt: ^1.10.0 - yurnalist: ^2.1.0 - bin: - gatsby: cli.js - checksum: e7d4253d8ae1bb5a324cf2e4dc167b247a02f42a3ca4bac957d35abf9dad6bbd3c3e252683d7dfe33132adc5b29341438b792a965ec31b0cf5babc49d31259db - languageName: node - linkType: hard - -"gatsby-core-utils@npm:^3.20.0, gatsby-core-utils@npm:^3.21.0, gatsby-core-utils@npm:^3.24.0": - version: 3.24.0 - resolution: "gatsby-core-utils@npm:3.24.0" - dependencies: - "@babel/runtime": ^7.15.4 - ci-info: 2.0.0 - configstore: ^5.0.1 - fastq: ^1.13.0 - file-type: ^16.5.3 - fs-extra: ^10.1.0 - got: ^11.8.5 - import-from: ^4.0.0 - lmdb: 2.5.3 - lock: ^1.1.0 - node-object-hash: ^2.3.10 - proper-lockfile: ^4.1.2 - resolve-from: ^5.0.0 - tmp: ^0.2.1 - xdg-basedir: ^4.0.0 - checksum: 1dfd7bc4b01a99693215bbbd88088f842d6a32228ef2122c1602f9d458c2d04054af467c6c0e5f093986d6271740573b5903ae6bcb2d5b6b0d11ea9c56d4dc8d + semver: ^7.3.7 + signal-exit: ^3.0.6 + stack-trace: ^0.0.10 + strip-ansi: ^6.0.1 + update-notifier: ^5.1.0 + yargs: ^15.4.1 + yoga-layout-prebuilt: ^1.10.0 + yurnalist: ^2.1.0 + bin: + gatsby: cli.js + checksum: e7d4253d8ae1bb5a324cf2e4dc167b247a02f42a3ca4bac957d35abf9dad6bbd3c3e252683d7dfe33132adc5b29341438b792a965ec31b0cf5babc49d31259db languageName: node linkType: hard -"gatsby-core-utils@npm:^3.22.0, gatsby-core-utils@npm:^3.25.0": +"gatsby-core-utils@npm:^3.20.0, gatsby-core-utils@npm:^3.21.0, gatsby-core-utils@npm:^3.22.0, gatsby-core-utils@npm:^3.25.0": version: 3.25.0 resolution: "gatsby-core-utils@npm:3.25.0" dependencies: @@ -10985,8 +11200,8 @@ __metadata: linkType: hard "gatsby-plugin-emotion@npm:^7.23.0": - version: 7.24.0 - resolution: "gatsby-plugin-emotion@npm:7.24.0" + version: 7.25.0 + resolution: "gatsby-plugin-emotion@npm:7.25.0" dependencies: "@babel/runtime": ^7.15.4 "@emotion/babel-preset-css-prop": ^11.2.0 @@ -10994,18 +11209,18 @@ __metadata: "@babel/core": ^7.11.6 "@emotion/react": ^11.0.0 gatsby: ^4.0.0-next - checksum: 87e838896cea016262fad96d401ccea0b7d5da5e917e1772a703f0f39e9dcfe6313f3f46800a3144067b39e225cf43ac0f50d3148f5d747264c54eb87e4db8d1 + checksum: 46bfa7f2866c5f00afe4c1b8c149ce27271062ffaece71e173a4d4fa209ee6431c999d467e0c779b6d5eee68b784ca6b031595c490d2b2de9233fa01312883d1 languageName: node linkType: hard "gatsby-plugin-layout@npm:^3.23.0": - version: 3.24.0 - resolution: "gatsby-plugin-layout@npm:3.24.0" + version: 3.25.0 + resolution: "gatsby-plugin-layout@npm:3.25.0" dependencies: "@babel/runtime": ^7.15.4 peerDependencies: gatsby: ^4.0.0-next - checksum: 2f498589f00be2a5fc8029fd27bc768d3b6d7d48a1d27bcbd9237543d1e312958e8351045bff065e46d0b92e076beb8f473bf3bd2e93f99d08409be9bb31710b + checksum: c82f29c0a051031de4d34c6597995707d1cf0a64edb01ec3c505a2bc41849e004c6ca5090be21af6a3016be87833f681fc24bd6e15e67e5d2ceed5a5227f1987 languageName: node linkType: hard @@ -11098,8 +11313,8 @@ __metadata: linkType: hard "gatsby-plugin-preact@npm:^6.23.0": - version: 6.24.0 - resolution: "gatsby-plugin-preact@npm:6.24.0" + version: 6.25.0 + resolution: "gatsby-plugin-preact@npm:6.25.0" dependencies: "@babel/runtime": ^7.15.4 "@gatsbyjs/webpack-hot-middleware": ^2.25.3 @@ -11109,19 +11324,19 @@ __metadata: gatsby: ^4.0.0-next preact: ^10.3.4 preact-render-to-string: ^5.1.8 - checksum: 3c050fdced9441b24febf4f9601f8f3f2a99a2f7ed7f264ade44a72d3bef5348e95751f86fdf4ff72dd1d47e6db91104582cf94a5d86064aa04f32acbcfaedd6 + checksum: 1acc1b354e133e4f5338e2e3fd6739543ace822f319338701f1bd3e7254e986e04d5ba111f7b2d82b5f85c916267f361204e1032657bb6579bfe277c525daf1f languageName: node linkType: hard "gatsby-plugin-react-helmet@npm:^5.23.0": - version: 5.24.0 - resolution: "gatsby-plugin-react-helmet@npm:5.24.0" + version: 5.25.0 + resolution: "gatsby-plugin-react-helmet@npm:5.25.0" dependencies: "@babel/runtime": ^7.15.4 peerDependencies: gatsby: ^4.0.0-next react-helmet: ^5.1.3 || ^6.0.0 - checksum: 9f9c44b3bc664edecb05e975506de61c5b60cf621a34c9c5c14a8fcc1e7bd7f5ed34e51ce05085fcb1025cc3c95ce9ba6436a9c2125a22bbf357bee7cb2ae22f + checksum: 4373a35a9a254278dc4c1f1516d8550944135cc6ad2c3684b95caee0fd91a55379986e6552ac5f042a582ed43d126d7a4c767b02ad214e83d54194bebbb81c05 languageName: node linkType: hard @@ -11164,7 +11379,7 @@ __metadata: languageName: node linkType: hard -"gatsby-plugin-utils@npm:^3.16.0, gatsby-plugin-utils@npm:^3.19.0": +"gatsby-plugin-utils@npm:^3.16.0, gatsby-plugin-utils@npm:^3.17.0, gatsby-plugin-utils@npm:^3.19.0": version: 3.19.0 resolution: "gatsby-plugin-utils@npm:3.19.0" dependencies: @@ -11184,29 +11399,6 @@ __metadata: languageName: node linkType: hard -"gatsby-plugin-utils@npm:^3.17.0": - version: 3.18.0 - resolution: "gatsby-plugin-utils@npm:3.18.0" - dependencies: - "@babel/runtime": ^7.15.4 - "@gatsbyjs/potrace": ^2.3.0 - fastq: ^1.13.0 - fs-extra: ^10.1.0 - gatsby-core-utils: ^3.24.0 - gatsby-sharp: ^0.18.0 - graphql-compose: ^9.0.7 - import-from: ^4.0.0 - joi: ^17.4.2 - mime: ^3.0.0 - mini-svg-data-uri: ^1.4.4 - svgo: ^2.8.0 - peerDependencies: - gatsby: ^4.0.0-next - graphql: ^15.0.0 - checksum: 34c9e1f9cbe6ecd54dbd1ccd5e57a9129cb14022a8e0c7379abaaa4260b5a6c7014091f72d9b4533e4afbbf2158a17b6058929497d69004e17ad0ec11ee09e50 - languageName: node - linkType: hard - "gatsby-react-router-scroll@npm:^5.22.0": version: 5.25.0 resolution: "gatsby-react-router-scroll@npm:5.25.0" @@ -11222,8 +11414,8 @@ __metadata: linkType: hard "gatsby-remark-autolink-headers@npm:^5.23.0": - version: 5.24.0 - resolution: "gatsby-remark-autolink-headers@npm:5.24.0" + version: 5.25.0 + resolution: "gatsby-remark-autolink-headers@npm:5.25.0" dependencies: "@babel/runtime": ^7.15.4 github-slugger: ^1.3.0 @@ -11234,13 +11426,13 @@ __metadata: gatsby: ^4.0.0-next react: ^16.9.0 || ^17.0.0 || ^18.0.0 || ^0.0.0 react-dom: ^16.9.0 || ^17.0.0 || ^18.0.0 || ^0.0.0 - checksum: 3d2c4a745c419fe64ce1ed9a2290e2e440108e282ea5674e54206316b74980b53e71d3db8ce9ed1cf6243f29aabaf3c836fa5b50a70a8e51b5ba0514fc11da38 + checksum: ccf9e59b3f77f3a073e0252fc5b5ad77164d0a25737675a3d4fbf1eae99000d44764a8a42caf6d7b29aefd52fb8f4303159a121c5697b4441a5107a3b80378b2 languageName: node linkType: hard "gatsby-remark-copy-linked-files@npm:^5.23.0": - version: 5.24.0 - resolution: "gatsby-remark-copy-linked-files@npm:5.24.0" + version: 5.25.0 + resolution: "gatsby-remark-copy-linked-files@npm:5.25.0" dependencies: "@babel/runtime": ^7.15.4 cheerio: ^1.0.0-rc.10 @@ -11252,7 +11444,7 @@ __metadata: unist-util-visit: ^2.0.3 peerDependencies: gatsby: ^4.0.0-next - checksum: af8195a8b29ebfa74d140ed4e4f154b34e9cb5c137fc3590bea33167de3bfe4cc0ea003c7914e51d4562c34cfd2536dcd6db1157b23dd16904658c4e3e91a315 + checksum: 6dac4df2cb13c677f87bb9a077e4a5eaff08dc8dc026faca57d16090d9c8fcdce5c22cb85fbcc62f2ab75ccae9bbf251750338e60b4116830cd975f7b551b656 languageName: node linkType: hard @@ -11300,16 +11492,6 @@ __metadata: languageName: node linkType: hard -"gatsby-sharp@npm:^0.18.0": - version: 0.18.0 - resolution: "gatsby-sharp@npm:0.18.0" - dependencies: - "@types/sharp": ^0.30.5 - sharp: ^0.30.7 - checksum: a236a490c6959e8d877f63e20fb8525bda417dee956bb94c06d420f668f7422165e4e5cae53e0519212d925d58f48e1746300ad9d1347e48932bd5359288206f - languageName: node - linkType: hard - "gatsby-sharp@npm:^0.19.0": version: 0.19.0 resolution: "gatsby-sharp@npm:0.19.0" @@ -11321,14 +11503,14 @@ __metadata: linkType: hard "gatsby-source-filesystem@npm:^4.23.0": - version: 4.24.0 - resolution: "gatsby-source-filesystem@npm:4.24.0" + version: 4.25.0 + resolution: "gatsby-source-filesystem@npm:4.25.0" dependencies: "@babel/runtime": ^7.15.4 chokidar: ^3.5.3 file-type: ^16.5.4 fs-extra: ^10.1.0 - gatsby-core-utils: ^3.24.0 + gatsby-core-utils: ^3.25.0 md5-file: ^5.0.0 mime: ^2.5.2 pretty-bytes: ^5.4.1 @@ -11336,7 +11518,7 @@ __metadata: xstate: 4.32.1 peerDependencies: gatsby: ^4.0.0-next - checksum: 6e45cf46db2862b411db57733276dcecabc869b52b24b43d3643a5132d2b4d682fec589ab9fae7fdf341abcfac995d5849fd98c870070a6d3fcf1f096439e607 + checksum: 73cbcb8b9b439430f87157132d16fc0fc2b7569c57786392e7a290588829b6b3f5ce462c2109e9fab432b60b60340b71e801ad98ba2a0ff835f8100192bb4ce3 languageName: node linkType: hard @@ -11600,22 +11782,6 @@ __metadata: languageName: node linkType: hard -"gauge@npm:^4.0.3": - version: 4.0.4 - resolution: "gauge@npm:4.0.4" - dependencies: - aproba: ^1.0.3 || ^2.0.0 - color-support: ^1.1.3 - console-control-strings: ^1.1.0 - has-unicode: ^2.0.1 - signal-exit: ^3.0.7 - string-width: ^4.2.3 - strip-ansi: ^6.0.1 - wide-align: ^1.1.5 - checksum: 788b6bfe52f1dd8e263cda800c26ac0ca2ff6de0b6eee2fe0d9e3abf15e149b651bd27bf5226be10e6e3edb5c4e5d5985a5a1a98137e7a892f75eff76467ad2d - languageName: node - linkType: hard - "gaze@npm:^1.1.0": version: 1.1.3 resolution: "gaze@npm:1.1.3" @@ -11625,6 +11791,13 @@ __metadata: languageName: node linkType: hard +"generator-function@npm:^2.0.0": + version: 2.0.1 + resolution: "generator-function@npm:2.0.1" + checksum: 3bf87f7b0230de5d74529677e6c3ceb3b7b5d9618b5a22d92b45ce3876defbaf5a77791b25a61b0fa7d13f95675b5ff67a7769f3b9af33f096e34653519e873d + languageName: node + linkType: hard + "gensync@npm:^1.0.0-beta.1, gensync@npm:^1.0.0-beta.2": version: 1.0.0-beta.2 resolution: "gensync@npm:1.0.0-beta.2" @@ -11639,45 +11812,24 @@ __metadata: languageName: node linkType: hard -"get-intrinsic@npm:^1.0.2, get-intrinsic@npm:^1.1.0, get-intrinsic@npm:^1.1.1, get-intrinsic@npm:^1.1.3": - version: 1.1.3 - resolution: "get-intrinsic@npm:1.1.3" - dependencies: - function-bind: ^1.1.1 - has: ^1.0.3 - has-symbols: ^1.0.3 - checksum: 152d79e87251d536cf880ba75cfc3d6c6c50e12b3a64e1ea960e73a3752b47c69f46034456eae1b0894359ce3bc64c55c186f2811f8a788b75b638b06fab228a - languageName: node - linkType: hard - -"get-intrinsic@npm:^1.2.4": - version: 1.2.4 - resolution: "get-intrinsic@npm:1.2.4" - dependencies: - es-errors: ^1.3.0 - function-bind: ^1.1.2 - has-proto: ^1.0.1 - has-symbols: ^1.0.3 - hasown: ^2.0.0 - checksum: 414e3cdf2c203d1b9d7d33111df746a4512a1aa622770b361dadddf8ed0b5aeb26c560f49ca077e24bfafb0acb55ca908d1f709216ccba33ffc548ec8a79a951 - languageName: node - linkType: hard - -"get-intrinsic@npm:^1.3.0": - version: 1.3.0 - resolution: "get-intrinsic@npm:1.3.0" +"get-intrinsic@npm:^1.1.3, get-intrinsic@npm:^1.2.2, get-intrinsic@npm:^1.2.4, get-intrinsic@npm:^1.2.5, get-intrinsic@npm:^1.2.6, get-intrinsic@npm:^1.2.7, get-intrinsic@npm:^1.3.0": + version: 1.3.1 + resolution: "get-intrinsic@npm:1.3.1" dependencies: + async-function: ^1.0.0 + async-generator-function: ^1.0.0 call-bind-apply-helpers: ^1.0.2 es-define-property: ^1.0.1 es-errors: ^1.3.0 es-object-atoms: ^1.1.1 function-bind: ^1.1.2 + generator-function: ^2.0.0 get-proto: ^1.0.1 gopd: ^1.2.0 has-symbols: ^1.1.0 hasown: ^2.0.2 math-intrinsics: ^1.1.0 - checksum: 301008e4482bb9a9cb49e132b88fee093bff373b4e6def8ba219b1e96b60158a6084f273ef5cafe832e42cd93462f4accb46a618d35fe59a2b507f2388c5b79d + checksum: c02b3b6a445f9cd53e14896303794ac60f9751f58a69099127248abdb0251957174c6524245fc68579dc8e6a35161d3d94c93e665f808274716f4248b269436a languageName: node linkType: hard @@ -11688,7 +11840,7 @@ __metadata: languageName: node linkType: hard -"get-proto@npm:^1.0.1": +"get-proto@npm:^1.0.0, get-proto@npm:^1.0.1": version: 1.0.1 resolution: "get-proto@npm:1.0.1" dependencies: @@ -11723,13 +11875,14 @@ __metadata: languageName: node linkType: hard -"get-symbol-description@npm:^1.0.0": - version: 1.0.0 - resolution: "get-symbol-description@npm:1.0.0" +"get-symbol-description@npm:^1.1.0": + version: 1.1.0 + resolution: "get-symbol-description@npm:1.1.0" dependencies: - call-bind: ^1.0.2 - get-intrinsic: ^1.1.1 - checksum: 9ceff8fe968f9270a37a1f73bf3f1f7bda69ca80f4f80850670e0e7b9444ff99323f7ac52f96567f8b5f5fbe7ac717a0d81d3407c7313e82810c6199446a5247 + call-bound: ^1.0.3 + es-errors: ^1.3.0 + get-intrinsic: ^1.2.6 + checksum: 655ed04db48ee65ef2ddbe096540d4405e79ba0a7f54225775fef43a7e2afcb93a77d141c5f05fdef0afce2eb93bcbfb3597142189d562ac167ff183582683cd languageName: node linkType: hard @@ -11807,8 +11960,8 @@ __metadata: linkType: hard "glob@npm:^10.0.0, glob@npm:^10.2.2, glob@npm:^10.3.3": - version: 10.4.5 - resolution: "glob@npm:10.4.5" + version: 10.5.0 + resolution: "glob@npm:10.5.0" dependencies: foreground-child: ^3.1.0 jackspeak: ^3.1.2 @@ -11818,11 +11971,22 @@ __metadata: path-scurry: ^1.11.1 bin: glob: dist/esm/bin.mjs - checksum: 0bc725de5e4862f9f387fd0f2b274baf16850dcd2714502ccf471ee401803997983e2c05590cb65f9675a3c6f2a58e7a53f9e365704108c6ad3cbf1d60934c4a + checksum: cda96c074878abca9657bd984d2396945cf0d64283f6feeb40d738fe2da642be0010ad5210a1646244a5fc3511b0cab5a374569b3de5a12b8a63d392f18c6043 + languageName: node + linkType: hard + +"glob@npm:^13.0.0": + version: 13.0.0 + resolution: "glob@npm:13.0.0" + dependencies: + minimatch: ^10.1.1 + minipass: ^7.1.2 + path-scurry: ^2.0.0 + checksum: 963730222b0acc85a0d2616c08ba3a5d5b5f33fbf69182791967b8a02245db505577a6fc19836d5d58e1cbbfb414ad4f62f605a0372ab05cd9e6998efe944369 languageName: node linkType: hard -"glob@npm:^7.1.1, glob@npm:^7.1.2, glob@npm:^7.1.3, glob@npm:^7.1.4, glob@npm:^7.1.6, glob@npm:^7.2.3": +"glob@npm:^7.1.1, glob@npm:^7.1.2, glob@npm:^7.1.3, glob@npm:^7.1.6, glob@npm:^7.2.3": version: 7.2.3 resolution: "glob@npm:7.2.3" dependencies: @@ -11836,19 +12000,6 @@ __metadata: languageName: node linkType: hard -"glob@npm:^8.0.1": - version: 8.0.3 - resolution: "glob@npm:8.0.3" - dependencies: - fs.realpath: ^1.0.0 - inflight: ^1.0.4 - inherits: 2 - minimatch: ^5.0.1 - once: ^1.3.0 - checksum: 50bcdea19d8e79d8de5f460b1939ffc2b3299eac28deb502093fdca22a78efebc03e66bf54f0abc3d3d07d8134d19a32850288b7440d77e072aa55f9d33b18c5 - languageName: node - linkType: hard - "glob@npm:~5.0.0": version: 5.0.15 resolution: "glob@npm:5.0.15" @@ -11877,11 +12028,11 @@ __metadata: linkType: hard "global-dirs@npm:^3.0.0": - version: 3.0.0 - resolution: "global-dirs@npm:3.0.0" + version: 3.0.1 + resolution: "global-dirs@npm:3.0.1" dependencies: ini: 2.0.0 - checksum: 953c17cf14bf6ee0e2100ae82a0d779934eed8a3ec5c94a7a4f37c5b3b592c31ea015fb9a15cf32484de13c79f4a814f3015152f3e1d65976cfbe47c1bfe4a88 + checksum: 70147b80261601fd40ac02a104581432325c1c47329706acd773f3a6ce99bb36d1d996038c85ccacd482ad22258ec233c586b6a91535b1a116b89663d49d6438 languageName: node linkType: hard @@ -11939,19 +12090,22 @@ __metadata: languageName: node linkType: hard -"globals@npm:^11.1.0": - version: 11.12.0 - resolution: "globals@npm:11.12.0" - checksum: 67051a45eca3db904aee189dfc7cd53c20c7d881679c93f6146ddd4c9f4ab2268e68a919df740d39c71f4445d2b38ee360fc234428baea1dbdfe68bbcb46979e +"globals@npm:^13.2.0, globals@npm:^13.6.0, globals@npm:^13.9.0": + version: 13.24.0 + resolution: "globals@npm:13.24.0" + dependencies: + type-fest: ^0.20.2 + checksum: 56066ef058f6867c04ff203b8a44c15b038346a62efbc3060052a1016be9f56f4cf0b2cd45b74b22b81e521a889fc7786c73691b0549c2f3a6e825b3d394f43c languageName: node linkType: hard -"globals@npm:^13.2.0, globals@npm:^13.6.0, globals@npm:^13.9.0": - version: 13.17.0 - resolution: "globals@npm:13.17.0" +"globalthis@npm:^1.0.4": + version: 1.0.4 + resolution: "globalthis@npm:1.0.4" dependencies: - type-fest: ^0.20.2 - checksum: fbaf4112e59b92c9f5575e85ce65e9e17c0b82711196ec5f58beb08599bbd92fd72703d6dfc9b080381fd35b644e1b11dcf25b38cc2341ec21df942594cbc8ce + define-properties: ^1.2.1 + gopd: ^1.0.1 + checksum: 39ad667ad9f01476474633a1834a70842041f70a55571e8dcef5fb957980a92da5022db5430fca8aecc5d47704ae30618c0bc877a579c70710c904e9ef06108a languageName: node linkType: hard @@ -11980,16 +12134,7 @@ __metadata: languageName: node linkType: hard -"gopd@npm:^1.0.1": - version: 1.0.1 - resolution: "gopd@npm:1.0.1" - dependencies: - get-intrinsic: ^1.1.3 - checksum: a5ccfb8806e0917a94e0b3de2af2ea4979c1da920bc381667c260e00e7cafdbe844e2cb9c5bcfef4e5412e8bf73bab837285bc35c7ba73aaaf0134d4583393a6 - languageName: node - linkType: hard - -"gopd@npm:^1.2.0": +"gopd@npm:^1.0.1, gopd@npm:^1.2.0": version: 1.2.0 resolution: "gopd@npm:1.2.0" checksum: cc6d8e655e360955bdccaca51a12a474268f95bb793fc3e1f2bdadb075f28bfd1fd988dab872daf77a61d78cbaf13744bc8727a17cfb1d150d76047d805375f3 @@ -11997,8 +12142,8 @@ __metadata: linkType: hard "got@npm:^11.8.5": - version: 11.8.5 - resolution: "got@npm:11.8.5" + version: 11.8.6 + resolution: "got@npm:11.8.6" dependencies: "@sindresorhus/is": ^4.0.0 "@szmarczak/http-timer": ^4.0.5 @@ -12011,7 +12156,7 @@ __metadata: lowercase-keys: ^2.0.0 p-cancelable: ^2.0.0 responselike: ^2.0.0 - checksum: 2de8a1bbda4e9b6b2b72b2d2100bc055a59adc1740529e631f61feb44a8b9a1f9f8590941ed9da9df0090b6d6d0ed8ffee94cd9ac086ec3409b392b33440f7d2 + checksum: bbc783578a8d5030c8164ef7f57ce41b5ad7db2ed13371e1944bef157eeca5a7475530e07c0aaa71610d7085474d0d96222c9f4268d41db333a17e39b463f45d languageName: node linkType: hard @@ -12034,14 +12179,7 @@ __metadata: languageName: node linkType: hard -"graceful-fs@npm:^4.1.2, graceful-fs@npm:^4.1.6, graceful-fs@npm:^4.2.0, graceful-fs@npm:^4.2.3, graceful-fs@npm:^4.2.4, graceful-fs@npm:^4.2.6": - version: 4.2.10 - resolution: "graceful-fs@npm:4.2.10" - checksum: 3f109d70ae123951905d85032ebeae3c2a5a7a997430df00ea30df0e3a6c60cf6689b109654d6fdacd28810a053348c4d14642da1d075049e6be1ba5216218da - languageName: node - linkType: hard - -"graceful-fs@npm:^4.2.11, graceful-fs@npm:~4.2.10": +"graceful-fs@npm:^4.1.15, graceful-fs@npm:^4.1.2, graceful-fs@npm:^4.1.6, graceful-fs@npm:^4.2.0, graceful-fs@npm:^4.2.11, graceful-fs@npm:^4.2.3, graceful-fs@npm:^4.2.4, graceful-fs@npm:^4.2.6, graceful-fs@npm:~4.2.10": version: 4.2.11 resolution: "graceful-fs@npm:4.2.11" checksum: ac85f94da92d8eb6b7f5a8b20ce65e43d66761c55ce85ac96df6865308390da45a8d3f0296dd3a663de65d30ba497bd46c696cc1e248c72b13d6d567138a4fc7 @@ -12049,11 +12187,13 @@ __metadata: linkType: hard "graphql-compose@npm:^9.0.7": - version: 9.0.10 - resolution: "graphql-compose@npm:9.0.10" + version: 9.1.0 + resolution: "graphql-compose@npm:9.1.0" dependencies: graphql-type-json: 0.3.2 - checksum: 46c566470a41d9ed5065b2ac2c50c870d34e5d03fff7eaa71cf10212a6492d1eef8a6ed9df012fbbfc85fa587eddbf498ce115015b075630f2c4168fcd447810 + peerDependencies: + graphql: ^14.2.0 || ^15.0.0 || ^16.0.0 + checksum: 4266bf486ff708cbc1ea73371edc1723e33ea81f5abbc6c2f4b335a3316181ad0f8b859cee8bd905180fbcc13bcabb5369a446d802730f3976c1786e8aebd997 languageName: node linkType: hard @@ -12088,13 +12228,13 @@ __metadata: linkType: hard "graphql-scalars@npm:^1.15.0": - version: 1.20.1 - resolution: "graphql-scalars@npm:1.20.1" + version: 1.25.0 + resolution: "graphql-scalars@npm:1.25.0" dependencies: - tslib: ~2.4.0 + tslib: ^2.5.0 peerDependencies: graphql: ^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 - checksum: 4d3d3f804a31e8db76feb51f089f5e1a0fceacbd98390c0c7b825707bdd7d53754496fa178f47139fa92ba2598605f47a61adbc92bf6f292293c78eb18865e4c + checksum: 8894790f87ffe19c4a787023c37c1dc176fafe5eba98cd9c3e966510b468a413ea536af88e63bf923ffbcc25cd82fbae9054b4a97ac278ed182f50f4e0c011e8 languageName: node linkType: hard @@ -12126,9 +12266,9 @@ __metadata: linkType: hard "graphql@npm:^16.3.0": - version: 16.6.0 - resolution: "graphql@npm:16.6.0" - checksum: bf1d9e3c1938ce3c1a81e909bd3ead1ae4707c577f91cff1ca2eca474bfbc7873d5d7b942e1e9777ff5a8304421dba57a4b76d7a29eb19de8711cb70e3c2415e + version: 16.12.0 + resolution: "graphql@npm:16.12.0" + checksum: c0d2435425270c575091861c9fd82d7cebc1fb1bd5461e05c36521a988f69c5074461e27b89ab70851fabc72ec9d988235f288ba7bbeff67d08a973e8b9d6d3d languageName: node linkType: hard @@ -12184,8 +12324,8 @@ __metadata: linkType: hard "grunt-contrib-connect@npm:^5.0.0": - version: 5.0.0 - resolution: "grunt-contrib-connect@npm:5.0.0" + version: 5.0.1 + resolution: "grunt-contrib-connect@npm:5.0.1" dependencies: async: ^3.2.5 connect: ^3.7.0 @@ -12196,7 +12336,7 @@ __metadata: portscanner: ^2.2.0 serve-index: ^1.9.1 serve-static: ^1.15.0 - checksum: dd58c786a5fad49480f8c1474e4da46d4576ee0827842452a27be2c172848c96b60657b1386f5c365fdea7bc5afed1b5110cbfdf11c8818d42a5f47e46301f8f + checksum: b93ba1dd12884c60e2bc583667a94aae7c5a2ca74fbdbb1e95b0a77bd867e16d647984dca6d5da4256d4268edfdaa40d294a2ee456932c09dce98c0238cfe8b3 languageName: node linkType: hard @@ -12343,11 +12483,11 @@ __metadata: linkType: hard "handlebars@npm:^4.7.7": - version: 4.7.7 - resolution: "handlebars@npm:4.7.7" + version: 4.7.8 + resolution: "handlebars@npm:4.7.8" dependencies: minimist: ^1.2.5 - neo-async: ^2.6.0 + neo-async: ^2.6.2 source-map: ^0.6.1 uglify-js: ^3.1.4 wordwrap: ^1.0.0 @@ -12356,7 +12496,7 @@ __metadata: optional: true bin: handlebars: bin/handlebars - checksum: 1e79a43f5e18d15742977cb987923eab3e2a8f44f2d9d340982bcb69e1735ed049226e534d7c1074eaddaf37e4fb4f471a8adb71cddd5bc8cf3f894241df5cee + checksum: 00e68bb5c183fd7b8b63322e6234b5ac8fbb960d712cb3f25587d559c2951d9642df83c04a1172c918c41bcfc81bfbd7a7718bbce93b893e0135fc99edea93ff languageName: node linkType: hard @@ -12386,10 +12526,10 @@ __metadata: languageName: node linkType: hard -"has-bigints@npm:^1.0.1, has-bigints@npm:^1.0.2": - version: 1.0.2 - resolution: "has-bigints@npm:1.0.2" - checksum: 390e31e7be7e5c6fe68b81babb73dfc35d413604d7ee5f56da101417027a4b4ce6a27e46eff97ad040c835b5d228676eae99a9b5c3bc0e23c8e81a49241ff45b +"has-bigints@npm:^1.0.2": + version: 1.1.0 + resolution: "has-bigints@npm:1.1.0" + checksum: 79730518ae02c77e4af6a1d1a0b6a2c3e1509785532771f9baf0241e83e36329542c3d7a0e723df8cbc85f74eff4f177828a2265a01ba576adbdc2d40d86538b languageName: node linkType: hard @@ -12414,16 +12554,7 @@ __metadata: languageName: node linkType: hard -"has-property-descriptors@npm:^1.0.0": - version: 1.0.0 - resolution: "has-property-descriptors@npm:1.0.0" - dependencies: - get-intrinsic: ^1.1.1 - checksum: a6d3f0a266d0294d972e354782e872e2fe1b6495b321e6ef678c9b7a06a40408a6891817350c62e752adced73a94ac903c54734fee05bf65b1905ee1368194bb - languageName: node - linkType: hard - -"has-property-descriptors@npm:^1.0.2": +"has-property-descriptors@npm:^1.0.0, has-property-descriptors@npm:^1.0.2": version: 1.0.2 resolution: "has-property-descriptors@npm:1.0.2" dependencies: @@ -12432,36 +12563,22 @@ __metadata: languageName: node linkType: hard -"has-proto@npm:^1.0.1": - version: 1.0.3 - resolution: "has-proto@npm:1.0.3" - checksum: fe7c3d50b33f50f3933a04413ed1f69441d21d2d2944f81036276d30635cad9279f6b43bc8f32036c31ebdfcf6e731150f46c1907ad90c669ffe9b066c3ba5c4 - languageName: node - linkType: hard - -"has-symbols@npm:^1.0.1, has-symbols@npm:^1.0.2, has-symbols@npm:^1.0.3": - version: 1.0.3 - resolution: "has-symbols@npm:1.0.3" - checksum: a054c40c631c0d5741a8285010a0777ea0c068f99ed43e5d6eb12972da223f8af553a455132fdb0801bdcfa0e0f443c0c03a68d8555aa529b3144b446c3f2410 +"has-proto@npm:^1.2.0": + version: 1.2.0 + resolution: "has-proto@npm:1.2.0" + dependencies: + dunder-proto: ^1.0.0 + checksum: f55010cb94caa56308041d77967c72a02ffd71386b23f9afa8447e58bc92d49d15c19bf75173713468e92fe3fb1680b03b115da39c21c32c74886d1d50d3e7ff languageName: node linkType: hard -"has-symbols@npm:^1.1.0": +"has-symbols@npm:^1.0.3, has-symbols@npm:^1.1.0": version: 1.1.0 resolution: "has-symbols@npm:1.1.0" checksum: b2316c7302a0e8ba3aaba215f834e96c22c86f192e7310bdf689dd0e6999510c89b00fbc5742571507cebf25764d68c988b3a0da217369a73596191ac0ce694b languageName: node linkType: hard -"has-tostringtag@npm:^1.0.0": - version: 1.0.0 - resolution: "has-tostringtag@npm:1.0.0" - dependencies: - has-symbols: ^1.0.2 - checksum: cc12eb28cb6ae22369ebaad3a8ab0799ed61270991be88f208d508076a1e99abe4198c965935ce85ea90b60c94ddda73693b0920b58e7ead048b4a391b502c1c - languageName: node - linkType: hard - "has-tostringtag@npm:^1.0.2": version: 1.0.2 resolution: "has-tostringtag@npm:1.0.2" @@ -12471,13 +12588,6 @@ __metadata: languageName: node linkType: hard -"has-unicode@npm:^2.0.1": - version: 2.0.1 - resolution: "has-unicode@npm:2.0.1" - checksum: 1eab07a7436512db0be40a710b29b5dc21fa04880b7f63c9980b706683127e3c1b57cb80ea96d47991bdae2dfe479604f6a1ba410106ee1046a41d1bd0814400 - languageName: node - linkType: hard - "has-yarn@npm:^2.1.0": version: 2.1.0 resolution: "has-yarn@npm:2.1.0" @@ -12485,42 +12595,25 @@ __metadata: languageName: node linkType: hard -"has@npm:^1.0.3": - version: 1.0.3 - resolution: "has@npm:1.0.3" - dependencies: - function-bind: ^1.1.1 - checksum: b9ad53d53be4af90ce5d1c38331e712522417d017d5ef1ebd0507e07c2fbad8686fffb8e12ddecd4c39ca9b9b47431afbb975b8abf7f3c3b82c98e9aad052792 - languageName: node - linkType: hard - -"hash-base@npm:^2.0.0": - version: 2.0.2 - resolution: "hash-base@npm:2.0.2" - dependencies: - inherits: ^2.0.1 - checksum: e39f3f2bb91679ed350bd2eb81035acb1e1e6e9bb86d9f1197fcfdc3cf39a2c56bf82a1870f000fae651477883b4c107fd6ac0c640a18ab06298b87c39939396 - languageName: node - linkType: hard - -"hash-base@npm:^3.0.0": - version: 3.1.0 - resolution: "hash-base@npm:3.1.0" +"hash-base@npm:^3.0.0, hash-base@npm:^3.1.2": + version: 3.1.2 + resolution: "hash-base@npm:3.1.2" dependencies: inherits: ^2.0.4 - readable-stream: ^3.6.0 - safe-buffer: ^5.2.0 - checksum: 26b7e97ac3de13cb23fc3145e7e3450b0530274a9562144fc2bf5c1e2983afd0e09ed7cc3b20974ba66039fad316db463da80eb452e7373e780cbee9a0d2f2dc + readable-stream: ^2.3.8 + safe-buffer: ^5.2.1 + to-buffer: ^1.2.1 + checksum: ca7c548098ca2aa3616f8ddb0406c9cadd0fbc35868d885200692b13a3b6d5b30e2b55ab808ff6000c69f11b3c26fd98e5955b1484d79a59fbd07d1d6b65ca4b languageName: node linkType: hard -"hash-base@npm:~3.0": - version: 3.0.4 - resolution: "hash-base@npm:3.0.4" +"hash-base@npm:~3.0.4": + version: 3.0.5 + resolution: "hash-base@npm:3.0.5" dependencies: - inherits: ^2.0.1 - safe-buffer: ^5.0.1 - checksum: 878465a0dfcc33cce195c2804135352c590d6d10980adc91a9005fd377e77f2011256c2b7cfce472e3f2e92d561d1bf3228d2da06348a9017ce9a258b3b49764 + inherits: ^2.0.4 + safe-buffer: ^5.2.1 + checksum: 6a82675a5de2ea9347501bbe655a2334950c7ec972fd9810ae9529e06aeab8f7e8ef68fc2112e5e6f0745561a7e05326efca42ad59bb5fd116537f5f8b0a216d languageName: node linkType: hard @@ -12544,7 +12637,7 @@ __metadata: languageName: node linkType: hard -"hasown@npm:^2.0.0, hasown@npm:^2.0.2": +"hasown@npm:^2.0.2": version: 2.0.2 resolution: "hasown@npm:2.0.2" dependencies: @@ -12583,18 +12676,18 @@ __metadata: linkType: hard "hast-util-has-property@npm:^2.0.0": - version: 2.0.0 - resolution: "hast-util-has-property@npm:2.0.0" - checksum: 6f35c11445a02927a731c34cadce81d1b01db814e336d61624c9a9f78440e555bf1819ea340964f0c283f47aa9c1f50fcd94c1b13f2c73e53bd820efca55f79a + version: 2.0.1 + resolution: "hast-util-has-property@npm:2.0.1" + checksum: cc909b7e2964fbfa4c53e33bfbc6f3ed883d1936f3e41a7fa020d3cb8cc5d3c903670e62bec15b55dea5a272ed86724815e8b136ba5475e138489384b1b71fa8 languageName: node linkType: hard "hast-util-heading-rank@npm:^2.0.0": - version: 2.1.0 - resolution: "hast-util-heading-rank@npm:2.1.0" + version: 2.1.1 + resolution: "hast-util-heading-rank@npm:2.1.1" dependencies: "@types/hast": ^2.0.0 - checksum: 6b0f66bf411cde4bc33f2bb80081cc9be2b7f86aa85a996a4766970ae34510824a93ea774c0ac1f5695b906f27358829939cc38bd7fc6b2965b78c226b82cb3a + checksum: a49233e9ac78f66e948dd29d6c75f41c72899854f276290423c5f59eb827dee3c42cf181ce9103f3a8295359b613ca0b9c51475dd38ecdd6c26ed291344061f1 languageName: node linkType: hard @@ -12739,9 +12832,9 @@ __metadata: linkType: hard "highlight.js@npm:^11.4.0": - version: 11.6.0 - resolution: "highlight.js@npm:11.6.0" - checksum: 3908eb34a4b442ca1e20c1ae6415ea935fbbcdb2b532a89948d82b0fa4ad41fc5de3802a0de4e88a0bcb7d97d4445579048cd2aab1d105ac47f59dd58a9a98ae + version: 11.11.1 + resolution: "highlight.js@npm:11.11.1" + checksum: 841ddd329a92be123a61ef4051698f824c3575deef588fbb810bd638f1575ddc96b7bdd925b97c05a29276bb119dfcb8e5bcb0acb31c86249371bf046e131d72 languageName: node linkType: hard @@ -12818,9 +12911,9 @@ __metadata: linkType: hard "html-entities@npm:^2.1.0, html-entities@npm:^2.3.3": - version: 2.3.3 - resolution: "html-entities@npm:2.3.3" - checksum: 92521501da8aa5f66fee27f0f022d6e9ceae62667dae93aa6a2f636afa71ad530b7fb24a18d4d6c124c9885970cac5f8a52dbf1731741161002816ae43f98196 + version: 2.6.0 + resolution: "html-entities@npm:2.6.0" + checksum: 720643f7954019c80911430a7df2728524c07080edfe812610bfc5d8191cd772b470bee0ee151bf7426679314ae53cf28a1c845d702123714e625a8565b26567 languageName: node linkType: hard @@ -12831,6 +12924,18 @@ __metadata: languageName: node linkType: hard +"htmlparser2@npm:^10.0.0": + version: 10.0.0 + resolution: "htmlparser2@npm:10.0.0" + dependencies: + domelementtype: ^2.3.0 + domhandler: ^5.0.3 + domutils: ^3.2.1 + entities: ^6.0.0 + checksum: ba81aca5d344437e791ffddf61d498972fc0e7dd2d41f59f920e93aedb64667a0f38fed88e0d81fe23ea5a10825991caa020212fdd72a0dc287ab2aaad95fbf5 + languageName: node + linkType: hard + "htmlparser2@npm:^3.9.1": version: 3.10.1 resolution: "htmlparser2@npm:3.10.1" @@ -12870,14 +12975,14 @@ __metadata: linkType: hard "htmlparser2@npm:^8.0.1": - version: 8.0.1 - resolution: "htmlparser2@npm:8.0.1" + version: 8.0.2 + resolution: "htmlparser2@npm:8.0.2" dependencies: domelementtype: ^2.3.0 - domhandler: ^5.0.2 + domhandler: ^5.0.3 domutils: ^3.0.1 - entities: ^4.3.0 - checksum: 06d5c71e8313597722bc429ae2a7a8333d77bd3ab07ccb916628384b37332027b047f8619448d8f4a3312b6609c6ea3302a4e77435d859e9e686999e6699ca39 + entities: ^4.4.0 + checksum: 29167a0f9282f181da8a6d0311b76820c8a59bc9e3c87009e21968264c2987d2723d6fde5a964d4b7b6cba663fca96ffb373c06d8223a85f52a6089ced942700 languageName: node linkType: hard @@ -12905,10 +13010,10 @@ __metadata: languageName: node linkType: hard -"http-cache-semantics@npm:^4.0.0, http-cache-semantics@npm:^4.1.0": - version: 4.1.1 - resolution: "http-cache-semantics@npm:4.1.1" - checksum: 83ac0bc60b17a3a36f9953e7be55e5c8f41acc61b22583060e8dedc9dd5e3607c823a88d0926f9150e571f90946835c7fe150732801010845c72cd8bbff1a236 +"http-cache-semantics@npm:^4.0.0, http-cache-semantics@npm:^4.1.1": + version: 4.2.0 + resolution: "http-cache-semantics@npm:4.2.0" + checksum: 7a7246ddfce629f96832791176fd643589d954e6f3b49548dadb4290451961237fab8fcea41cd2008fe819d95b41c1e8b97f47d088afc0a1c81705287b4ddbcc languageName: node linkType: hard @@ -12925,19 +13030,6 @@ __metadata: languageName: node linkType: hard -"http-errors@npm:2.0.0": - version: 2.0.0 - resolution: "http-errors@npm:2.0.0" - dependencies: - depd: 2.0.0 - inherits: 2.0.4 - setprototypeof: 1.2.0 - statuses: 2.0.1 - toidentifier: 1.0.1 - checksum: 9b0a3782665c52ce9dc658a0d1560bcb0214ba5699e4ea15aefb2a496e2ca83db03ebc42e1cce4ac1f413e4e0d2d736a3fd755772c556a9a06853ba2a0b7d920 - languageName: node - linkType: hard - "http-errors@npm:~1.6.2": version: 1.6.3 resolution: "http-errors@npm:1.6.3" @@ -12950,10 +13042,23 @@ __metadata: languageName: node linkType: hard +"http-errors@npm:~2.0.0, http-errors@npm:~2.0.1": + version: 2.0.1 + resolution: "http-errors@npm:2.0.1" + dependencies: + depd: ~2.0.0 + inherits: ~2.0.4 + setprototypeof: ~1.2.0 + statuses: ~2.0.2 + toidentifier: ~1.0.1 + checksum: 155d1a100a06e4964597013109590b97540a177b69c3600bbc93efc746465a99a2b718f43cdf76b3791af994bbe3a5711002046bf668cdc007ea44cea6df7ccd + languageName: node + linkType: hard + "http-parser-js@npm:>=0.5.1": - version: 0.5.8 - resolution: "http-parser-js@npm:0.5.8" - checksum: 6bbdf2429858e8cf13c62375b0bfb6dc3955ca0f32e58237488bc86cd2378f31d31785fd3ac4ce93f1c74e0189cf8823c91f5cb061696214fd368d2452dc871d + version: 0.5.10 + resolution: "http-parser-js@npm:0.5.10" + checksum: 1038177c5f114860345ce7c19223d2cdd9a103265bd897bab13343c9eff4deef60f7956a674485f1234ffc9b19fb4b97f0c20a5848cfc9ccbf5d3c438d89ae89 languageName: node linkType: hard @@ -12968,6 +13073,16 @@ __metadata: languageName: node linkType: hard +"http-proxy-agent@npm:^7.0.0": + version: 7.0.2 + resolution: "http-proxy-agent@npm:7.0.2" + dependencies: + agent-base: ^7.1.0 + debug: ^4.3.4 + checksum: 670858c8f8f3146db5889e1fa117630910101db601fff7d5a8aa637da0abedf68c899f03d3451cac2f83bcc4c3d2dabf339b3aa00ff8080571cceb02c3ce02f3 + languageName: node + linkType: hard + "http-response-object@npm:^3.0.1": version: 3.0.2 resolution: "http-response-object@npm:3.0.2" @@ -13022,7 +13137,7 @@ __metadata: languageName: node linkType: hard -"https-proxy-agent@npm:^5.0.0, https-proxy-agent@npm:^5.0.1": +"https-proxy-agent@npm:^5.0.1": version: 5.0.1 resolution: "https-proxy-agent@npm:5.0.1" dependencies: @@ -13032,6 +13147,16 @@ __metadata: languageName: node linkType: hard +"https-proxy-agent@npm:^7.0.1, https-proxy-agent@npm:^7.0.5": + version: 7.0.6 + resolution: "https-proxy-agent@npm:7.0.6" + dependencies: + agent-base: ^7.1.2 + debug: 4 + checksum: b882377a120aa0544846172e5db021fa8afbf83fea2a897d397bd2ddd8095ab268c24bc462f40a15f2a8c600bf4aa05ce52927f70038d4014e68aefecfa94e8d + languageName: node + linkType: hard + "human-signals@npm:^2.1.0": version: 2.1.0 resolution: "human-signals@npm:2.1.0" @@ -13039,16 +13164,7 @@ __metadata: languageName: node linkType: hard -"humanize-ms@npm:^1.2.1": - version: 1.2.1 - resolution: "humanize-ms@npm:1.2.1" - dependencies: - ms: ^2.0.0 - checksum: 9c7a74a2827f9294c009266c82031030eae811ca87b0da3dceb8d6071b9bde22c9f3daef0469c3c533cc67a97d8a167cd9fc0389350e5f415f61a79b171ded16 - languageName: node - linkType: hard - -"iconv-lite@npm:0.4.24, iconv-lite@npm:^0.4.24, iconv-lite@npm:^0.4.4, iconv-lite@npm:~0.4.13": +"iconv-lite@npm:0.4.24, iconv-lite@npm:^0.4.24, iconv-lite@npm:^0.4.4, iconv-lite@npm:~0.4.13, iconv-lite@npm:~0.4.24": version: 0.4.24 resolution: "iconv-lite@npm:0.4.24" dependencies: @@ -13057,7 +13173,7 @@ __metadata: languageName: node linkType: hard -"iconv-lite@npm:0.6.3, iconv-lite@npm:^0.6.2": +"iconv-lite@npm:0.6.3, iconv-lite@npm:^0.6.2, iconv-lite@npm:^0.6.3": version: 0.6.3 resolution: "iconv-lite@npm:0.6.3" dependencies: @@ -13089,10 +13205,17 @@ __metadata: languageName: node linkType: hard -"ignore@npm:^5.0.0, ignore@npm:^5.1.8, ignore@npm:^5.2.0": - version: 5.2.0 - resolution: "ignore@npm:5.2.0" - checksum: 6b1f926792d614f64c6c83da3a1f9c83f6196c2839aa41e1e32dd7b8d174cef2e329d75caabb62cb61ce9dc432f75e67d07d122a037312db7caa73166a1bdb77 +"ignore@npm:^5.1.8, ignore@npm:^5.2.0": + version: 5.3.2 + resolution: "ignore@npm:5.3.2" + checksum: 2acfd32a573260ea522ea0bfeff880af426d68f6831f973129e2ba7363f422923cf53aab62f8369cbf4667c7b25b6f8a3761b34ecdb284ea18e87a5262a865be + languageName: node + linkType: hard + +"ignore@npm:^6.0.0": + version: 6.0.2 + resolution: "ignore@npm:6.0.2" + checksum: b5dfb811428a067d79c128144814d3d20f01ef21e19c2b2e5bc270895995ce352da9b0e1c46a33de7daaf214bf0cf59d3353c78cdf9e365aaea677db729c721e languageName: node linkType: hard @@ -13113,16 +13236,16 @@ __metadata: linkType: hard "immer@npm:^9.0.7": - version: 9.0.16 - resolution: "immer@npm:9.0.16" - checksum: e9a5ca65c929b329da7a3b7beccf7984271cda7bdd47b2cab619eac3277dcd56598c211b55cc340786b6eff0c06652ac018808d9fd744443f06882364dece6bc + version: 9.0.21 + resolution: "immer@npm:9.0.21" + checksum: 70e3c274165995352f6936695f0ef4723c52c92c92dd0e9afdfe008175af39fa28e76aafb3a2ca9d57d1fb8f796efc4dd1e1cc36f18d33fa5b74f3dfb0375432 languageName: node linkType: hard -"immutable@npm:^4.0.0": - version: 4.1.0 - resolution: "immutable@npm:4.1.0" - checksum: b9bc1f14fb18eb382d48339c064b24a1f97ae4cf43102e0906c0a6e186a27afcd18b55ca4a0b63c98eefb58143e2b5ebc7755a5fb4da4a7ad84b7a6096ac5b13 +"immutable@npm:^5.0.2": + version: 5.1.4 + resolution: "immutable@npm:5.1.4" + checksum: 2bddb02594b27e2f37d35c32acf409b77a815e19e2ae7bbffae4b05535965ed3aaf8808255106cb229b7cf0791001bd88efde9cc38e5b32f935992e9b631adf3 languageName: node linkType: hard @@ -13134,12 +13257,12 @@ __metadata: linkType: hard "import-fresh@npm:^3.0.0, import-fresh@npm:^3.1.0, import-fresh@npm:^3.2.1": - version: 3.3.0 - resolution: "import-fresh@npm:3.3.0" + version: 3.3.1 + resolution: "import-fresh@npm:3.3.1" dependencies: parent-module: ^1.0.0 resolve-from: ^4.0.0 - checksum: 2cacfad06e652b1edc50be650f7ec3be08c5e5a6f6d12d035c440a42a8cc028e60a5b99ca08a77ab4d6b1346da7d971915828f33cdab730d3d42f08242d09baa + checksum: a06b19461b4879cc654d46f8a6244eb55eb053437afd4cbb6613cad6be203811849ed3e4ea038783092879487299fda24af932b86bdfff67c9055ba3612b8c87 languageName: node linkType: hard @@ -13158,9 +13281,9 @@ __metadata: linkType: hard "import-meta-resolve@npm:^4.0.0": - version: 4.1.0 - resolution: "import-meta-resolve@npm:4.1.0" - checksum: 6497af27bf3ee384ad4efd4e0ec3facf9a114863f35a7b35f248659f32faa5e1ae07baa74d603069f35734ae3718a78b3f66926f98dc9a62e261e7df37854a62 + version: 4.2.0 + resolution: "import-meta-resolve@npm:4.2.0" + checksum: fe5ca3258f22dc3dd4e2f2e8f6b54324c1cf0261216c7d9aae801b2eadf664bbd61e26cfb907a1238761285a3e9c8c23403321d52ca0e579c341b8d90c97fa52 languageName: node linkType: hard @@ -13171,20 +13294,6 @@ __metadata: languageName: node linkType: hard -"indent-string@npm:^4.0.0": - version: 4.0.0 - resolution: "indent-string@npm:4.0.0" - checksum: 824cfb9929d031dabf059bebfe08cf3137365e112019086ed3dcff6a0a7b698cb80cf67ccccde0e25b9e2d7527aa6cc1fed1ac490c752162496caba3e6699612 - languageName: node - linkType: hard - -"infer-owner@npm:^1.0.4": - version: 1.0.4 - resolution: "infer-owner@npm:1.0.4" - checksum: 181e732764e4a0611576466b4b87dac338972b839920b2a8cde43642e4ed6bd54dc1fb0b40874728f2a2df9a1b097b8ff83b56d5f8f8e3927f837fdcb47d8a89 - languageName: node - linkType: hard - "inflight@npm:^1.0.4": version: 1.0.6 resolution: "inflight@npm:1.0.6" @@ -13195,20 +13304,13 @@ __metadata: languageName: node linkType: hard -"inherits@npm:2, inherits@npm:2.0.4, inherits@npm:^2.0.0, inherits@npm:^2.0.1, inherits@npm:^2.0.3, inherits@npm:^2.0.4, inherits@npm:~2.0.1, inherits@npm:~2.0.3": +"inherits@npm:2, inherits@npm:2.0.4, inherits@npm:^2.0.0, inherits@npm:^2.0.1, inherits@npm:^2.0.3, inherits@npm:^2.0.4, inherits@npm:~2.0.1, inherits@npm:~2.0.3, inherits@npm:~2.0.4": version: 2.0.4 resolution: "inherits@npm:2.0.4" checksum: 4a48a733847879d6cf6691860a6b1e3f0f4754176e4d71494c41f3475553768b10f84b5ce1d40fbd0e34e6bfbb864ee35858ad4dd2cf31e02fc4a154b724d7f1 languageName: node linkType: hard -"inherits@npm:2.0.1": - version: 2.0.1 - resolution: "inherits@npm:2.0.1" - checksum: 6536b9377296d4ce8ee89c5c543cb75030934e61af42dba98a428e7d026938c5985ea4d1e3b87743a5b834f40ed1187f89c2d7479e9d59e41d2d1051aefba07b - languageName: node - linkType: hard - "inherits@npm:2.0.3": version: 2.0.3 resolution: "inherits@npm:2.0.3" @@ -13265,14 +13367,14 @@ __metadata: languageName: node linkType: hard -"internal-slot@npm:^1.0.3": - version: 1.0.3 - resolution: "internal-slot@npm:1.0.3" +"internal-slot@npm:^1.1.0": + version: 1.1.0 + resolution: "internal-slot@npm:1.1.0" dependencies: - get-intrinsic: ^1.1.0 - has: ^1.0.3 - side-channel: ^1.0.4 - checksum: 1944f92e981e47aebc98a88ff0db579fd90543d937806104d0b96557b10c1f170c51fb777b97740a8b6ddeec585fca8c39ae99fd08a8e058dfc8ab70937238bf + es-errors: ^1.3.0 + hasown: ^2.0.2 + side-channel: ^1.1.0 + checksum: 8e0991c2d048cc08dab0a91f573c99f6a4215075887517ea4fa32203ce8aea60fa03f95b177977fa27eb502e5168366d0f3e02c762b799691411d49900611861 languageName: node linkType: hard @@ -13292,10 +13394,10 @@ __metadata: languageName: node linkType: hard -"ip@npm:^2.0.0": - version: 2.0.0 - resolution: "ip@npm:2.0.0" - checksum: cfcfac6b873b701996d71ec82a7dd27ba92450afdb421e356f44044ed688df04567344c36cbacea7d01b1c39a4c732dc012570ebe9bebfb06f27314bca625349 +"ip-address@npm:^10.0.1": + version: 10.1.0 + resolution: "ip-address@npm:10.1.0" + checksum: 76b1abcdf52a32e2e05ca1f202f3a8ab8547e5651a9233781b330271bd7f1a741067748d71c4cbb9d9906d9f1fa69e7ddc8b4a11130db4534fdab0e908c84e0d languageName: node linkType: hard @@ -13347,13 +13449,24 @@ __metadata: languageName: node linkType: hard -"is-arguments@npm:^1.1.0, is-arguments@npm:^1.1.1": - version: 1.1.1 - resolution: "is-arguments@npm:1.1.1" +"is-arguments@npm:^1.1.1": + version: 1.2.0 + resolution: "is-arguments@npm:1.2.0" dependencies: - call-bind: ^1.0.2 - has-tostringtag: ^1.0.0 - checksum: 7f02700ec2171b691ef3e4d0e3e6c0ba408e8434368504bb593d0d7c891c0dbfda6d19d30808b904a6cb1929bca648c061ba438c39f296c2a8ca083229c49f27 + call-bound: ^1.0.2 + has-tostringtag: ^1.0.2 + checksum: aae9307fedfe2e5be14aebd0f48a9eeedf6b8c8f5a0b66257b965146d1e94abdc3f08e3dce3b1d908e1fa23c70039a88810ee1d753905758b9b6eebbab0bafeb + languageName: node + linkType: hard + +"is-array-buffer@npm:^3.0.2, is-array-buffer@npm:^3.0.4, is-array-buffer@npm:^3.0.5": + version: 3.0.5 + resolution: "is-array-buffer@npm:3.0.5" + dependencies: + call-bind: ^1.0.8 + call-bound: ^1.0.3 + get-intrinsic: ^1.2.6 + checksum: f137a2a6e77af682cdbffef1e633c140cf596f72321baf8bba0f4ef22685eb4339dde23dfe9e9ca430b5f961dee4d46577dcf12b792b68518c8449b134fb9156 languageName: node linkType: hard @@ -13365,18 +13478,31 @@ __metadata: linkType: hard "is-arrayish@npm:^0.3.1": - version: 0.3.2 - resolution: "is-arrayish@npm:0.3.2" - checksum: 977e64f54d91c8f169b59afcd80ff19227e9f5c791fa28fa2e5bce355cbaf6c2c356711b734656e80c9dd4a854dd7efcf7894402f1031dfc5de5d620775b4d5f + version: 0.3.4 + resolution: "is-arrayish@npm:0.3.4" + checksum: 09816634eb7b6e357067f6b49c7656b4aff6d8b25486553d086bab53ce0f929c0293906539503b2a317f3137b5a5cd7e9ea01305f6090c0037c4340d9121420d + languageName: node + linkType: hard + +"is-async-function@npm:^2.0.0": + version: 2.1.1 + resolution: "is-async-function@npm:2.1.1" + dependencies: + async-function: ^1.0.0 + call-bound: ^1.0.3 + get-proto: ^1.0.1 + has-tostringtag: ^1.0.2 + safe-regex-test: ^1.1.0 + checksum: 9bece45133da26636488ca127d7686b85ad3ca18927e2850cff1937a650059e90be1c71a48623f8791646bb7a241b0cabf602a0b9252dcfa5ab273f2399000e6 languageName: node linkType: hard -"is-bigint@npm:^1.0.1": - version: 1.0.4 - resolution: "is-bigint@npm:1.0.4" +"is-bigint@npm:^1.1.0": + version: 1.1.0 + resolution: "is-bigint@npm:1.1.0" dependencies: - has-bigints: ^1.0.1 - checksum: c56edfe09b1154f8668e53ebe8252b6f185ee852a50f9b41e8d921cb2bed425652049fbe438723f6cb48a63ca1aa051e948e7e401e093477c99c84eba244f666 + has-bigints: ^1.0.2 + checksum: ee1544f0e664f253306786ed1dce494b8cf242ef415d6375d8545b4d8816b0f054bd9f948a8988ae2c6325d1c28260dd02978236b2f7b8fb70dfc4838a6c9fa7 languageName: node linkType: hard @@ -13389,13 +13515,13 @@ __metadata: languageName: node linkType: hard -"is-boolean-object@npm:^1.1.0": - version: 1.1.2 - resolution: "is-boolean-object@npm:1.1.2" +"is-boolean-object@npm:^1.2.1": + version: 1.2.2 + resolution: "is-boolean-object@npm:1.2.2" dependencies: - call-bind: ^1.0.2 - has-tostringtag: ^1.0.0 - checksum: c03b23dbaacadc18940defb12c1c0e3aaece7553ef58b162a0f6bba0c2a7e1551b59f365b91e00d2dbac0522392d576ef322628cb1d036a0fe51eb466db67222 + call-bound: ^1.0.3 + has-tostringtag: ^1.0.2 + checksum: 0415b181e8f1bfd5d3f8a20f8108e64d372a72131674eea9c2923f39d065b6ad08d654765553bdbffbd92c3746f1007986c34087db1bd89a31f71be8359ccdaa languageName: node linkType: hard @@ -13406,7 +13532,7 @@ __metadata: languageName: node linkType: hard -"is-callable@npm:^1.1.3, is-callable@npm:^1.1.4, is-callable@npm:^1.2.7": +"is-callable@npm:^1.2.7": version: 1.2.7 resolution: "is-callable@npm:1.2.7" checksum: 61fd57d03b0d984e2ed3720fb1c7a897827ea174bd44402878e059542ea8c4aeedee0ea0985998aa5cc2736b2fa6e271c08587addb5b3959ac52cf665173d1ac @@ -13424,21 +13550,33 @@ __metadata: languageName: node linkType: hard -"is-core-module@npm:^2.8.1, is-core-module@npm:^2.9.0": - version: 2.11.0 - resolution: "is-core-module@npm:2.11.0" +"is-core-module@npm:^2.13.0, is-core-module@npm:^2.16.1": + version: 2.16.1 + resolution: "is-core-module@npm:2.16.1" dependencies: - has: ^1.0.3 - checksum: f96fd490c6b48eb4f6d10ba815c6ef13f410b0ba6f7eb8577af51697de523e5f2cd9de1c441b51d27251bf0e4aebc936545e33a5d26d5d51f28d25698d4a8bab + hasown: ^2.0.2 + checksum: 6ec5b3c42d9cbf1ac23f164b16b8a140c3cec338bf8f884c076ca89950c7cc04c33e78f02b8cae7ff4751f3247e3174b2330f1fe4de194c7210deb8b1ea316a7 languageName: node linkType: hard -"is-date-object@npm:^1.0.1, is-date-object@npm:^1.0.5": - version: 1.0.5 - resolution: "is-date-object@npm:1.0.5" +"is-data-view@npm:^1.0.1, is-data-view@npm:^1.0.2": + version: 1.0.2 + resolution: "is-data-view@npm:1.0.2" + dependencies: + call-bound: ^1.0.2 + get-intrinsic: ^1.2.6 + is-typed-array: ^1.1.13 + checksum: 31600dd19932eae7fd304567e465709ffbfa17fa236427c9c864148e1b54eb2146357fcf3aed9b686dee13c217e1bb5a649cb3b9c479e1004c0648e9febde1b2 + languageName: node + linkType: hard + +"is-date-object@npm:^1.0.5, is-date-object@npm:^1.1.0": + version: 1.1.0 + resolution: "is-date-object@npm:1.1.0" dependencies: - has-tostringtag: ^1.0.0 - checksum: baa9077cdf15eb7b58c79398604ca57379b2fc4cf9aa7a9b9e295278648f628c9b201400c01c5e0f7afae56507d741185730307cbe7cad3b9f90a77e5ee342fc + call-bound: ^1.0.2 + has-tostringtag: ^1.0.2 + checksum: d6c36ab9d20971d65f3fc64cef940d57a4900a2ac85fb488a46d164c2072a33da1cb51eefcc039e3e5c208acbce343d3480b84ab5ff0983f617512da2742562a languageName: node linkType: hard @@ -13495,6 +13633,15 @@ __metadata: languageName: node linkType: hard +"is-finalizationregistry@npm:^1.1.0": + version: 1.1.1 + resolution: "is-finalizationregistry@npm:1.1.1" + dependencies: + call-bound: ^1.0.3 + checksum: 38c646c506e64ead41a36c182d91639833311970b6b6c6268634f109eef0a1a9d2f1f2e499ef4cb43c744a13443c4cdd2f0812d5afdcee5e9b65b72b28c48557 + languageName: node + linkType: hard + "is-fullwidth-code-point@npm:^3.0.0": version: 3.0.0 resolution: "is-fullwidth-code-point@npm:3.0.0" @@ -13509,6 +13656,19 @@ __metadata: languageName: node linkType: hard +"is-generator-function@npm:^1.0.10": + version: 1.1.2 + resolution: "is-generator-function@npm:1.1.2" + dependencies: + call-bound: ^1.0.4 + generator-function: ^2.0.0 + get-proto: ^1.0.1 + has-tostringtag: ^1.0.2 + safe-regex-test: ^1.1.0 + checksum: 0b81c613752a5e534939e5b3835ff722446837a5b94c3a3934af5ded36a651d9aa31c3f11f8a3453884b9658bf26dbfb7eb855e744d920b07f084bd890a43414 + languageName: node + linkType: hard + "is-glob@npm:^2.0.0": version: 2.0.1 resolution: "is-glob@npm:2.0.1" @@ -13553,13 +13713,6 @@ __metadata: languageName: node linkType: hard -"is-lambda@npm:^1.0.1": - version: 1.0.1 - resolution: "is-lambda@npm:1.0.1" - checksum: 93a32f01940220532e5948538699ad610d5924ac86093fcee83022252b363eb0cc99ba53ab084a04e4fb62bf7b5731f55496257a4c38adf87af9c4d352c71c35 - languageName: node - linkType: hard - "is-lower-case@npm:^1.1.0": version: 1.1.3 resolution: "is-lower-case@npm:1.1.3" @@ -13578,17 +13731,17 @@ __metadata: languageName: node linkType: hard -"is-map@npm:^2.0.1, is-map@npm:^2.0.2": - version: 2.0.2 - resolution: "is-map@npm:2.0.2" - checksum: ace3d0ecd667bbdefdb1852de601268f67f2db725624b1958f279316e13fecb8fa7df91fd60f690d7417b4ec180712f5a7ee967008e27c65cfd475cc84337728 +"is-map@npm:^2.0.2, is-map@npm:^2.0.3": + version: 2.0.3 + resolution: "is-map@npm:2.0.3" + checksum: e6ce5f6380f32b141b3153e6ba9074892bbbbd655e92e7ba5ff195239777e767a976dcd4e22f864accaf30e53ebf961ab1995424aef91af68788f0591b7396cc languageName: node linkType: hard -"is-negative-zero@npm:^2.0.2": - version: 2.0.2 - resolution: "is-negative-zero@npm:2.0.2" - checksum: f3232194c47a549da60c3d509c9a09be442507616b69454716692e37ae9f37c4dea264fb208ad0c9f3efd15a796a46b79df07c7e53c6227c32170608b809149a +"is-negative-zero@npm:^2.0.3": + version: 2.0.3 + resolution: "is-negative-zero@npm:2.0.3" + checksum: c1e6b23d2070c0539d7b36022d5a94407132411d01aba39ec549af824231f3804b1aea90b5e4e58e807a65d23ceb538ed6e355ce76b267bdd86edb757ffcbdcd languageName: node linkType: hard @@ -13608,12 +13761,13 @@ __metadata: languageName: node linkType: hard -"is-number-object@npm:^1.0.4": - version: 1.0.7 - resolution: "is-number-object@npm:1.0.7" +"is-number-object@npm:^1.1.1": + version: 1.1.1 + resolution: "is-number-object@npm:1.1.1" dependencies: - has-tostringtag: ^1.0.0 - checksum: d1e8d01bb0a7134c74649c4e62da0c6118a0bfc6771ea3c560914d52a627873e6920dd0fd0ebc0e12ad2ff4687eac4c308f7e80320b973b2c8a2c8f97a7524f7 + call-bound: ^1.0.3 + has-tostringtag: ^1.0.2 + checksum: 6517f0a0e8c4b197a21afb45cd3053dc711e79d45d8878aa3565de38d0102b130ca8732485122c7b336e98c27dacd5236854e3e6526e0eb30cae64956535662f languageName: node linkType: hard @@ -13682,13 +13836,15 @@ __metadata: languageName: node linkType: hard -"is-regex@npm:^1.1.4": - version: 1.1.4 - resolution: "is-regex@npm:1.1.4" +"is-regex@npm:^1.1.4, is-regex@npm:^1.2.1": + version: 1.2.1 + resolution: "is-regex@npm:1.2.1" dependencies: - call-bind: ^1.0.2 - has-tostringtag: ^1.0.0 - checksum: 362399b33535bc8f386d96c45c9feb04cf7f8b41c182f54174c1a45c9abbbe5e31290bbad09a458583ff6bf3b2048672cdb1881b13289569a7c548370856a652 + call-bound: ^1.0.2 + gopd: ^1.2.0 + has-tostringtag: ^1.0.2 + hasown: ^2.0.2 + checksum: 99ee0b6d30ef1bb61fa4b22fae7056c6c9b3c693803c0c284ff7a8570f83075a7d38cda53b06b7996d441215c27895ea5d1af62124562e13d91b3dbec41a5e13 languageName: node linkType: hard @@ -13717,28 +13873,28 @@ __metadata: languageName: node linkType: hard -"is-set@npm:^2.0.1, is-set@npm:^2.0.2": - version: 2.0.2 - resolution: "is-set@npm:2.0.2" - checksum: b64343faf45e9387b97a6fd32be632ee7b269bd8183701f3b3f5b71a7cf00d04450ed8669d0bd08753e08b968beda96fca73a10fd0ff56a32603f64deba55a57 +"is-set@npm:^2.0.2, is-set@npm:^2.0.3": + version: 2.0.3 + resolution: "is-set@npm:2.0.3" + checksum: 36e3f8c44bdbe9496c9689762cc4110f6a6a12b767c5d74c0398176aa2678d4467e3bf07595556f2dba897751bde1422480212b97d973c7b08a343100b0c0dfe languageName: node linkType: hard -"is-shared-array-buffer@npm:^1.0.2": - version: 1.0.2 - resolution: "is-shared-array-buffer@npm:1.0.2" +"is-shared-array-buffer@npm:^1.0.2, is-shared-array-buffer@npm:^1.0.4": + version: 1.0.4 + resolution: "is-shared-array-buffer@npm:1.0.4" dependencies: - call-bind: ^1.0.2 - checksum: 9508929cf14fdc1afc9d61d723c6e8d34f5e117f0bffda4d97e7a5d88c3a8681f633a74f8e3ad1fe92d5113f9b921dc5ca44356492079612f9a247efbce7032a + call-bound: ^1.0.3 + checksum: 1611fedc175796eebb88f4dfc393dd969a4a8e6c69cadaff424ee9d4464f9f026399a5f84a90f7c62d6d7ee04e3626a912149726de102b0bd6c1ee6a9868fa5a languageName: node linkType: hard "is-ssh@npm:^1.4.0": - version: 1.4.0 - resolution: "is-ssh@npm:1.4.0" + version: 1.4.1 + resolution: "is-ssh@npm:1.4.1" dependencies: protocols: ^2.0.1 - checksum: 75eaa17b538bee24b661fbeb0f140226ac77e904a6039f787bea418431e2162f1f9c4c4ccad3bd169e036cd701cc631406e8c505d9fa7e20164e74b47f86f40f + checksum: 005b461ac444398eb8b7cd2f489288e49dd18c8b6cbf1eb20767f9b79f330ab6e3308b2dac8ec6ca2a950d2a368912e0e992e2474bc1b5204693abb6226c1431 languageName: node linkType: hard @@ -13756,38 +13912,28 @@ __metadata: languageName: node linkType: hard -"is-string@npm:^1.0.5, is-string@npm:^1.0.7": - version: 1.0.7 - resolution: "is-string@npm:1.0.7" - dependencies: - has-tostringtag: ^1.0.0 - checksum: 323b3d04622f78d45077cf89aab783b2f49d24dc641aa89b5ad1a72114cfeff2585efc8c12ef42466dff32bde93d839ad321b26884cf75e5a7892a938b089989 - languageName: node - linkType: hard - -"is-symbol@npm:^1.0.2, is-symbol@npm:^1.0.3": - version: 1.0.4 - resolution: "is-symbol@npm:1.0.4" +"is-string@npm:^1.0.7, is-string@npm:^1.1.1": + version: 1.1.1 + resolution: "is-string@npm:1.1.1" dependencies: - has-symbols: ^1.0.2 - checksum: 92805812ef590738d9de49d677cd17dfd486794773fb6fa0032d16452af46e9b91bb43ffe82c983570f015b37136f4b53b28b8523bfb10b0ece7a66c31a54510 + call-bound: ^1.0.3 + has-tostringtag: ^1.0.2 + checksum: 2eeaaff605250f5e836ea3500d33d1a5d3aa98d008641d9d42fb941e929ffd25972326c2ef912987e54c95b6f10416281aaf1b35cdf81992cfb7524c5de8e193 languageName: node linkType: hard -"is-typed-array@npm:^1.1.10": - version: 1.1.10 - resolution: "is-typed-array@npm:1.1.10" +"is-symbol@npm:^1.0.4, is-symbol@npm:^1.1.1": + version: 1.1.1 + resolution: "is-symbol@npm:1.1.1" dependencies: - available-typed-arrays: ^1.0.5 - call-bind: ^1.0.2 - for-each: ^0.3.3 - gopd: ^1.0.1 - has-tostringtag: ^1.0.0 - checksum: aac6ecb59d4c56a1cdeb69b1f129154ef462bbffe434cb8a8235ca89b42f258b7ae94073c41b3cb7bce37f6a1733ad4499f07882d5d5093a7ba84dfc4ebb8017 + call-bound: ^1.0.2 + has-symbols: ^1.1.0 + safe-regex-test: ^1.1.0 + checksum: bfafacf037af6f3c9d68820b74be4ae8a736a658a3344072df9642a090016e281797ba8edbeb1c83425879aae55d1cb1f30b38bf132d703692b2570367358032 languageName: node linkType: hard -"is-typed-array@npm:^1.1.14": +"is-typed-array@npm:^1.1.13, is-typed-array@npm:^1.1.14, is-typed-array@npm:^1.1.15": version: 1.1.15 resolution: "is-typed-array@npm:1.1.15" dependencies: @@ -13848,29 +13994,29 @@ __metadata: languageName: node linkType: hard -"is-weakmap@npm:^2.0.1": - version: 2.0.1 - resolution: "is-weakmap@npm:2.0.1" - checksum: 1222bb7e90c32bdb949226e66d26cb7bce12e1e28e3e1b40bfa6b390ba3e08192a8664a703dff2a00a84825f4e022f9cd58c4599ff9981ab72b1d69479f4f7f6 +"is-weakmap@npm:^2.0.2": + version: 2.0.2 + resolution: "is-weakmap@npm:2.0.2" + checksum: f36aef758b46990e0d3c37269619c0a08c5b29428c0bb11ecba7f75203442d6c7801239c2f31314bc79199217ef08263787f3837d9e22610ad1da62970d6616d languageName: node linkType: hard -"is-weakref@npm:^1.0.2": - version: 1.0.2 - resolution: "is-weakref@npm:1.0.2" +"is-weakref@npm:^1.0.2, is-weakref@npm:^1.1.1": + version: 1.1.1 + resolution: "is-weakref@npm:1.1.1" dependencies: - call-bind: ^1.0.2 - checksum: 95bd9a57cdcb58c63b1c401c60a474b0f45b94719c30f548c891860f051bc2231575c290a6b420c6bc6e7ed99459d424c652bd5bf9a1d5259505dc35b4bf83de + call-bound: ^1.0.3 + checksum: 1769b9aed5d435a3a989ffc18fc4ad1947d2acdaf530eb2bd6af844861b545047ea51102f75901f89043bed0267ed61d914ee21e6e8b9aa734ec201cdfc0726f languageName: node linkType: hard -"is-weakset@npm:^2.0.1": - version: 2.0.2 - resolution: "is-weakset@npm:2.0.2" +"is-weakset@npm:^2.0.3": + version: 2.0.4 + resolution: "is-weakset@npm:2.0.4" dependencies: - call-bind: ^1.0.2 - get-intrinsic: ^1.1.1 - checksum: 5d8698d1fa599a0635d7ca85be9c26d547b317ed8fd83fc75f03efbe75d50001b5eececb1e9971de85fcde84f69ae6f8346bc92d20d55d46201d328e4c74a367 + call-bound: ^1.0.3 + get-intrinsic: ^1.2.6 + checksum: 5c6c8415a06065d78bdd5e3a771483aa1cd928df19138aa73c4c51333226f203f22117b4325df55cc8b3085a6716870a320c2d757efee92d7a7091a039082041 languageName: node linkType: hard @@ -13963,6 +14109,20 @@ __metadata: languageName: node linkType: hard +"iterator.prototype@npm:^1.1.5": + version: 1.1.5 + resolution: "iterator.prototype@npm:1.1.5" + dependencies: + define-data-property: ^1.1.4 + es-object-atoms: ^1.0.0 + get-intrinsic: ^1.2.6 + get-proto: ^1.0.0 + has-symbols: ^1.1.0 + set-function-name: ^2.0.2 + checksum: 7db23c42629ba4790e6e15f78b555f41dbd08818c85af306988364bd19d86716a1187cb333444f3a0036bfc078a0e9cb7ec67fef3a61662736d16410d7f77869 + languageName: node + linkType: hard + "jackspeak@npm:^3.1.2": version: 3.4.3 resolution: "jackspeak@npm:3.4.3" @@ -14019,15 +14179,15 @@ __metadata: linkType: hard "joi@npm:^17.4.2": - version: 17.7.0 - resolution: "joi@npm:17.7.0" + version: 17.13.3 + resolution: "joi@npm:17.13.3" dependencies: - "@hapi/hoek": ^9.0.0 - "@hapi/topo": ^5.0.0 - "@sideway/address": ^4.1.3 - "@sideway/formula": ^3.0.0 + "@hapi/hoek": ^9.3.0 + "@hapi/topo": ^5.1.0 + "@sideway/address": ^4.1.5 + "@sideway/formula": ^3.0.1 "@sideway/pinpoint": ^2.0.0 - checksum: 767a847936cb66787256c4351ff86e1b9e8d7383cbe81a5c827064032c2a8e8b6e938baef5ad32c4035fe4c56e537bd90aa2a952be8a0658601c920cdeb4fb3c + checksum: 66ed454fee3d8e8da1ce21657fd2c7d565d98f3e539d2c5c028767e5f38cbd6297ce54df8312d1d094e62eb38f9452ebb43da4ce87321df66cf5e3f128cbc400 languageName: node linkType: hard @@ -14069,25 +14229,25 @@ __metadata: linkType: hard "js-yaml@npm:^3.13.1, js-yaml@npm:~3.14.0": - version: 3.14.1 - resolution: "js-yaml@npm:3.14.1" + version: 3.14.2 + resolution: "js-yaml@npm:3.14.2" dependencies: argparse: ^1.0.7 esprima: ^4.0.0 bin: js-yaml: bin/js-yaml.js - checksum: bef146085f472d44dee30ec34e5cf36bf89164f5d585435a3d3da89e52622dff0b188a580e4ad091c3341889e14cb88cac6e4deb16dc5b1e9623bb0601fc255c + checksum: 626fc207734a3452d6ba84e1c8c226240e6d431426ed94d0ab043c50926d97c509629c08b1d636f5d27815833b7cfd225865631da9fb33cb957374490bf3e90b languageName: node linkType: hard "js-yaml@npm:^4.1.0": - version: 4.1.0 - resolution: "js-yaml@npm:4.1.0" + version: 4.1.1 + resolution: "js-yaml@npm:4.1.1" dependencies: argparse: ^2.0.1 bin: js-yaml: bin/js-yaml.js - checksum: c7830dfd456c3ef2c6e355cc5a92e6700ceafa1d14bba54497b34a99f0376cecbb3e9ac14d3e5849b426d5a5140709a66237a8c991c675431271c4ce5504151a + checksum: ea2339c6930fe048ec31b007b3c90be2714ab3e7defcc2c27ebf30c74fd940358f29070b4345af0019ef151875bf3bc3f8644bea1bab0372652b5044813ac02d languageName: node linkType: hard @@ -14133,16 +14293,16 @@ __metadata: linkType: hard "jsdom@npm:^20.0.0": - version: 20.0.2 - resolution: "jsdom@npm:20.0.2" + version: 20.0.3 + resolution: "jsdom@npm:20.0.3" dependencies: abab: ^2.0.6 - acorn: ^8.8.0 + acorn: ^8.8.1 acorn-globals: ^7.0.0 cssom: ^0.5.0 cssstyle: ^2.3.0 data-urls: ^3.0.2 - decimal.js: ^10.4.1 + decimal.js: ^10.4.2 domexception: ^4.0.0 escodegen: ^2.0.0 form-data: ^4.0.0 @@ -14155,37 +14315,28 @@ __metadata: saxes: ^6.0.0 symbol-tree: ^3.2.4 tough-cookie: ^4.1.2 - w3c-xmlserializer: ^3.0.0 + w3c-xmlserializer: ^4.0.0 webidl-conversions: ^7.0.0 whatwg-encoding: ^2.0.0 whatwg-mimetype: ^3.0.0 whatwg-url: ^11.0.0 - ws: ^8.9.0 + ws: ^8.11.0 xml-name-validator: ^4.0.0 peerDependencies: canvas: ^2.5.0 peerDependenciesMeta: canvas: optional: true - checksum: 1912e73ecbc7cb1e458b63c4976a1f1dd40c1cdb9f91559cfeccb08c68ad1b9918c6260bd021559ecb1a7c233fae0d0c3fdcbd2ce82df597ef9373d67c8934c0 - languageName: node - linkType: hard - -"jsesc@npm:^2.5.1": - version: 2.5.2 - resolution: "jsesc@npm:2.5.2" - bin: - jsesc: bin/jsesc - checksum: 4dc190771129e12023f729ce20e1e0bfceac84d73a85bc3119f7f938843fe25a4aeccb54b6494dce26fcf263d815f5f31acdefac7cc9329efb8422a4f4d9fa9d + checksum: 6e2ae21db397133a061b270c26d2dbc0b9051733ea3b896a7ece78d79f475ff0974f766a413c1198a79c793159119169f2335ddb23150348fbfdcfa6f3105536 languageName: node linkType: hard -"jsesc@npm:~0.5.0": - version: 0.5.0 - resolution: "jsesc@npm:0.5.0" +"jsesc@npm:^3.0.2, jsesc@npm:~3.1.0": + version: 3.1.0 + resolution: "jsesc@npm:3.1.0" bin: jsesc: bin/jsesc - checksum: b8b44cbfc92f198ad972fba706ee6a1dfa7485321ee8c0b25f5cedd538dcb20cde3197de16a7265430fce8277a12db066219369e3d51055038946039f6e20e17 + checksum: 19c94095ea026725540c0d29da33ab03144f6bcf2d4159e4833d534976e99e0c09c38cefa9a575279a51fc36b31166f8d6d05c9fe2645d5f15851d690b41f17f languageName: node linkType: hard @@ -14275,7 +14426,7 @@ __metadata: languageName: node linkType: hard -"json5@npm:^1.0.1": +"json5@npm:^1.0.1, json5@npm:^1.0.2": version: 1.0.2 resolution: "json5@npm:1.0.2" dependencies: @@ -14286,25 +14437,25 @@ __metadata: languageName: node linkType: hard -"json5@npm:^2.0.0, json5@npm:^2.1.2, json5@npm:^2.1.3, json5@npm:^2.2.0, json5@npm:^2.2.1": - version: 2.2.1 - resolution: "json5@npm:2.2.1" +"json5@npm:^2.0.0, json5@npm:^2.1.2, json5@npm:^2.1.3, json5@npm:^2.2.0, json5@npm:^2.2.1, json5@npm:^2.2.3": + version: 2.2.3 + resolution: "json5@npm:2.2.3" bin: json5: lib/cli.js - checksum: 74b8a23b102a6f2bf2d224797ae553a75488b5adbaee9c9b6e5ab8b510a2fc6e38f876d4c77dea672d4014a44b2399e15f2051ac2b37b87f74c0c7602003543b + checksum: 2a7436a93393830bce797d4626275152e37e877b265e94ca69c99e3d20c2b9dab021279146a39cdb700e71b2dd32a4cebd1514cd57cee102b1af906ce5040349 languageName: node linkType: hard "jsonfile@npm:^6.0.1": - version: 6.1.0 - resolution: "jsonfile@npm:6.1.0" + version: 6.2.0 + resolution: "jsonfile@npm:6.2.0" dependencies: graceful-fs: ^4.1.6 universalify: ^2.0.0 dependenciesMeta: graceful-fs: optional: true - checksum: 7af3b8e1ac8fe7f1eccc6263c6ca14e1966fcbc74b618d3c78a0a2075579487547b94f72b7a1114e844a1e15bb00d440e5d1720bfc4612d790a6f285d5ea8354 + checksum: c3028ec5c770bb41290c9bb9ca04bdd0a1b698ddbdf6517c9453d3f90fc9e000c9675959fb46891d317690a93c62de03ff1735d8dbe02be83e51168ce85815d3 languageName: node linkType: hard @@ -14320,13 +14471,15 @@ __metadata: languageName: node linkType: hard -"jsx-ast-utils@npm:^2.4.1 || ^3.0.0, jsx-ast-utils@npm:^3.3.3": - version: 3.3.3 - resolution: "jsx-ast-utils@npm:3.3.3" +"jsx-ast-utils@npm:^2.4.1 || ^3.0.0, jsx-ast-utils@npm:^3.3.5": + version: 3.3.5 + resolution: "jsx-ast-utils@npm:3.3.5" dependencies: - array-includes: ^3.1.5 - object.assign: ^4.1.3 - checksum: a2ed78cac49a0f0c4be8b1eafe3c5257a1411341d8e7f1ac740debae003de04e5f6372bfcfbd9d082e954ffd99aac85bcda85b7c6bc11609992483f4cdc0f745 + array-includes: ^3.1.6 + array.prototype.flat: ^1.3.1 + object.assign: ^4.1.4 + object.values: ^1.1.6 + checksum: f4b05fa4d7b5234230c905cfa88d36dc8a58a6666975a3891429b1a8cdc8a140bca76c297225cb7a499fad25a2c052ac93934449a2c31a44fc9edd06c773780a languageName: node linkType: hard @@ -14367,12 +14520,12 @@ __metadata: languageName: node linkType: hard -"keyv@npm:^4.0.0": - version: 4.5.2 - resolution: "keyv@npm:4.5.2" +"keyv@npm:^4.0.0, keyv@npm:^4.5.3": + version: 4.5.4 + resolution: "keyv@npm:4.5.4" dependencies: json-buffer: 3.0.1 - checksum: 13ad58303acd2261c0d4831b4658451603fd159e61daea2121fcb15feb623e75ee328cded0572da9ca76b7b3ceaf8e614f1806c6b3af5db73c9c35a345259651 + checksum: 74a24395b1c34bd44ad5cb2b49140d087553e170625240b86755a6604cd65aa16efdbdeae5cdb17ba1284a0fbb25ad06263755dbc71b8d8b06f74232ce3cdd72 languageName: node linkType: hard @@ -14391,25 +14544,25 @@ __metadata: linkType: hard "klona@npm:^2.0.4": - version: 2.0.5 - resolution: "klona@npm:2.0.5" - checksum: 8c976126ea252b766e648a4866e1bccff9d3b08432474ad80c559f6c7265cf7caede2498d463754d8c88c4759895edd8210c85c0d3155e6aae4968362889466f + version: 2.0.6 + resolution: "klona@npm:2.0.6" + checksum: ac9ee3732e42b96feb67faae4d27cf49494e8a3bf3fa7115ce242fe04786788e0aff4741a07a45a2462e2079aa983d73d38519c85d65b70ef11447bbc3c58ce7 languageName: node linkType: hard -"language-subtag-registry@npm:~0.3.2": - version: 0.3.22 - resolution: "language-subtag-registry@npm:0.3.22" - checksum: 8ab70a7e0e055fe977ac16ea4c261faec7205ac43db5e806f72e5b59606939a3b972c4bd1e10e323b35d6ffa97c3e1c4c99f6553069dad2dfdd22020fa3eb56a +"language-subtag-registry@npm:^0.3.20": + version: 0.3.23 + resolution: "language-subtag-registry@npm:0.3.23" + checksum: 0b64c1a6c5431c8df648a6d25594ff280613c886f4a1a542d9b864e5472fb93e5c7856b9c41595c38fac31370328fc79fcc521712e89ea6d6866cbb8e0995d81 languageName: node linkType: hard -"language-tags@npm:=1.0.5": - version: 1.0.5 - resolution: "language-tags@npm:1.0.5" +"language-tags@npm:^1.0.9": + version: 1.0.9 + resolution: "language-tags@npm:1.0.9" dependencies: - language-subtag-registry: ~0.3.2 - checksum: c81b5d8b9f5f9cfd06ee71ada6ddfe1cf83044dd5eeefcd1e420ad491944da8957688db4a0a9bc562df4afdc2783425cbbdfd152c01d93179cf86888903123cf + language-subtag-registry: ^0.3.20 + checksum: 57c530796dc7179914dee71bc94f3747fd694612480241d0453a063777265dfe3a951037f7acb48f456bf167d6eb419d4c00263745326b3ba1cdcf4657070e78 languageName: node linkType: hard @@ -14484,9 +14637,9 @@ __metadata: linkType: hard "lilconfig@npm:^2.0.3": - version: 2.0.6 - resolution: "lilconfig@npm:2.0.6" - checksum: 40a3cd72f103b1be5975f2ac1850810b61d4053e20ab09be8d3aeddfe042187e1ba70b4651a7e70f95efa1642e7dc8b2ae395b317b7d7753b241b43cef7c0f7d + version: 2.1.0 + resolution: "lilconfig@npm:2.1.0" + checksum: 8549bb352b8192375fed4a74694cd61ad293904eee33f9d4866c2192865c44c4eb35d10782966242634e0cbc1e91fe62b1247f148dc5514918e3a966da7ea117 languageName: node linkType: hard @@ -14578,18 +14731,18 @@ __metadata: linkType: hard "load-bmfont@npm:^1.3.1, load-bmfont@npm:^1.4.0": - version: 1.4.1 - resolution: "load-bmfont@npm:1.4.1" + version: 1.4.2 + resolution: "load-bmfont@npm:1.4.2" dependencies: buffer-equal: 0.0.1 mime: ^1.3.4 parse-bmfont-ascii: ^1.0.3 parse-bmfont-binary: ^1.0.5 parse-bmfont-xml: ^1.1.4 - phin: ^2.9.1 + phin: ^3.7.1 xhr: ^2.0.1 xtend: ^4.0.0 - checksum: 688d932fb0dc4c9333747736ccd926261f0b91734b7bdb6ff24f8659ef068a0f0b2278084b208851afac0beec79af7bd6664fe2ed5b6c5e1db88755fc25f785e + checksum: 7a86ac766e7c5f35fb985f65d97ff8cecab91db3d15b86e5f617d0228d373059c713553177cb66f9a59d51cca00c5ed3f6a63ba33fc47e48421bbe9899556e97 languageName: node linkType: hard @@ -14603,14 +14756,14 @@ __metadata: languageName: node linkType: hard -"loader-runner@npm:^4.2.0": - version: 4.3.0 - resolution: "loader-runner@npm:4.3.0" - checksum: a90e00dee9a16be118ea43fec3192d0b491fe03a32ed48a4132eb61d498f5536a03a1315531c19d284392a8726a4ecad71d82044c28d7f22ef62e029bf761569 +"loader-runner@npm:^4.3.1": + version: 4.3.1 + resolution: "loader-runner@npm:4.3.1" + checksum: 14689a39a79b286d3d15f2199384d6132d62ea707abd6c7e50dc8a1f80c20cbfdd5344f7e6b4a7346974696689ab1a96f8ec7d1e8bf206c5264561502658bd3c languageName: node linkType: hard -"loader-utils@npm:^1.4.0": +"loader-utils@npm:^1.2.3, loader-utils@npm:^1.4.0": version: 1.4.2 resolution: "loader-utils@npm:1.4.2" dependencies: @@ -14621,7 +14774,7 @@ __metadata: languageName: node linkType: hard -"loader-utils@npm:^2.0.0, loader-utils@npm:^2.0.3": +"loader-utils@npm:^2.0.0, loader-utils@npm:^2.0.4": version: 2.0.4 resolution: "loader-utils@npm:2.0.4" dependencies: @@ -14633,9 +14786,9 @@ __metadata: linkType: hard "loader-utils@npm:^3.2.0": - version: 3.2.1 - resolution: "loader-utils@npm:3.2.1" - checksum: 4e3ea054cdc8be1ab1f1238f49f42fdf0483039eff920fb1d442039f3f0ad4ebd11fb8e584ccdf2cb7e3c56b3d40c1832416e6408a55651b843da288960cc792 + version: 3.3.1 + resolution: "loader-utils@npm:3.3.1" + checksum: d35808e081635e5bc50228a52ed79f83e2c82bd8f7578818c12b1b4cf0b7f409d72d9b93a683ec36b9eaa93346693d3f3c8380183ba2ff81599b0829d685de39 languageName: node linkType: hard @@ -14774,13 +14927,6 @@ __metadata: languageName: node linkType: hard -"lodash.isequal@npm:^4.5.0": - version: 4.5.0 - resolution: "lodash.isequal@npm:4.5.0" - checksum: da27515dc5230eb1140ba65ff8de3613649620e8656b19a6270afe4866b7bd461d9ba2ac8a48dcc57f7adac4ee80e1de9f965d89d4d81a0ad52bb3eec2609644 - languageName: node - linkType: hard - "lodash.isfinite@npm:^3.3.2": version: 3.3.2 resolution: "lodash.isfinite@npm:3.3.2" @@ -14872,7 +15018,7 @@ __metadata: languageName: node linkType: hard -"lodash@npm:^4.17.10, lodash@npm:^4.17.11, lodash@npm:^4.17.14, lodash@npm:^4.17.15, lodash@npm:^4.17.19, lodash@npm:^4.17.20, lodash@npm:^4.17.21, lodash@npm:^4.17.4, lodash@npm:~4.17.0, lodash@npm:~4.17.19, lodash@npm:~4.17.21": +"lodash@npm:^4.17.10, lodash@npm:^4.17.14, lodash@npm:^4.17.15, lodash@npm:^4.17.19, lodash@npm:^4.17.20, lodash@npm:^4.17.21, lodash@npm:^4.17.4, lodash@npm:~4.17.0, lodash@npm:~4.17.19, lodash@npm:~4.17.21": version: 4.17.21 resolution: "lodash@npm:4.17.21" checksum: eb835a2e51d381e561e508ce932ea50a8e5a68f4ebdd771ea240d3048244a8d13658acbd502cd4829768c56f2e16bdd4340b9ea141297d472517b83868e677f7 @@ -14887,9 +15033,9 @@ __metadata: linkType: hard "longest-streak@npm:^3.0.0": - version: 3.0.1 - resolution: "longest-streak@npm:3.0.1" - checksum: 3b59c4c04ce3c70f137e339c10d574026fa3a711c45dc0e69a63a2c0ac981e57f837e1d5b64b991eee5234c4fa46fa10886a20626fb739ed3b04b77bcf6d14a8 + version: 3.1.0 + resolution: "longest-streak@npm:3.1.0" + checksum: d7f952ed004cbdb5c8bcfc4f7f5c3d65449e6c5a9e9be4505a656e3df5a57ee125f284286b4bf8ecea0c21a7b3bf2b8f9001ad506c319b9815ad6a63a47d0fd0 languageName: node linkType: hard @@ -14905,9 +15051,9 @@ __metadata: linkType: hard "lottie-web@npm:^5.9.6": - version: 5.10.2 - resolution: "lottie-web@npm:5.10.2" - checksum: 9ec80b479d8d03c079bd4f246d301f0c4aac2c4d6f8daaa79f6f3fc285aaba377c64879f6748d49c1db52b9854aea81c3203d858e9c686f7a47cd8b771d112d0 + version: 5.13.0 + resolution: "lottie-web@npm:5.13.0" + checksum: f634eddbfc49a243af598c8c3b5b2bc347c6980cb85ef3e17a394aa52e2d4d1d04ef565d9cf1581727eec598717932abf5e0e0aba111b4d64f2a9dadaeaa98e2 languageName: node linkType: hard @@ -14976,6 +15122,13 @@ __metadata: languageName: node linkType: hard +"lru-cache@npm:^11.0.0, lru-cache@npm:^11.1.0, lru-cache@npm:^11.2.1": + version: 11.2.4 + resolution: "lru-cache@npm:11.2.4" + checksum: cb8cf72b80a506593f51880bd5a765380d6d8eb82e99b2fbb2f22fe39e5f2f641d47a2509e74cc294617f32a4e90ae8f6214740fe00bc79a6178854f00419b24 + languageName: node + linkType: hard + "lru-cache@npm:^4.0.0": version: 4.1.5 resolution: "lru-cache@npm:4.1.5" @@ -14986,6 +15139,15 @@ __metadata: languageName: node linkType: hard +"lru-cache@npm:^5.1.1": + version: 5.1.1 + resolution: "lru-cache@npm:5.1.1" + dependencies: + yallist: ^3.0.2 + checksum: c154ae1cbb0c2206d1501a0e94df349653c92c8cbb25236d7e85190bcaf4567a03ac6eb43166fabfa36fd35623694da7233e88d9601fbf411a9a481d85dbd2cb + languageName: node + linkType: hard + "lru-cache@npm:^6.0.0": version: 6.0.0 resolution: "lru-cache@npm:6.0.0" @@ -14995,13 +15157,6 @@ __metadata: languageName: node linkType: hard -"lru-cache@npm:^7.7.1": - version: 7.14.1 - resolution: "lru-cache@npm:7.14.1" - checksum: d72c6713c6a6d86836a7a6523b3f1ac6764768cca47ec99341c3e76db06aacd4764620e5e2cda719a36848785a52a70e531822dc2b33fb071fa709683746c104 - languageName: node - linkType: hard - "lru-queue@npm:^0.1.0": version: 0.1.0 resolution: "lru-queue@npm:0.1.0" @@ -15018,6 +15173,15 @@ __metadata: languageName: node linkType: hard +"magic-string@npm:^0.25.1": + version: 0.25.9 + resolution: "magic-string@npm:0.25.9" + dependencies: + sourcemap-codec: ^1.4.8 + checksum: 9a0e55a15c7303fc360f9572a71cffba1f61451bc92c5602b1206c9d17f492403bf96f946dfce7483e66822d6b74607262e24392e87b0ac27b786e69a40e9b1a + languageName: node + linkType: hard + "make-dir@npm:^3.0.0, make-dir@npm:^3.0.2, make-dir@npm:^3.1.0": version: 3.1.0 resolution: "make-dir@npm:3.1.0" @@ -15027,27 +15191,22 @@ __metadata: languageName: node linkType: hard -"make-fetch-happen@npm:^10.0.3": - version: 10.2.1 - resolution: "make-fetch-happen@npm:10.2.1" +"make-fetch-happen@npm:^15.0.0": + version: 15.0.3 + resolution: "make-fetch-happen@npm:15.0.3" dependencies: - agentkeepalive: ^4.2.1 - cacache: ^16.1.0 - http-cache-semantics: ^4.1.0 - http-proxy-agent: ^5.0.0 - https-proxy-agent: ^5.0.0 - is-lambda: ^1.0.1 - lru-cache: ^7.7.1 - minipass: ^3.1.6 - minipass-collect: ^1.0.2 - minipass-fetch: ^2.0.3 + "@npmcli/agent": ^4.0.0 + cacache: ^20.0.1 + http-cache-semantics: ^4.1.1 + minipass: ^7.0.2 + minipass-fetch: ^5.0.0 minipass-flush: ^1.0.5 minipass-pipeline: ^1.2.4 - negotiator: ^0.6.3 + negotiator: ^1.0.0 + proc-log: ^6.0.0 promise-retry: ^2.0.1 - socks-proxy-agent: ^7.0.0 - ssri: ^9.0.0 - checksum: 2332eb9a8ec96f1ffeeea56ccefabcb4193693597b132cd110734d50f2928842e22b84cfa1508e921b8385cdfd06dda9ad68645fed62b50fff629a580f5fb72c + ssri: ^13.0.0 + checksum: 4fb9dbb739b33565c85dacdcff7eb9388d8f36f326a59dc13375f01af809c42c48aa5d1f4840ee36623b2461a15476e1e79e4548ca1af30b42e1e324705ac8b3 languageName: node linkType: hard @@ -15114,11 +15273,11 @@ __metadata: linkType: hard "marked@npm:^4.0.12, marked@npm:^4.0.15": - version: 4.2.2 - resolution: "marked@npm:4.2.2" + version: 4.3.0 + resolution: "marked@npm:4.3.0" bin: marked: bin/marked.js - checksum: 1593e0632ff8dee1b9c8b669f26c8ce41e675bcb08ef75052845d4943db2c4d887edacd5b2120cf99a2cc06e9fbffc346ebaf98a7555273fda6a935adbfacf50 + checksum: 0db6817893952c3ec710eb9ceafb8468bf5ae38cb0f92b7b083baa13d70b19774674be04db5b817681fa7c5c6a088f61300815e4dd75a59696f4716ad69f6260 languageName: node linkType: hard @@ -15232,8 +15391,8 @@ __metadata: linkType: hard "mdast-util-from-markdown@npm:^2.0.0": - version: 2.0.1 - resolution: "mdast-util-from-markdown@npm:2.0.1" + version: 2.0.2 + resolution: "mdast-util-from-markdown@npm:2.0.2" dependencies: "@types/mdast": ^4.0.0 "@types/unist": ^3.0.0 @@ -15247,7 +15406,7 @@ __metadata: micromark-util-symbol: ^2.0.0 micromark-util-types: ^2.0.0 unist-util-stringify-position: ^4.0.0 - checksum: 2e50be71272a1503558c599cd5766cf2743935a021f82e32bc2ae5da44f6c7dcabb9da3a6eee76ede0ec8ad2b122d1192f4fe89890aac90c76463f049f8a835d + checksum: 1ad19f48b30ac6e0cb756070c210c78ad93c26876edfb3f75127783bc6df8b9402016d8f3e9964f3d1d5430503138ec65c145e869438727e1aa7f3cebf228fba languageName: node linkType: hard @@ -15360,8 +15519,8 @@ __metadata: linkType: hard "mdast-util-to-hast@npm:^13.0.0": - version: 13.2.0 - resolution: "mdast-util-to-hast@npm:13.2.0" + version: 13.2.1 + resolution: "mdast-util-to-hast@npm:13.2.1" dependencies: "@types/hast": ^3.0.0 "@types/mdast": ^4.0.0 @@ -15372,7 +15531,7 @@ __metadata: unist-util-position: ^5.0.0 unist-util-visit: ^5.0.0 vfile: ^6.0.0 - checksum: 7e5231ff3d4e35e1421908437577fd5098141f64918ff5cc8a0f7a8a76c5407f7a3ee88d75f7a1f7afb763989c9f357475fa0ba8296c00aaff1e940098fe86a6 + checksum: 20537df653be3653c3c6ea4be09ea1f67ca2f5e6afea027fcc3cde531656dc669a5e733d34a95b08b3ee71ab164c7b24352c8212891f723ddcec74d5a046bfd6 languageName: node linkType: hard @@ -15391,18 +15550,19 @@ __metadata: linkType: hard "mdast-util-to-markdown@npm:^2.0.0": - version: 2.1.0 - resolution: "mdast-util-to-markdown@npm:2.1.0" + version: 2.1.2 + resolution: "mdast-util-to-markdown@npm:2.1.2" dependencies: "@types/mdast": ^4.0.0 "@types/unist": ^3.0.0 longest-streak: ^3.0.0 mdast-util-phrasing: ^4.0.0 mdast-util-to-string: ^4.0.0 + micromark-util-classify-character: ^2.0.0 micromark-util-decode-string: ^2.0.0 unist-util-visit: ^5.0.0 zwitch: ^2.0.0 - checksum: 3a2cf3957e23b34e2e092e6e76ae72ee0b8745955bd811baba6814cf3a3d916c3fd52264b4b58f3bb3d512a428f84a1e998b6fc7e28434e388a9ae8fb6a9c173 + checksum: 288d152bd50c00632e6e01c610bb904a220d1e226c8086c40627877959746f83ab0b872f4150cb7d910198953b1bf756e384ac3fee3e7b0ddb4517f9084c5803 languageName: node linkType: hard @@ -15531,27 +15691,27 @@ __metadata: linkType: hard "memfs@npm:^3.1.2, memfs@npm:^3.2.2": - version: 3.4.10 - resolution: "memfs@npm:3.4.10" + version: 3.5.3 + resolution: "memfs@npm:3.5.3" dependencies: - fs-monkey: ^1.0.3 - checksum: bee25e00682a440adedafb81277f1a192c31e27995236d899c5402511648645dec8a0a6c2753c36632d4522bce08ebbaa38dece15753589cbe98223a47aeab4c + fs-monkey: ^1.0.4 + checksum: 18dfdeacad7c8047b976a6ccd58bc98ba76e122ad3ca0e50a21837fe2075fc0d9aafc58ab9cf2576c2b6889da1dd2503083f2364191b695273f40969db2ecc44 languageName: node linkType: hard "memoizee@npm:^0.4.15": - version: 0.4.15 - resolution: "memoizee@npm:0.4.15" + version: 0.4.17 + resolution: "memoizee@npm:0.4.17" dependencies: - d: ^1.0.1 - es5-ext: ^0.10.53 + d: ^1.0.2 + es5-ext: ^0.10.64 es6-weak-map: ^2.0.3 event-emitter: ^0.3.5 is-promise: ^2.2.2 lru-queue: ^0.1.0 next-tick: ^1.1.0 timers-ext: ^0.1.7 - checksum: 4065d94416dbadac56edf5947bf342beca0e9f051f33ad60d7c4baf3f6ca0f3c6fdb770c5caed5a89c0ceaf9121428582f396445d591785281383d60aa883418 + checksum: 9f2fa3f55d3b053ddfb7f2ce47ea3f51aa88d4425fa3aee0daf48bd41ecb8f1787b2150b14bcf745d8c4be8e2c07da614d857e11f79a6951420bbb0029b05a9c languageName: node linkType: hard @@ -15595,8 +15755,8 @@ __metadata: linkType: hard "micromark-core-commonmark@npm:^2.0.0": - version: 2.0.1 - resolution: "micromark-core-commonmark@npm:2.0.1" + version: 2.0.3 + resolution: "micromark-core-commonmark@npm:2.0.3" dependencies: decode-named-character-reference: ^1.0.0 devlop: ^1.0.0 @@ -15614,7 +15774,7 @@ __metadata: micromark-util-subtokenize: ^2.0.0 micromark-util-symbol: ^2.0.0 micromark-util-types: ^2.0.0 - checksum: 6a9891cc883a531e090dc8dab6669945f3df9448e84216a8f2a91f9258281e6abea5ae3940fde2bd77a57dc3e0d67f2add6762aed63a378f37b09eaf7e7426c4 + checksum: cfb0fd9c895f86a4e9344f7f0344fe6bd1018945798222835248146a42430b8c7bc0b2857af574cf4e1b4ce4e5c1a35a1479942421492e37baddde8de85814dc languageName: node linkType: hard @@ -15697,189 +15857,189 @@ __metadata: linkType: hard "micromark-factory-destination@npm:^2.0.0": - version: 2.0.0 - resolution: "micromark-factory-destination@npm:2.0.0" + version: 2.0.1 + resolution: "micromark-factory-destination@npm:2.0.1" dependencies: micromark-util-character: ^2.0.0 micromark-util-symbol: ^2.0.0 micromark-util-types: ^2.0.0 - checksum: d36e65ed1c072ff4148b016783148ba7c68a078991154625723e24bda3945160268fb91079fb28618e1613c2b6e70390a8ddc544c45410288aa27b413593071a + checksum: 9c4baa9ca2ed43c061bbf40ddd3d85154c2a0f1f485de9dea41d7dd2ad994ebb02034a003b2c1dbe228ba83a0576d591f0e90e0bf978713f84ee7d7f3aa98320 languageName: node linkType: hard "micromark-factory-label@npm:^2.0.0": - version: 2.0.0 - resolution: "micromark-factory-label@npm:2.0.0" + version: 2.0.1 + resolution: "micromark-factory-label@npm:2.0.1" dependencies: devlop: ^1.0.0 micromark-util-character: ^2.0.0 micromark-util-symbol: ^2.0.0 micromark-util-types: ^2.0.0 - checksum: c021dbd0ed367610d35f2bae21209bc804d1a6d1286ffce458fd6a717f4d7fe581a7cba7d5c2d7a63757c44eb927c80d6a571d6ea7969fae1b48ab6461d109c4 + checksum: bd03f5a75f27cdbf03b894ddc5c4480fc0763061fecf9eb927d6429233c930394f223969a99472df142d570c831236134de3dc23245d23d9f046f9d0b623b5c2 languageName: node linkType: hard "micromark-factory-space@npm:^2.0.0": - version: 2.0.0 - resolution: "micromark-factory-space@npm:2.0.0" + version: 2.0.1 + resolution: "micromark-factory-space@npm:2.0.1" dependencies: micromark-util-character: ^2.0.0 micromark-util-types: ^2.0.0 - checksum: 4ffdcdc2f759887bbb356500cb460b3915ecddcb5d85c3618d7df68ad05d13ed02b1153ee1845677b7d8126df8f388288b84fcf0d943bd9c92bcc71cd7222e37 + checksum: 1bd68a017c1a66f4787506660c1e1c5019169aac3b1cb075d49ac5e360e0b2065e984d4e1d6e9e52a9d44000f2fa1c98e66a743d7aae78b4b05616bf3242ed71 languageName: node linkType: hard "micromark-factory-title@npm:^2.0.0": - version: 2.0.0 - resolution: "micromark-factory-title@npm:2.0.0" + version: 2.0.1 + resolution: "micromark-factory-title@npm:2.0.1" dependencies: micromark-factory-space: ^2.0.0 micromark-util-character: ^2.0.0 micromark-util-symbol: ^2.0.0 micromark-util-types: ^2.0.0 - checksum: 39e1ac23af3554e6e652e56065579bc7faf21ade7b8704b29c175871b4152b7109b790bb3cae0f7e088381139c6bac9553b8400772c3d322e4fa635f813a3578 + checksum: b4d2e4850a8ba0dff25ce54e55a3eb0d43dda88a16293f53953153288f9d84bcdfa8ca4606b2cfbb4f132ea79587bbb478a73092a349f893f5264fbcdbce2ee1 languageName: node linkType: hard "micromark-factory-whitespace@npm:^2.0.0": - version: 2.0.0 - resolution: "micromark-factory-whitespace@npm:2.0.0" + version: 2.0.1 + resolution: "micromark-factory-whitespace@npm:2.0.1" dependencies: micromark-factory-space: ^2.0.0 micromark-util-character: ^2.0.0 micromark-util-symbol: ^2.0.0 micromark-util-types: ^2.0.0 - checksum: 9587c2546d1a58b4d5472b42adf05463f6212d0449455285662d63cd8eaed89c6b159ac82713fcee5f9dd88628c24307d9533cccd8971a2f3f4d48702f8f850a + checksum: 67b3944d012a42fee9e10e99178254a04d48af762b54c10a50fcab988688799993efb038daf9f5dbc04001a97b9c1b673fc6f00e6a56997877ab25449f0c8650 languageName: node linkType: hard "micromark-util-character@npm:^2.0.0": - version: 2.1.0 - resolution: "micromark-util-character@npm:2.1.0" + version: 2.1.1 + resolution: "micromark-util-character@npm:2.1.1" dependencies: micromark-util-symbol: ^2.0.0 micromark-util-types: ^2.0.0 - checksum: 36ee910f84077cf16626fa618cfe46ac25956b3242e3166b8e8e98c5a8c524af7e5bf3d70822264b1fd2d297a36104a7eb7e3462c19c28353eaca7b0d8717594 + checksum: e9e409efe4f2596acd44587e8591b722bfc041c1577e8fe0d9c007a4776fb800f9b3637a22862ad2ba9489f4bdf72bb547fce5767dbbfe0a5e6760e2a21c6495 languageName: node linkType: hard "micromark-util-chunked@npm:^2.0.0": - version: 2.0.0 - resolution: "micromark-util-chunked@npm:2.0.0" + version: 2.0.1 + resolution: "micromark-util-chunked@npm:2.0.1" dependencies: micromark-util-symbol: ^2.0.0 - checksum: 324f95cccdae061332a8241936eaba6ef0782a1e355bac5c607ad2564fd3744929be7dc81651315a2921535747a33243e6a5606bcb64b7a56d49b6d74ea1a3d4 + checksum: f8cb2a67bcefe4bd2846d838c97b777101f0043b9f1de4f69baf3e26bb1f9885948444e3c3aec66db7595cad8173bd4567a000eb933576c233d54631f6323fe4 languageName: node linkType: hard "micromark-util-classify-character@npm:^2.0.0": - version: 2.0.0 - resolution: "micromark-util-classify-character@npm:2.0.0" + version: 2.0.1 + resolution: "micromark-util-classify-character@npm:2.0.1" dependencies: micromark-util-character: ^2.0.0 micromark-util-symbol: ^2.0.0 micromark-util-types: ^2.0.0 - checksum: 086e52904deffebb793fb1c08c94aabb8901f76958142dfc3a6282890ebaa983b285e69bd602b9d507f1b758ed38e75a994d2ad9fbbefa7de2584f67a16af405 + checksum: 4d8bbe3a6dbf69ac0fc43516866b5bab019fe3f4568edc525d4feaaaf78423fa54e6b6732b5bccbeed924455279a3758ffc9556954aafb903982598a95a02704 languageName: node linkType: hard "micromark-util-combine-extensions@npm:^2.0.0": - version: 2.0.0 - resolution: "micromark-util-combine-extensions@npm:2.0.0" + version: 2.0.1 + resolution: "micromark-util-combine-extensions@npm:2.0.1" dependencies: micromark-util-chunked: ^2.0.0 micromark-util-types: ^2.0.0 - checksum: 107c47700343f365b4ed81551e18bc3458b573c500e56ac052b2490bd548adc475216e41d2271633a8867fac66fc22ba3e0a2d74a31ed79b9870ca947eb4e3ba + checksum: 5d22fb9ee37e8143adfe128a72b50fa09568c2cc553b3c76160486c96dbbb298c5802a177a10a215144a604b381796071b5d35be1f2c2b2ee17995eda92f0c8e languageName: node linkType: hard "micromark-util-decode-numeric-character-reference@npm:^2.0.0": - version: 2.0.1 - resolution: "micromark-util-decode-numeric-character-reference@npm:2.0.1" + version: 2.0.2 + resolution: "micromark-util-decode-numeric-character-reference@npm:2.0.2" dependencies: micromark-util-symbol: ^2.0.0 - checksum: 9512507722efd2033a9f08715eeef787fbfe27e23edf55db21423d46d82ab46f76c89b4f960be3f5e50a2d388d89658afc0647989cf256d051e9ea01277a1adb + checksum: ee11c8bde51e250e302050474c4a2adca094bca05c69f6cdd241af12df285c48c88d19ee6e022b9728281c280be16328904adca994605680c43af56019f4b0b6 languageName: node linkType: hard "micromark-util-decode-string@npm:^2.0.0": - version: 2.0.0 - resolution: "micromark-util-decode-string@npm:2.0.0" + version: 2.0.1 + resolution: "micromark-util-decode-string@npm:2.0.1" dependencies: decode-named-character-reference: ^1.0.0 micromark-util-character: ^2.0.0 micromark-util-decode-numeric-character-reference: ^2.0.0 micromark-util-symbol: ^2.0.0 - checksum: a75daf32a4a6b549e9f19b4d833ebfeb09a32a9a1f9ce50f35dec6b6a3e4f9f121f49024ba7f9c91c55ebe792f7c7a332fc9604795181b6a612637df0df5b959 + checksum: e9546ae53f9b5a4f9aa6aaf3e750087100d3429485ca80dbacec99ff2bb15a406fa7d93784a0fc2fe05ad7296b9295e75160ef71faec9e90110b7be2ae66241a languageName: node linkType: hard "micromark-util-encode@npm:^2.0.0": - version: 2.0.0 - resolution: "micromark-util-encode@npm:2.0.0" - checksum: 853a3f33fce72aaf4ffa60b7f2b6fcfca40b270b3466e1b96561b02185d2bd8c01dd7948bc31a24ac014f4cc854e545ca9a8e9cf7ea46262f9d24c9e88551c66 + version: 2.0.1 + resolution: "micromark-util-encode@npm:2.0.1" + checksum: be890b98e78dd0cdd953a313f4148c4692cc2fb05533e56fef5f421287d3c08feee38ca679f318e740530791fc251bfe8c80efa926fcceb4419b269c9343d226 languageName: node linkType: hard "micromark-util-html-tag-name@npm:^2.0.0": - version: 2.0.0 - resolution: "micromark-util-html-tag-name@npm:2.0.0" - checksum: d786d4486f93eb0ac5b628779809ca97c5dc60f3c9fc03eb565809831db181cf8cb7f05f9ac76852f3eb35461af0f89fa407b46f3a03f4f97a96754d8dc540d8 + version: 2.0.1 + resolution: "micromark-util-html-tag-name@npm:2.0.1" + checksum: dea365f5ad28ad74ff29fcb581f7b74fc1f80271c5141b3b2bc91c454cbb6dfca753f28ae03730d657874fcbd89d0494d0e3965dfdca06d9855f467c576afa9d languageName: node linkType: hard "micromark-util-normalize-identifier@npm:^2.0.0": - version: 2.0.0 - resolution: "micromark-util-normalize-identifier@npm:2.0.0" + version: 2.0.1 + resolution: "micromark-util-normalize-identifier@npm:2.0.1" dependencies: micromark-util-symbol: ^2.0.0 - checksum: b36da2d3fd102053dadd953ce5c558328df12a63a8ac0e5aad13d4dda8e43b6a5d4a661baafe0a1cd8a260bead4b4a8e6e0e74193dd651e8484225bd4f4e68aa + checksum: 1eb9a289d7da067323df9fdc78bfa90ca3207ad8fd893ca02f3133e973adcb3743b233393d23d95c84ccaf5d220ae7f5a28402a644f135dcd4b8cfa60a7b5f84 languageName: node linkType: hard "micromark-util-resolve-all@npm:^2.0.0": - version: 2.0.0 - resolution: "micromark-util-resolve-all@npm:2.0.0" + version: 2.0.1 + resolution: "micromark-util-resolve-all@npm:2.0.1" dependencies: micromark-util-types: ^2.0.0 - checksum: 31fe703b85572cb3f598ebe32750e59516925c7ff1f66cfe6afaebe0771a395a9eaa770787f2523d3c46082ea80e6c14f83643303740b3d650af7c96ebd30ccc + checksum: 9275f3ddb6c26f254dd2158e66215d050454b279707a7d9ce5a3cd0eba23201021cedcb78ae1a746c1b23227dcc418ee40dd074ade195359506797a5493550cc languageName: node linkType: hard "micromark-util-sanitize-uri@npm:^2.0.0": - version: 2.0.0 - resolution: "micromark-util-sanitize-uri@npm:2.0.0" + version: 2.0.1 + resolution: "micromark-util-sanitize-uri@npm:2.0.1" dependencies: micromark-util-character: ^2.0.0 micromark-util-encode: ^2.0.0 micromark-util-symbol: ^2.0.0 - checksum: ea4c28bbffcf2430e9aff2d18554296789a8b0a1f54ac24020d1dde76624a7f93e8f2a83e88cd5a846b6d2c4287b71b1142d1b89fa7f1b0363a9b33711a141fe + checksum: d01517840c17de67aaa0b0f03bfe05fac8a41d99723cd8ce16c62f6810e99cd3695364a34c335485018e5e2c00e69031744630a1b85c6868aa2f2ca1b36daa2f languageName: node linkType: hard "micromark-util-subtokenize@npm:^2.0.0": - version: 2.0.1 - resolution: "micromark-util-subtokenize@npm:2.0.1" + version: 2.1.0 + resolution: "micromark-util-subtokenize@npm:2.1.0" dependencies: devlop: ^1.0.0 micromark-util-chunked: ^2.0.0 micromark-util-symbol: ^2.0.0 micromark-util-types: ^2.0.0 - checksum: 5d338883ad8889c63f9b262b9cae0c02a42088201981d820ae7af7aa6d38fab6585b89fd4cf2206a46a7c4002e41ee6c70e1a3e0ceb3ad8b7adcffaf166b1511 + checksum: 2e194bc8a5279d256582020500e5072a95c1094571be49043704343032e1fffbe09c862ef9c131cf5c762e296ddb54ff8bc767b3786a798524a68d1db6942934 languageName: node linkType: hard "micromark-util-symbol@npm:^2.0.0": - version: 2.0.0 - resolution: "micromark-util-symbol@npm:2.0.0" - checksum: fa4a05bff575d9fbf0ad96a1013003e3bb6087ed6b34b609a141b6c0d2137b57df594aca409a95f4c5fda199f227b56a7d8b1f82cea0768df161d8a3a3660764 + version: 2.0.1 + resolution: "micromark-util-symbol@npm:2.0.1" + checksum: fb7346950550bc85a55793dda94a8b3cb3abc068dbd7570d1162db7aee803411d06c0a5de4ae59cd945f46143bdeadd4bba02a02248fa0d18cc577babaa00044 languageName: node linkType: hard "micromark-util-types@npm:^2.0.0": - version: 2.0.0 - resolution: "micromark-util-types@npm:2.0.0" - checksum: 819fef3ab5770c37893d2a60381fb2694396c8d22803b6e103c830c3a1bc1490363c2b0470bb2acaaddad776dfbc2fc1fcfde39cb63c4f54d95121611672e3d0 + version: 2.0.2 + resolution: "micromark-util-types@npm:2.0.2" + checksum: 884f7974839e4bc6d2bd662e57c973a9164fd5c0d8fe16cddf07472b86a7e6726747c00674952c0321d17685d700cd3295e9f58a842a53acdf6c6d55ab051aab languageName: node linkType: hard @@ -15894,8 +16054,8 @@ __metadata: linkType: hard "micromark@npm:^4.0.0": - version: 4.0.0 - resolution: "micromark@npm:4.0.0" + version: 4.0.2 + resolution: "micromark@npm:4.0.2" dependencies: "@types/debug": ^4.0.0 debug: ^4.0.0 @@ -15914,11 +16074,11 @@ __metadata: micromark-util-subtokenize: ^2.0.0 micromark-util-symbol: ^2.0.0 micromark-util-types: ^2.0.0 - checksum: b84ab5ab1a0b28c063c52e9c2c9d7d44b954507235c10c9492d66e0b38f7de24bf298f914a1fbdf109f2a57a88cf0412de217c84cfac5fd60e3e42a74dbac085 + checksum: 5306c15dd12f543755bc627fc361d4255dfc430e7af6069a07ac0eacc338fbd761fe8e93f02a8bfab6097bab12ee903192fe31389222459d5029242a5aaba3b8 languageName: node linkType: hard -"micromatch@npm:^4.0.2, micromatch@npm:^4.0.4, micromatch@npm:^4.0.5": +"micromatch@npm:^4.0.2, micromatch@npm:^4.0.4, micromatch@npm:^4.0.5, micromatch@npm:^4.0.8": version: 4.0.8 resolution: "micromatch@npm:4.0.8" dependencies: @@ -15940,14 +16100,21 @@ __metadata: languageName: node linkType: hard -"mime-db@npm:1.52.0, mime-db@npm:>= 1.43.0 < 2": +"mime-db@npm:1.52.0": version: 1.52.0 resolution: "mime-db@npm:1.52.0" checksum: 0d99a03585f8b39d68182803b12ac601d9c01abfa28ec56204fa330bc9f3d1c5e14beb049bafadb3dbdf646dfb94b87e24d4ec7b31b7279ef906a8ea9b6a513f languageName: node linkType: hard -"mime-types@npm:^2.1.12, mime-types@npm:^2.1.27, mime-types@npm:^2.1.30, mime-types@npm:~2.1.17, mime-types@npm:~2.1.19, mime-types@npm:~2.1.24, mime-types@npm:~2.1.34": +"mime-db@npm:>= 1.43.0 < 2": + version: 1.54.0 + resolution: "mime-db@npm:1.54.0" + checksum: e99aaf2f23f5bd607deb08c83faba5dd25cf2fec90a7cc5b92d8260867ee08dab65312e1a589e60093dc7796d41e5fae013268418482f1db4c7d52d0a0960ac9 + languageName: node + linkType: hard + +"mime-types@npm:^2.1.12, mime-types@npm:^2.1.27, mime-types@npm:^2.1.30, mime-types@npm:^2.1.35, mime-types@npm:~2.1.17, mime-types@npm:~2.1.19, mime-types@npm:~2.1.24, mime-types@npm:~2.1.34": version: 2.1.35 resolution: "mime-types@npm:2.1.35" dependencies: @@ -16012,11 +16179,11 @@ __metadata: linkType: hard "min-document@npm:^2.19.0": - version: 2.19.0 - resolution: "min-document@npm:2.19.0" + version: 2.19.2 + resolution: "min-document@npm:2.19.2" dependencies: dom-walk: ^0.1.0 - checksum: da6437562ea2228041542a2384528e74e22d1daa1a4ec439c165abf0b9d8a63e17e3b8a6dc6e0c731845e85301198730426932a0e813d23f932ca668340c9623 + checksum: 284737f0ac8f3b39c1dbe20e4ba007a24763e01b4d27d8896ff4e3c05f4c1e749c434dc54fa775a78193fd2564261442320a3f7bac1393674ceb37f1f8a6d20a languageName: node linkType: hard @@ -16033,15 +16200,6 @@ __metadata: languageName: node linkType: hard -"mini-svg-data-uri@npm:^1.4.4": - version: 1.4.4 - resolution: "mini-svg-data-uri@npm:1.4.4" - bin: - mini-svg-data-uri: cli.js - checksum: 997f1fbd8d59a70f03761e18626d335197a3479cb9d1ff75678e4b64b864d32a0b8fc18115eabde035e5299b8b4a354a78e57dd6ac10f9d604162a6170898d09 - languageName: node - linkType: hard - "minimalistic-assert@npm:^1.0.0, minimalistic-assert@npm:^1.0.1": version: 1.0.1 resolution: "minimalistic-assert@npm:1.0.1" @@ -16083,12 +16241,21 @@ __metadata: languageName: node linkType: hard +"minimatch@npm:^10.1.1": + version: 10.1.1 + resolution: "minimatch@npm:10.1.1" + dependencies: + "@isaacs/brace-expansion": ^5.0.0 + checksum: 8820c0be92994f57281f0a7a2cc4268dcc4b610f9a1ab666685716b4efe4b5898b43c835a8f22298875b31c7a278a5e3b7e253eee7c886546bb0b61fb94bca6b + languageName: node + linkType: hard + "minimatch@npm:^5.0.1": - version: 5.1.0 - resolution: "minimatch@npm:5.1.0" + version: 5.1.6 + resolution: "minimatch@npm:5.1.6" dependencies: brace-expansion: ^2.0.1 - checksum: 15ce53d31a06361e8b7a629501b5c75491bc2b59712d53e802b1987121d91b433d73fcc5be92974fde66b2b51d8fb28d75a9ae900d249feb792bb1ba2a4f0a90 + checksum: 7564208ef81d7065a370f788d337cd80a689e981042cb9a1d0e6580b6c6a8c9279eba80010516e258835a988363f99f54a6f711a315089b8b42694f5da9d0d77 languageName: node linkType: hard @@ -16111,33 +16278,33 @@ __metadata: linkType: hard "minimist@npm:^1.0.0, minimist@npm:^1.2.0, minimist@npm:^1.2.3, minimist@npm:^1.2.5, minimist@npm:^1.2.6": - version: 1.2.7 - resolution: "minimist@npm:1.2.7" - checksum: 7346574a1038ca23c32e02252f603801f09384dd1d78b69a943a4e8c2c28730b80e96193882d3d3b22a063445f460e48316b29b8a25addca2d7e5e8f75478bec + version: 1.2.8 + resolution: "minimist@npm:1.2.8" + checksum: 75a6d645fb122dad29c06a7597bddea977258957ed88d7a6df59b5cd3fe4a527e253e9bbf2e783e4b73657f9098b96a5fe96ab8a113655d4109108577ecf85b0 languageName: node linkType: hard -"minipass-collect@npm:^1.0.2": - version: 1.0.2 - resolution: "minipass-collect@npm:1.0.2" +"minipass-collect@npm:^2.0.1": + version: 2.0.1 + resolution: "minipass-collect@npm:2.0.1" dependencies: - minipass: ^3.0.0 - checksum: 14df761028f3e47293aee72888f2657695ec66bd7d09cae7ad558da30415fdc4752bbfee66287dcc6fd5e6a2fa3466d6c484dc1cbd986525d9393b9523d97f10 + minipass: ^7.0.3 + checksum: b251bceea62090f67a6cced7a446a36f4cd61ee2d5cea9aee7fff79ba8030e416327a1c5aa2908dc22629d06214b46d88fdab8c51ac76bacbf5703851b5ad342 languageName: node linkType: hard -"minipass-fetch@npm:^2.0.3": - version: 2.1.2 - resolution: "minipass-fetch@npm:2.1.2" +"minipass-fetch@npm:^5.0.0": + version: 5.0.0 + resolution: "minipass-fetch@npm:5.0.0" dependencies: encoding: ^0.1.13 - minipass: ^3.1.6 + minipass: ^7.0.3 minipass-sized: ^1.0.3 - minizlib: ^2.1.2 + minizlib: ^3.0.1 dependenciesMeta: encoding: optional: true - checksum: 3f216be79164e915fc91210cea1850e488793c740534985da017a4cbc7a5ff50506956d0f73bb0cb60e4fe91be08b6b61ef35101706d3ef5da2c8709b5f08f91 + checksum: 416645d1e54c09fdfe64ec1676541ac2f6f2af3abc7ad25f2f22c4518535997c1ecd2c0c586ea8a5c6499ad7d8f97671f50ff38488ada54bf61fde309f731379 languageName: node linkType: hard @@ -16168,36 +16335,28 @@ __metadata: languageName: node linkType: hard -"minipass@npm:^3.0.0, minipass@npm:^3.1.1, minipass@npm:^3.1.6": - version: 3.3.5 - resolution: "minipass@npm:3.3.5" +"minipass@npm:^3.0.0": + version: 3.3.6 + resolution: "minipass@npm:3.3.6" dependencies: yallist: ^4.0.0 - checksum: f89f02bcaa0e0e4bb4c44ec796008e69fbca62db0aba6ead1bc57d25bdaefdf42102130f4f9ecb7d9c6b6cd35ff7b0c7b97d001d3435da8e629fb68af3aea57e - languageName: node - linkType: hard - -"minipass@npm:^5.0.0": - version: 5.0.0 - resolution: "minipass@npm:5.0.0" - checksum: 425dab288738853fded43da3314a0b5c035844d6f3097a8e3b5b29b328da8f3c1af6fc70618b32c29ff906284cf6406b6841376f21caaadd0793c1d5a6a620ea + checksum: a30d083c8054cee83cdcdc97f97e4641a3f58ae743970457b1489ce38ee1167b3aaf7d815cd39ec7a99b9c40397fd4f686e83750e73e652b21cb516f6d845e48 languageName: node linkType: hard -"minipass@npm:^5.0.0 || ^6.0.2 || ^7.0.0, minipass@npm:^7.1.2": +"minipass@npm:^5.0.0 || ^6.0.2 || ^7.0.0, minipass@npm:^7.0.2, minipass@npm:^7.0.3, minipass@npm:^7.0.4, minipass@npm:^7.1.2": version: 7.1.2 resolution: "minipass@npm:7.1.2" checksum: 2bfd325b95c555f2b4d2814d49325691c7bee937d753814861b0b49d5edcda55cbbf22b6b6a60bb91eddac8668771f03c5ff647dcd9d0f798e9548b9cdc46ee3 languageName: node linkType: hard -"minizlib@npm:^2.1.1, minizlib@npm:^2.1.2": - version: 2.1.2 - resolution: "minizlib@npm:2.1.2" +"minizlib@npm:^3.0.1, minizlib@npm:^3.1.0": + version: 3.1.0 + resolution: "minizlib@npm:3.1.0" dependencies: - minipass: ^3.0.0 - yallist: ^4.0.0 - checksum: f1fdeac0b07cf8f30fcf12f4b586795b97be856edea22b5e9072707be51fc95d41487faec3f265b42973a304fe3a64acd91a44a3826a963e37b37bafde0212c3 + minipass: ^7.1.2 + checksum: a15e6f0128f514b7d41a1c68ce531155447f4669e32d279bba1c1c071ef6c2abd7e4d4579bb59ccc2ed1531346749665968fdd7be8d83eb6b6ae2fe1f3d370a7 languageName: node linkType: hard @@ -16226,7 +16385,7 @@ __metadata: languageName: node linkType: hard -"mkdirp@npm:^1.0.3, mkdirp@npm:^1.0.4, mkdirp@npm:~1.0.4": +"mkdirp@npm:^1.0.4, mkdirp@npm:~1.0.4": version: 1.0.4 resolution: "mkdirp@npm:1.0.4" bin: @@ -16236,8 +16395,8 @@ __metadata: linkType: hard "mobx-react-lite@npm:^3.4.0": - version: 3.4.0 - resolution: "mobx-react-lite@npm:3.4.0" + version: 3.4.3 + resolution: "mobx-react-lite@npm:3.4.3" peerDependencies: mobx: ^6.1.0 react: ^16.8.0 || ^17 || ^18 @@ -16246,13 +16405,13 @@ __metadata: optional: true react-native: optional: true - checksum: 9294e127e281c8b37ec7bcaf17de479f50519e6ad485b58d7b991291900511541a5a718653759d3cf6503462c70325d025e1c2ed376d4584fb1b2d3aac9d9b48 + checksum: 60a2580eb9a0b9988fc76959d7299f018733dc33cacaa73c45500953006d4d45e738d9ae39ccfc767ac19a75656dbc028d833282c848fbc67d8d18a2bcb5c262 languageName: node linkType: hard "mobx-react@npm:^7.2.0": - version: 7.5.3 - resolution: "mobx-react@npm:7.5.3" + version: 7.6.0 + resolution: "mobx-react@npm:7.6.0" dependencies: mobx-react-lite: ^3.4.0 peerDependencies: @@ -16263,34 +16422,34 @@ __metadata: optional: true react-native: optional: true - checksum: 6c1c1edc778109f789c6fa9b7a49e633e45a2b3c8fd12c7bd594f6ffec58048d21841936eaf67b0b7c19a32813fbd70fa9025a8c3bca3309f607824bd5aecd1e + checksum: 07ce6eb297ddab2cc693df7350a3e2f730194cc6eb56bd912f80e28f9427237569e0bda6b30167154faf094e7c5e5ff360abd52acd2860d9a0d0e53320617ee8 languageName: node linkType: hard "mobx@npm:^6.3.2, mobx@npm:^6.6.2": - version: 6.6.2 - resolution: "mobx@npm:6.6.2" - checksum: b913abea51ed023d60c71eec0198e953c0b7faee93820be2e8f07037a789b3acf6fd89c340cb9d34e888532ebd34d34b10add7d129277a96026537e5ca48bda6 + version: 6.15.0 + resolution: "mobx@npm:6.15.0" + checksum: bdda12556b8dec650f30d0ae4dcd84459a2415dce2376174476730bb85e063d6171045717a2b8ddda6e584d524fad5b305e2ee65e8264a57c0cbcbb6bf2a83eb languageName: node linkType: hard "moment@npm:^2.29.1": - version: 2.29.4 - resolution: "moment@npm:2.29.4" - checksum: 0ec3f9c2bcba38dc2451b1daed5daded747f17610b92427bebe1d08d48d8b7bdd8d9197500b072d14e326dd0ccf3e326b9e3d07c5895d3d49e39b6803b76e80e + version: 2.30.1 + resolution: "moment@npm:2.30.1" + checksum: 859236bab1e88c3e5802afcf797fc801acdbd0ee509d34ea3df6eea21eb6bcc2abd4ae4e4e64aa7c986aa6cba563c6e62806218e6412a765010712e5fa121ba6 languageName: node linkType: hard "morgan@npm:^1.10.0": - version: 1.10.0 - resolution: "morgan@npm:1.10.0" + version: 1.10.1 + resolution: "morgan@npm:1.10.1" dependencies: basic-auth: ~2.0.1 debug: 2.6.9 depd: ~2.0.0 on-finished: ~2.3.0 - on-headers: ~1.0.2 - checksum: fb41e226ab5a1abf7e8909e486b387076534716d60207e361acfb5df78b84d703a7b7ea58f3046a9fd0b83d3c94bfabde32323341a1f1b26ce50680abd2ea5dd + on-headers: ~1.1.0 + checksum: 8e637a2795d0f6dafb7dbc6a3ef6870731d160123cd56c496d305f1a185c9b0831699c456081328c107b3be49f25fade40519fa1b4990546040595fa44312fe3 languageName: node linkType: hard @@ -16301,14 +16460,7 @@ __metadata: languageName: node linkType: hard -"ms@npm:2.1.2": - version: 2.1.2 - resolution: "ms@npm:2.1.2" - checksum: 673cdb2c3133eb050c745908d8ce632ed2c02d85640e2edb3ace856a2266a813b30c613569bf3354fdf4ea7d1a1494add3bfa95e2713baa27d0c2c71fc44f58f - languageName: node - linkType: hard - -"ms@npm:2.1.3, ms@npm:^2.0.0, ms@npm:^2.1.1": +"ms@npm:2.1.3, ms@npm:^2.1.1, ms@npm:^2.1.3": version: 2.1.3 resolution: "ms@npm:2.1.3" checksum: aa92de608021b242401676e35cfa5aa42dd70cbdc082b916da7fb925c542173e36bce97ea3e804923fe92c0ad991434e4a38327e15a1b5b5f945d66df615ae6d @@ -16347,14 +16499,14 @@ __metadata: linkType: hard "msgpackr@npm:^1.5.4": - version: 1.11.0 - resolution: "msgpackr@npm:1.11.0" + version: 1.11.8 + resolution: "msgpackr@npm:1.11.8" dependencies: msgpackr-extract: ^3.0.2 dependenciesMeta: msgpackr-extract: optional: true - checksum: 20a1941e1a281c10a1d43d04349ae7a79bef1cbd0644f1e5acef7f98f6a6e6cd83388ee82689799f9e65623591b11f849ef2f86c8eac83492449bee5a2b055b2 + checksum: 3f5a78b835c18fb132b4c8e7494e29e5ca4375c7464953b8926baf1facf30eb848ab3156047b1c3b2a4834fd1195df6b7251edcd207f0f3d6d267a5765658816 languageName: node linkType: hard @@ -16380,19 +16532,19 @@ __metadata: languageName: node linkType: hard -"nanoid@npm:^3.3.4, nanoid@npm:^3.3.7": - version: 3.3.8 - resolution: "nanoid@npm:3.3.8" +"nanoid@npm:^3.3.11": + version: 3.3.11 + resolution: "nanoid@npm:3.3.11" bin: nanoid: bin/nanoid.cjs - checksum: dfe0adbc0c77e9655b550c333075f51bb28cfc7568afbf3237249904f9c86c9aaaed1f113f0fddddba75673ee31c758c30c43d4414f014a52a7a626efc5958c9 + checksum: 3be20d8866a57a6b6d218e82549711c8352ed969f9ab3c45379da28f405363ad4c9aeb0b39e9abc101a529ca65a72ff9502b00bf74a912c4b64a9d62dfd26c29 languageName: node linkType: hard -"napi-build-utils@npm:^1.0.1": - version: 1.0.2 - resolution: "napi-build-utils@npm:1.0.2" - checksum: 06c14271ee966e108d55ae109f340976a9556c8603e888037145d6522726aebe89dd0c861b4b83947feaf6d39e79e08817559e8693deedc2c94e82c5cbd090c7 +"napi-build-utils@npm:^2.0.0": + version: 2.0.0 + resolution: "napi-build-utils@npm:2.0.0" + checksum: 532121efd2dd2272595580bca48859e404bdd4ed455a72a28432ba44868c38d0e64fac3026a8f82bf8563d2a18b32eb9a1d59e601a9da4e84ba4d45b922297f5 languageName: node linkType: hard @@ -16416,21 +16568,35 @@ __metadata: languageName: node linkType: hard -"negotiator@npm:0.6.3, negotiator@npm:^0.6.3, negotiator@npm:~0.6.2": +"negotiator@npm:0.6.3": version: 0.6.3 resolution: "negotiator@npm:0.6.3" checksum: b8ffeb1e262eff7968fc90a2b6767b04cfd9842582a9d0ece0af7049537266e7b2506dfb1d107a32f06dd849ab2aea834d5830f7f4d0e5cb7d36e1ae55d021d9 languageName: node linkType: hard -"neo-async@npm:^2.6.0, neo-async@npm:^2.6.2": +"negotiator@npm:^1.0.0": + version: 1.0.0 + resolution: "negotiator@npm:1.0.0" + checksum: 20ebfe79b2d2e7cf9cbc8239a72662b584f71164096e6e8896c8325055497c96f6b80cd22c258e8a2f2aa382a787795ec3ee8b37b422a302c7d4381b0d5ecfbb + languageName: node + linkType: hard + +"negotiator@npm:~0.6.2, negotiator@npm:~0.6.4": + version: 0.6.4 + resolution: "negotiator@npm:0.6.4" + checksum: 7ded10aa02a0707d1d12a9973fdb5954f98547ca7beb60e31cb3a403cc6e8f11138db7a3b0128425cf836fc85d145ec4ce983b2bdf83dca436af879c2d683510 + languageName: node + linkType: hard + +"neo-async@npm:^2.6.2": version: 2.6.2 resolution: "neo-async@npm:2.6.2" checksum: deac9f8d00eda7b2e5cd1b2549e26e10a0faa70adaa6fdadca701cc55f49ee9018e427f424bac0c790b7c7e2d3068db97f3093f1093975f2acb8f8818b936ed9 languageName: node linkType: hard -"next-tick@npm:1, next-tick@npm:^1.1.0": +"next-tick@npm:^1.1.0": version: 1.1.0 resolution: "next-tick@npm:1.1.0" checksum: 83b5cf36027a53ee6d8b7f9c0782f2ba87f4858d977342bfc3c20c21629290a2111f8374d13a81221179603ffc4364f38374b5655d17b6a8f8a8c77bdea4fe8b @@ -16471,38 +16637,38 @@ __metadata: linkType: hard "node-abi@npm:^3.3.0": - version: 3.28.0 - resolution: "node-abi@npm:3.28.0" + version: 3.85.0 + resolution: "node-abi@npm:3.85.0" dependencies: semver: ^7.3.5 - checksum: ed8db5e58fc9e1400a3f74d8815b6981208a4fca2031e2c5f5986f58f7e3a1f4161dae82c655f9114892b3f46c21c02feec10fbac0f8ffcfd26a3d57447093d1 + checksum: 173eb81d61a5844498c89586f1492fb1823e26aa5656e2aff2d427584c7213190314e2d41180a8c3750b5dcf90325796481e8527dad71c5a16f93bc11762d7ac languageName: node linkType: hard -"node-addon-api@npm:^3.2.1": - version: 3.2.1 - resolution: "node-addon-api@npm:3.2.1" +"node-addon-api@npm:^4.3.0": + version: 4.3.0 + resolution: "node-addon-api@npm:4.3.0" dependencies: node-gyp: latest - checksum: 2369986bb0881ccd9ef6bacdf39550e07e089a9c8ede1cbc5fc7712d8e2faa4d50da0e487e333d4125f8c7a616c730131d1091676c9d499af1d74560756b4a18 + checksum: 3de396e23cc209f539c704583e8e99c148850226f6e389a641b92e8967953713228109f919765abc1f4355e801e8f41842f96210b8d61c7dcc10a477002dcf00 languageName: node linkType: hard -"node-addon-api@npm:^4.3.0": - version: 4.3.0 - resolution: "node-addon-api@npm:4.3.0" +"node-addon-api@npm:^5.0.0": + version: 5.1.0 + resolution: "node-addon-api@npm:5.1.0" dependencies: node-gyp: latest - checksum: 3de396e23cc209f539c704583e8e99c148850226f6e389a641b92e8967953713228109f919765abc1f4355e801e8f41842f96210b8d61c7dcc10a477002dcf00 + checksum: 2508bd2d2981945406243a7bd31362fc7af8b70b8b4d65f869c61731800058fb818cc2fd36c8eac714ddd0e568cc85becf5e165cebbdf7b5024d5151bbc75ea1 languageName: node linkType: hard -"node-addon-api@npm:^5.0.0": - version: 5.0.0 - resolution: "node-addon-api@npm:5.0.0" +"node-addon-api@npm:^7.0.0": + version: 7.1.1 + resolution: "node-addon-api@npm:7.1.1" dependencies: node-gyp: latest - checksum: 7c5e2043ac37f6108784d94ed73a44ae6d3e68eb968de60680922fc6bc3d17fa69448c0feb4e0c9d3f4c74a0324822e566a8340a56916d9d6f23cb3e85620334 + checksum: 46051999e3289f205799dfaf6bcb017055d7569090f0004811110312e2db94cb4f8654602c7eb77a60a1a05142cc2b96e1b5c56ca4622c41a5c6370787faaf30 languageName: node linkType: hard @@ -16515,20 +16681,6 @@ __metadata: languageName: node linkType: hard -"node-fetch@npm:2.6.7, node-fetch@npm:^2.6.1, node-fetch@npm:^2.6.6, node-fetch@npm:^2.6.7": - version: 2.6.7 - resolution: "node-fetch@npm:2.6.7" - dependencies: - whatwg-url: ^5.0.0 - peerDependencies: - encoding: ^0.1.0 - peerDependenciesMeta: - encoding: - optional: true - checksum: 8d816ffd1ee22cab8301c7756ef04f3437f18dace86a1dae22cf81db8ef29c0bf6655f3215cb0cdb22b420b6fe141e64b26905e7f33f9377a7fa59135ea3e10b - languageName: node - linkType: hard - "node-fetch@npm:^1.0.1": version: 1.7.3 resolution: "node-fetch@npm:1.7.3" @@ -16539,6 +16691,20 @@ __metadata: languageName: node linkType: hard +"node-fetch@npm:^2.6.1, node-fetch@npm:^2.6.6, node-fetch@npm:^2.6.7, node-fetch@npm:^2.7.0": + version: 2.7.0 + resolution: "node-fetch@npm:2.7.0" + dependencies: + whatwg-url: ^5.0.0 + peerDependencies: + encoding: ^0.1.0 + peerDependenciesMeta: + encoding: + optional: true + checksum: d76d2f5edb451a3f05b15115ec89fc6be39de37c6089f1b6368df03b91e1633fd379a7e01b7ab05089a25034b2023d959b47e59759cb38d88341b2459e89d6e5 + languageName: node + linkType: hard + "node-gyp-build-optional-packages@npm:5.0.3": version: 5.0.3 resolution: "node-gyp-build-optional-packages@npm:5.0.3" @@ -16563,34 +16729,34 @@ __metadata: languageName: node linkType: hard -"node-gyp-build@npm:^4.3.0": - version: 4.5.0 - resolution: "node-gyp-build@npm:4.5.0" +"node-gyp-build@npm:^4.8.4": + version: 4.8.4 + resolution: "node-gyp-build@npm:4.8.4" bin: node-gyp-build: bin.js node-gyp-build-optional: optional.js node-gyp-build-test: build-test.js - checksum: d888bae0fb88335f69af1b57a2294a931c5042f36e413d8d364c992c9ebfa0b96ffe773179a5a2c8f04b73856e8634e09cce108dbb9804396d3cc8c5455ff2db + checksum: 8b81ca8ffd5fa257ad8d067896d07908a36918bc84fb04647af09d92f58310def2d2b8614d8606d129d9cd9b48890a5d2bec18abe7fcff54818f72bedd3a7d74 languageName: node linkType: hard "node-gyp@npm:latest": - version: 9.3.0 - resolution: "node-gyp@npm:9.3.0" + version: 12.1.0 + resolution: "node-gyp@npm:12.1.0" dependencies: env-paths: ^2.2.0 - glob: ^7.1.4 + exponential-backoff: ^3.1.1 graceful-fs: ^4.2.6 - make-fetch-happen: ^10.0.3 - nopt: ^6.0.0 - npmlog: ^6.0.0 - rimraf: ^3.0.2 + make-fetch-happen: ^15.0.0 + nopt: ^9.0.0 + proc-log: ^6.0.0 semver: ^7.3.5 - tar: ^6.1.2 - which: ^2.0.2 + tar: ^7.5.2 + tinyglobby: ^0.2.12 + which: ^6.0.0 bin: node-gyp: bin/node-gyp.js - checksum: 589ddd3ed967724ef425f9624bfa47cf73022640ab3eba6d556e92cdc4ddef33b63fce3a467c93b995a3f61df92eafd3c3d1e8dbe4a2c00c383334487dea99c3 + checksum: 198d91c535fe9940bcdc0db4e578f94cf9872e0d068e88ef2f4656924248bb67245b270b48eded6634c7513841c0cd42f3da3ac9d77c8e16437fcd90703b9ef3 languageName: node linkType: hard @@ -16658,39 +16824,43 @@ __metadata: languageName: node linkType: hard -"node-releases@npm:^2.0.14": - version: 2.0.18 - resolution: "node-releases@npm:2.0.18" - checksum: ef55a3d853e1269a6d6279b7692cd6ff3e40bc74947945101138745bfdc9a5edabfe72cb19a31a8e45752e1910c4c65c77d931866af6357f242b172b7283f5b3 +"node-releases@npm:^2.0.27": + version: 2.0.27 + resolution: "node-releases@npm:2.0.27" + checksum: a9a54079d894704c2ec728a690b41fbc779a710f5d47b46fa3e460acff08a3e7dfa7108e5599b2db390aa31dac062c47c5118317201f12784188dc5b415f692d languageName: node linkType: hard -"node-releases@npm:^2.0.6": - version: 2.0.6 - resolution: "node-releases@npm:2.0.6" - checksum: e86a926dc9fbb3b41b4c4a89d998afdf140e20a4e8dbe6c0a807f7b2948b42ea97d7fd3ad4868041487b6e9ee98409829c6e4d84a734a4215dff060a7fbeb4bf +"nopt@npm:^7.2.0, nopt@npm:^7.2.1": + version: 7.2.1 + resolution: "nopt@npm:7.2.1" + dependencies: + abbrev: ^2.0.0 + bin: + nopt: bin/nopt.js + checksum: 6fa729cc77ce4162cfad8abbc9ba31d4a0ff6850c3af61d59b505653bef4781ec059f8890ecfe93ee8aa0c511093369cca88bfc998101616a2904e715bbbb7c9 languageName: node linkType: hard -"nopt@npm:^6.0.0": - version: 6.0.0 - resolution: "nopt@npm:6.0.0" +"nopt@npm:^8.0.0": + version: 8.1.0 + resolution: "nopt@npm:8.1.0" dependencies: - abbrev: ^1.0.0 + abbrev: ^3.0.0 bin: nopt: bin/nopt.js - checksum: 82149371f8be0c4b9ec2f863cc6509a7fd0fa729929c009f3a58e4eb0c9e4cae9920e8f1f8eb46e7d032fec8fb01bede7f0f41a67eb3553b7b8e14fa53de1dac + checksum: 49cfd3eb6f565e292bf61f2ff1373a457238804d5a5a63a8d786c923007498cba89f3648e3b952bc10203e3e7285752abf5b14eaf012edb821e84f24e881a92a languageName: node linkType: hard -"nopt@npm:^7.2.0, nopt@npm:^7.2.1": - version: 7.2.1 - resolution: "nopt@npm:7.2.1" +"nopt@npm:^9.0.0": + version: 9.0.0 + resolution: "nopt@npm:9.0.0" dependencies: - abbrev: ^2.0.0 + abbrev: ^4.0.0 bin: nopt: bin/nopt.js - checksum: 6fa729cc77ce4162cfad8abbc9ba31d4a0ff6850c3af61d59b505653bef4781ec059f8890ecfe93ee8aa0c511093369cca88bfc998101616a2904e715bbbb7c9 + checksum: 7a5d9ab0629eaec1944a95438cc4efa6418ed2834aa8eb21a1bea579a7d8ac3e30120131855376a96ef59ab0e23ad8e0bc94d3349770a95e5cb7119339f7c7fb languageName: node linkType: hard @@ -16744,13 +16914,6 @@ __metadata: languageName: node linkType: hard -"normalize-range@npm:^0.1.2": - version: 0.1.2 - resolution: "normalize-range@npm:0.1.2" - checksum: 9b2f14f093593f367a7a0834267c24f3cb3e887a2d9809c77d8a7e5fd08738bcd15af46f0ab01cc3a3d660386f015816b5c922cea8bf2ee79777f40874063184 - languageName: node - linkType: hard - "normalize-url@npm:^4.1.0": version: 4.5.1 resolution: "normalize-url@npm:4.5.1" @@ -16830,18 +16993,6 @@ __metadata: languageName: node linkType: hard -"npmlog@npm:^6.0.0": - version: 6.0.2 - resolution: "npmlog@npm:6.0.2" - dependencies: - are-we-there-yet: ^3.0.0 - console-control-strings: ^1.1.0 - gauge: ^4.0.3 - set-blocking: ^2.0.0 - checksum: ae238cd264a1c3f22091cdd9e2b106f684297d3c184f1146984ecbe18aaa86343953f26b9520dedd1b1372bc0316905b736c1932d778dbeb1fcf5a1001390e2a - languageName: node - linkType: hard - "nth-check@npm:^1.0.1, nth-check@npm:~1.0.1": version: 1.0.2 resolution: "nth-check@npm:1.0.2" @@ -16880,9 +17031,9 @@ __metadata: linkType: hard "nwsapi@npm:^2.0.7, nwsapi@npm:^2.2.2": - version: 2.2.2 - resolution: "nwsapi@npm:2.2.2" - checksum: 43769106292bc95f776756ca2f3513dab7b4d506a97c67baec32406447841a35f65f29c1f95ab5d42785210fd41668beed33ca16fa058780be43b101ad73e205 + version: 2.2.23 + resolution: "nwsapi@npm:2.2.23" + checksum: 7af519de08381df9dc0c913d817255cb21e33671641603f6cdabe8cb04b18b32aca1477fdc5dfe08b2039125afa3216d3ef01a3c2603a97d114e842d9414e0c3 languageName: node linkType: hard @@ -16958,27 +17109,20 @@ __metadata: languageName: node linkType: hard -"object-inspect@npm:^1.12.2, object-inspect@npm:^1.9.0": - version: 1.12.2 - resolution: "object-inspect@npm:1.12.2" - checksum: a534fc1b8534284ed71f25ce3a496013b7ea030f3d1b77118f6b7b1713829262be9e6243acbcb3ef8c626e2b64186112cb7f6db74e37b2789b9c789ca23048b2 - languageName: node - linkType: hard - -"object-inspect@npm:^1.13.1": - version: 1.13.2 - resolution: "object-inspect@npm:1.13.2" - checksum: 9f850b3c045db60e0e97746e809ee4090d6ce62195af17dd1e9438ac761394a7d8ec4f7906559aea5424eaf61e35d3e53feded2ccd5f62fcc7d9670d3c8eb353 +"object-inspect@npm:^1.13.3, object-inspect@npm:^1.13.4": + version: 1.13.4 + resolution: "object-inspect@npm:1.13.4" + checksum: 582810c6a8d2ef988ea0a39e69e115a138dad8f42dd445383b394877e5816eb4268489f316a6f74ee9c4e0a984b3eab1028e3e79d62b1ed67c726661d55c7a8b languageName: node linkType: hard "object-is@npm:^1.1.5": - version: 1.1.5 - resolution: "object-is@npm:1.1.5" + version: 1.1.6 + resolution: "object-is@npm:1.1.6" dependencies: - call-bind: ^1.0.2 - define-properties: ^1.1.3 - checksum: 989b18c4cba258a6b74dc1d74a41805c1a1425bce29f6cabb50dcb1a6a651ea9104a1b07046739a49a5bb1bc49727bcb00efd5c55f932f6ea04ec8927a7901fe + call-bind: ^1.0.7 + define-properties: ^1.2.1 + checksum: 3ea22759967e6f2380a2cbbd0f737b42dc9ddb2dfefdb159a1b927fea57335e1b058b564bfa94417db8ad58cddab33621a035de6f5e5ad56d89f2dd03e66c6a1 languageName: node linkType: hard @@ -16989,15 +17133,17 @@ __metadata: languageName: node linkType: hard -"object.assign@npm:^4.1.0, object.assign@npm:^4.1.3, object.assign@npm:^4.1.4": - version: 4.1.4 - resolution: "object.assign@npm:4.1.4" +"object.assign@npm:^4.1.0, object.assign@npm:^4.1.4, object.assign@npm:^4.1.7": + version: 4.1.7 + resolution: "object.assign@npm:4.1.7" dependencies: - call-bind: ^1.0.2 - define-properties: ^1.1.4 - has-symbols: ^1.0.3 + call-bind: ^1.0.8 + call-bound: ^1.0.3 + define-properties: ^1.2.1 + es-object-atoms: ^1.0.0 + has-symbols: ^1.1.0 object-keys: ^1.1.1 - checksum: 76cab513a5999acbfe0ff355f15a6a125e71805fcf53de4e9d4e082e1989bdb81d1e329291e1e4e0ae7719f0e4ef80e88fb2d367ae60500d79d25a6224ac8864 + checksum: 60e07d2651cf4f5528c485f1aa4dbded9b384c47d80e8187cefd11320abb1aebebf78df5483451dfa549059f8281c21f7b4bf7d19e9e5e97d8d617df0df298de languageName: node linkType: hard @@ -17013,35 +17159,38 @@ __metadata: languageName: node linkType: hard -"object.entries@npm:^1.1.5, object.entries@npm:^1.1.6": - version: 1.1.6 - resolution: "object.entries@npm:1.1.6" +"object.entries@npm:^1.1.9": + version: 1.1.9 + resolution: "object.entries@npm:1.1.9" dependencies: - call-bind: ^1.0.2 - define-properties: ^1.1.4 - es-abstract: ^1.20.4 - checksum: 0f8c47517e6a9a980241eafe3b73de11e59511883173c2b93d67424a008e47e11b77c80e431ad1d8a806f6108b225a1cab9223e53e555776c612a24297117d28 + call-bind: ^1.0.8 + call-bound: ^1.0.4 + define-properties: ^1.2.1 + es-object-atoms: ^1.1.1 + checksum: 0ab2ef331c4d6a53ff600a5d69182948d453107c3a1f7fd91bc29d387538c2aba21d04949a74f57c21907208b1f6fb175567fd1f39f1a7a4046ba1bca762fb41 languageName: node linkType: hard -"object.fromentries@npm:^2.0.5, object.fromentries@npm:^2.0.6": - version: 2.0.6 - resolution: "object.fromentries@npm:2.0.6" +"object.fromentries@npm:^2.0.8": + version: 2.0.8 + resolution: "object.fromentries@npm:2.0.8" dependencies: - call-bind: ^1.0.2 - define-properties: ^1.1.4 - es-abstract: ^1.20.4 - checksum: 453c6d694180c0c30df451b60eaf27a5b9bca3fb43c37908fd2b78af895803dc631242bcf05582173afa40d8d0e9c96e16e8874b39471aa53f3ac1f98a085d85 + call-bind: ^1.0.7 + define-properties: ^1.2.1 + es-abstract: ^1.23.2 + es-object-atoms: ^1.0.0 + checksum: 29b2207a2db2782d7ced83f93b3ff5d425f901945f3665ffda1821e30a7253cd1fd6b891a64279976098137ddfa883d748787a6fea53ecdb51f8df8b8cec0ae1 languageName: node linkType: hard -"object.hasown@npm:^1.1.1": - version: 1.1.2 - resolution: "object.hasown@npm:1.1.2" +"object.groupby@npm:^1.0.3": + version: 1.0.3 + resolution: "object.groupby@npm:1.0.3" dependencies: - define-properties: ^1.1.4 - es-abstract: ^1.20.4 - checksum: b936572536db0cdf38eb30afd2f1026a8b6f2cc5d2c4497c9d9bbb01eaf3e980dead4fd07580cfdd098e6383e5a9db8212d3ea0c6bdd2b5e68c60aa7e3b45566 + call-bind: ^1.0.7 + define-properties: ^1.2.1 + es-abstract: ^1.23.2 + checksum: 0d30693ca3ace29720bffd20b3130451dca7a56c612e1926c0a1a15e4306061d84410bdb1456be2656c5aca53c81b7a3661eceaa362db1bba6669c2c9b6d1982 languageName: node linkType: hard @@ -17073,14 +17222,15 @@ __metadata: languageName: node linkType: hard -"object.values@npm:^1.1.5": - version: 1.1.6 - resolution: "object.values@npm:1.1.6" +"object.values@npm:^1.1.6, object.values@npm:^1.2.1": + version: 1.2.1 + resolution: "object.values@npm:1.2.1" dependencies: - call-bind: ^1.0.2 - define-properties: ^1.1.4 - es-abstract: ^1.20.4 - checksum: f6fff9fd817c24cfd8107f50fb33061d81cd11bacc4e3dbb3852e9ff7692fde4dbce823d4333ea27cd9637ef1b6690df5fbb61f1ed314fa2959598dc3ae23d8e + call-bind: ^1.0.8 + call-bound: ^1.0.3 + define-properties: ^1.2.1 + es-object-atoms: ^1.0.0 + checksum: f9b9a2a125ccf8ded29414d7c056ae0d187b833ee74919821fc60d7e216626db220d9cb3cf33f965c84aaaa96133626ca13b80f3c158b673976dc8cfcfcd26bb languageName: node linkType: hard @@ -17091,28 +17241,28 @@ __metadata: languageName: node linkType: hard -"on-finished@npm:2.4.1": - version: 2.4.1 - resolution: "on-finished@npm:2.4.1" +"on-finished@npm:~2.3.0": + version: 2.3.0 + resolution: "on-finished@npm:2.3.0" dependencies: ee-first: 1.1.1 - checksum: d20929a25e7f0bb62f937a425b5edeb4e4cde0540d77ba146ec9357f00b0d497cdb3b9b05b9c8e46222407d1548d08166bff69cc56dfa55ba0e4469228920ff0 + checksum: 1db595bd963b0124d6fa261d18320422407b8f01dc65863840f3ddaaf7bcad5b28ff6847286703ca53f4ec19595bd67a2f1253db79fc4094911ec6aa8df1671b languageName: node linkType: hard -"on-finished@npm:~2.3.0": - version: 2.3.0 - resolution: "on-finished@npm:2.3.0" +"on-finished@npm:~2.4.1": + version: 2.4.1 + resolution: "on-finished@npm:2.4.1" dependencies: ee-first: 1.1.1 - checksum: 1db595bd963b0124d6fa261d18320422407b8f01dc65863840f3ddaaf7bcad5b28ff6847286703ca53f4ec19595bd67a2f1253db79fc4094911ec6aa8df1671b + checksum: d20929a25e7f0bb62f937a425b5edeb4e4cde0540d77ba146ec9357f00b0d497cdb3b9b05b9c8e46222407d1548d08166bff69cc56dfa55ba0e4469228920ff0 languageName: node linkType: hard -"on-headers@npm:~1.0.2": - version: 1.0.2 - resolution: "on-headers@npm:1.0.2" - checksum: 2bf13467215d1e540a62a75021e8b318a6cfc5d4fc53af8e8f84ad98dbcea02d506c6d24180cd62e1d769c44721ba542f3154effc1f7579a8288c9f7873ed8e5 +"on-headers@npm:~1.1.0": + version: 1.1.0 + resolution: "on-headers@npm:1.1.0" + checksum: 98aa64629f986fb8cc4517dd8bede73c980e31208cba97f4442c330959f60ced3dc6214b83420491f5111fc7c4f4343abe2ea62c85f505cf041d67850f238776 languageName: node linkType: hard @@ -17144,7 +17294,7 @@ __metadata: languageName: node linkType: hard -"open@npm:^8.0.0": +"open@npm:^8.0.0, open@npm:^8.4.0": version: 8.4.2 resolution: "open@npm:8.4.2" dependencies: @@ -17155,24 +17305,14 @@ __metadata: languageName: node linkType: hard -"open@npm:^8.4.0": - version: 8.4.0 - resolution: "open@npm:8.4.0" - dependencies: - define-lazy-prop: ^2.0.0 - is-docker: ^2.1.1 - is-wsl: ^2.2.0 - checksum: e9545bec64cdbf30a0c35c1bdc310344adf8428a117f7d8df3c0af0a0a24c513b304916a6d9b11db0190ff7225c2d578885080b761ed46a3d5f6f1eebb98b63c - languageName: node - linkType: hard - "openapi-sampler@npm:^1.3.0": - version: 1.3.0 - resolution: "openapi-sampler@npm:1.3.0" + version: 1.6.2 + resolution: "openapi-sampler@npm:1.6.2" dependencies: "@types/json-schema": ^7.0.7 + fast-xml-parser: ^4.5.0 json-pointer: 0.6.2 - checksum: 5f4e8612ae4d8ffe21f3b0d972879828675c3de812b3c2a0a436c7191847384c888d0ee5812c6aa5318d2a82b102db56b00e9ac06da5e9d290343790c9c93776 + checksum: 0cac3b377eeff4ee5363ed7c3f6a02f091c6238bcf098d472604b9b1ab6f71a5359a7e63cb3942dfb621091950693e62d44d2ed94eb771e003ab747a6afba81a languageName: node linkType: hard @@ -17198,23 +17338,23 @@ __metadata: linkType: hard "optionator@npm:^0.9.1": - version: 0.9.1 - resolution: "optionator@npm:0.9.1" + version: 0.9.4 + resolution: "optionator@npm:0.9.4" dependencies: deep-is: ^0.1.3 fast-levenshtein: ^2.0.6 levn: ^0.4.1 prelude-ls: ^1.2.1 type-check: ^0.4.0 - word-wrap: ^1.2.3 - checksum: dbc6fa065604b24ea57d734261914e697bd73b69eff7f18e967e8912aa2a40a19a9f599a507fa805be6c13c24c4eae8c71306c239d517d42d4c041c942f508a0 + word-wrap: ^1.2.5 + checksum: ecbd010e3dc73e05d239976422d9ef54a82a13f37c11ca5911dff41c98a6c7f0f163b27f922c37e7f8340af9d36febd3b6e9cef508f3339d4c393d7276d716bb languageName: node linkType: hard "ordered-binary@npm:^1.2.4": - version: 1.4.0 - resolution: "ordered-binary@npm:1.4.0" - checksum: 951fecb400b4e4e5176983679994cb7eb0a3ed1da8406d2bb1f7e76417cb61af85ea557d184cccfa3fe50b4c1582a69a4b2e20625f0d56083330b11bf1bcdeb4 + version: 1.6.1 + resolution: "ordered-binary@npm:1.6.1" + checksum: 88161a4830411a09fe90d4dbada5339770dd7ff9410d778b1ace0c27dfdfedaf53d7f999b277b2c8105046f8221c4d20c29e6fdb15606bd8590ffb86029b2d44 languageName: node linkType: hard @@ -17249,6 +17389,17 @@ __metadata: languageName: node linkType: hard +"own-keys@npm:^1.0.1": + version: 1.0.1 + resolution: "own-keys@npm:1.0.1" + dependencies: + get-intrinsic: ^1.2.6 + object-keys: ^1.1.1 + safe-push-apply: ^1.0.0 + checksum: cc9dd7d85c4ccfbe8109fce307d581ac7ede7b26de892b537873fbce2dc6a206d89aea0630dbb98e47ce0873517cefeaa7be15fcf94aaf4764a3b34b474a5b61 + languageName: node + linkType: hard + "p-cancelable@npm:^1.0.0": version: 1.1.0 resolution: "p-cancelable@npm:1.1.0" @@ -17347,12 +17498,10 @@ __metadata: languageName: node linkType: hard -"p-map@npm:^4.0.0": - version: 4.0.0 - resolution: "p-map@npm:4.0.0" - dependencies: - aggregate-error: ^3.0.0 - checksum: cb0ab21ec0f32ddffd31dfc250e3afa61e103ef43d957cc45497afe37513634589316de4eb88abdfd969fe6410c22c0b93ab24328833b8eb1ccc087fc0442a1c +"p-map@npm:^7.0.2": + version: 7.0.4 + resolution: "p-map@npm:7.0.4" + checksum: 4be2097e942f2fd3a4f4b0c6585c721f23851de8ad6484d20c472b3ea4937d5cd9a59914c832b1bceac7bf9d149001938036b82a52de0bc381f61ff2d35d26a5 languageName: node linkType: hard @@ -17383,9 +17532,9 @@ __metadata: linkType: hard "package-json-from-dist@npm:^1.0.0": - version: 1.0.0 - resolution: "package-json-from-dist@npm:1.0.0" - checksum: ac706ec856a5a03f5261e4e48fa974f24feb044d51f84f8332e2af0af04fbdbdd5bbbfb9cbbe354190409bc8307c83a9e38c6672c3c8855f709afb0006a009ea + version: 1.0.1 + resolution: "package-json-from-dist@npm:1.0.1" + checksum: 58ee9538f2f762988433da00e26acc788036914d57c71c246bf0be1b60cdbd77dd60b6a3e1a30465f0b248aeb80079e0b34cb6050b1dfa18c06953bb1cbc7602 languageName: node linkType: hard @@ -17436,30 +17585,16 @@ __metadata: languageName: node linkType: hard -"parse-asn1@npm:^5.0.0": - version: 5.1.6 - resolution: "parse-asn1@npm:5.1.6" - dependencies: - asn1.js: ^5.2.0 - browserify-aes: ^1.0.0 - evp_bytestokey: ^1.0.0 - pbkdf2: ^3.0.3 - safe-buffer: ^5.1.1 - checksum: 9243311d1f88089bc9f2158972aa38d1abd5452f7b7cabf84954ed766048fe574d434d82c6f5a39b988683e96fb84cd933071dda38927e03469dc8c8d14463c7 - languageName: node - linkType: hard - -"parse-asn1@npm:^5.1.7": - version: 5.1.7 - resolution: "parse-asn1@npm:5.1.7" +"parse-asn1@npm:^5.0.0, parse-asn1@npm:^5.1.9": + version: 5.1.9 + resolution: "parse-asn1@npm:5.1.9" dependencies: asn1.js: ^4.10.1 browserify-aes: ^1.2.0 evp_bytestokey: ^1.0.3 - hash-base: ~3.0 - pbkdf2: ^3.1.2 + pbkdf2: ^3.1.5 safe-buffer: ^5.2.1 - checksum: 93c7194c1ed63a13e0b212d854b5213ad1aca0ace41c66b311e97cca0519cf9240f79435a0306a3b412c257f0ea3f1953fd0d9549419a0952c9e995ab361fd6c + checksum: c85a34d15774e8bbb353291b8373a78f0e5b246803ef0e117fbf2f9a27616ea2d6db675fda77ce4cafcb1d18fb9074135fed6c450e3acfe8c915b51da0340ed6 languageName: node linkType: hard @@ -17478,12 +17613,12 @@ __metadata: linkType: hard "parse-bmfont-xml@npm:^1.1.4": - version: 1.1.4 - resolution: "parse-bmfont-xml@npm:1.1.4" + version: 1.1.6 + resolution: "parse-bmfont-xml@npm:1.1.6" dependencies: xml-parse-from-string: ^1.0.0 - xml2js: ^0.4.5 - checksum: 879e5435be44f22b8c4934e2e1d2754a6d90a9ddb16309360daff965e1428d877b673f3d1fafaab4fef437c912a0db9f85545e0dd375ec62df7d4d328450d257 + xml2js: ^0.5.0 + checksum: ec4a33d5e75f0a70d72bc40060b192956cce12c46157b6dde9be1d07c2f0c8f68b6d9ad84775eb259af2d9bb6b26f0759b0c21ab2e4c7812cf96d4fae99233b0 languageName: node linkType: hard @@ -17546,9 +17681,9 @@ __metadata: linkType: hard "parse-headers@npm:^2.0.0": - version: 2.0.5 - resolution: "parse-headers@npm:2.0.5" - checksum: 3e97f01e4c7f960bfbfd0ee489f0bd8d3c72b6c814f1f79b66abec2cca8eaf8e4ecd89deba0b6e61266469aed87350bc932001181c01ff8c29a59e696abe251f + version: 2.0.6 + resolution: "parse-headers@npm:2.0.6" + checksum: 1f1139d7fbaafc9aec4004e270f04b260602d233b639eb83fb28d67858b43022756202a44c7f20684377906602416872df3300cc2953bcb78ec2f0311b9f77bd languageName: node linkType: hard @@ -17596,11 +17731,11 @@ __metadata: linkType: hard "parse-path@npm:^7.0.0": - version: 7.0.0 - resolution: "parse-path@npm:7.0.0" + version: 7.1.0 + resolution: "parse-path@npm:7.1.0" dependencies: protocols: ^2.0.0 - checksum: 244b46523a58181d251dda9b888efde35d8afb957436598d948852f416d8c76ddb4f2010f9fc94218b4be3e5c0f716aa0d2026194a781e3b8981924142009302 + checksum: 1da6535a967b14911837bba98e5f8d16acb415b28753ff6225e3121dce71167a96c79278fbb631d695210dadae37462a9eff40d93b9c659cf1ce496fd5db9bb6 languageName: node linkType: hard @@ -17620,13 +17755,22 @@ __metadata: languageName: node linkType: hard -"parse5-htmlparser2-tree-adapter@npm:^7.0.0": - version: 7.0.0 - resolution: "parse5-htmlparser2-tree-adapter@npm:7.0.0" +"parse5-htmlparser2-tree-adapter@npm:^7.0.0, parse5-htmlparser2-tree-adapter@npm:^7.1.0": + version: 7.1.0 + resolution: "parse5-htmlparser2-tree-adapter@npm:7.1.0" + dependencies: + domhandler: ^5.0.3 + parse5: ^7.0.0 + checksum: 98326fc5443e2149e10695adbfd0b0b3383c54398799f858b4ac2914adb199af8fcc90c2143aa5f7fd5f9482338f26ef253b468722f34d50bb215ec075d89fe9 + languageName: node + linkType: hard + +"parse5-parser-stream@npm:^7.1.2": + version: 7.1.2 + resolution: "parse5-parser-stream@npm:7.1.2" dependencies: - domhandler: ^5.0.2 parse5: ^7.0.0 - checksum: fc5d01e07733142a1baf81de5c2a9c41426c04b7ab29dd218acb80cd34a63177c90aff4a4aee66cf9f1d0aeecff1389adb7452ad6f8af0a5888e3e9ad6ef733d + checksum: 75b232d460bce6bd0e35012750a78ef034f40ccf550b7c6cec3122395af6b4553202ad3663ad468cf537ead5a2e13b6727670395fd0ff548faccad1dc2dc93cf languageName: node linkType: hard @@ -17644,12 +17788,12 @@ __metadata: languageName: node linkType: hard -"parse5@npm:^7.0.0, parse5@npm:^7.1.1": - version: 7.1.1 - resolution: "parse5@npm:7.1.1" +"parse5@npm:^7.0.0, parse5@npm:^7.1.1, parse5@npm:^7.3.0": + version: 7.3.0 + resolution: "parse5@npm:7.3.0" dependencies: - entities: ^4.4.0 - checksum: 8f72fbfa6df83a3f29f58e1818f7bd46b47ff3e26d79c74e10b8fc7ef7ee76163f205113f1b2f6a5b8dc4e31e726f490444f04890cead6e974dbcbe8172b1321 + entities: ^6.0.0 + checksum: ffd040c4695d93f0bc370e3d6d75c1b352178514af41be7afa212475ea5cead1d6e377cd9d4cec6a5e2bcf497ca50daf9e0088eadaa37dbc271f60def08fdfcd languageName: node linkType: hard @@ -17695,12 +17839,12 @@ __metadata: linkType: hard "password-prompt@npm:^1.0.4": - version: 1.1.2 - resolution: "password-prompt@npm:1.1.2" + version: 1.1.3 + resolution: "password-prompt@npm:1.1.3" dependencies: - ansi-escapes: ^3.1.0 - cross-spawn: ^6.0.5 - checksum: 4763ec1b48cb311d60df37186e31f1b85ec3249a21cc17bbf8407d66c5b55cffe34b4eb529ebd044ed4ced7f3ea3fad744fe15e30a5de31645433e94cd444266 + ansi-escapes: ^4.3.2 + cross-spawn: ^7.0.3 + checksum: 9a5fdbd7360db896809704c141acfe9258450a9982c4c177b82a1e6c69d204800cdab6064abac6736bd7d31142c80108deedf4484146594747cb3ce776816e97 languageName: node linkType: hard @@ -17819,10 +17963,20 @@ __metadata: languageName: node linkType: hard -"path-to-regexp@npm:0.1.10": - version: 0.1.10 - resolution: "path-to-regexp@npm:0.1.10" - checksum: ab7a3b7a0b914476d44030340b0a65d69851af2a0f33427df1476100ccb87d409c39e2182837a96b98fb38c4ef2ba6b87bdad62bb70a2c153876b8061760583c +"path-scurry@npm:^2.0.0": + version: 2.0.1 + resolution: "path-scurry@npm:2.0.1" + dependencies: + lru-cache: ^11.0.0 + minipass: ^7.1.2 + checksum: a022c6c38fed836079d03f96540eafd4cd989acf287b99613c82300107f366e889513ad8b671a2039a9d251122621f9c6fa649f0bd4d50acf95a6943a6692dbf + languageName: node + linkType: hard + +"path-to-regexp@npm:~0.1.12": + version: 0.1.12 + resolution: "path-to-regexp@npm:0.1.12" + checksum: ab237858bee7b25ecd885189f175ab5b5161e7b712b360d44f5c4516b8d271da3e4bf7bf0a7b9153ecb04c7d90ce8ff5158614e1208819cf62bac2b08452722e languageName: node linkType: hard @@ -17833,17 +17987,17 @@ __metadata: languageName: node linkType: hard -"pbkdf2@npm:^3.0.3, pbkdf2@npm:^3.1.2": - version: 3.1.3 - resolution: "pbkdf2@npm:3.1.3" +"pbkdf2@npm:^3.1.2, pbkdf2@npm:^3.1.5": + version: 3.1.5 + resolution: "pbkdf2@npm:3.1.5" dependencies: - create-hash: ~1.1.3 + create-hash: ^1.2.0 create-hmac: ^1.1.7 - ripemd160: =2.0.1 + ripemd160: ^2.0.3 safe-buffer: ^5.2.1 - sha.js: ^2.4.11 - to-buffer: ^1.2.0 - checksum: afd1ec13044343ad877065b806d5b4d7625806139d22bec46cb146d1d52bb8debf4200767e33672b681e024307048e558a16f5997d86838d95552b88fa546530 + sha.js: ^2.4.12 + to-buffer: ^1.2.1 + checksum: 377dd4791ae6e439c98ca2a120d1cb28375884aab04af98ea1e51e5304d69c3102d0d8ed915fd1e9908cb93744807202eb22b64d99ba6496697db9b2c4ee64cc languageName: node linkType: hard @@ -17862,9 +18016,9 @@ __metadata: linkType: hard "perfect-scrollbar@npm:^1.5.5": - version: 1.5.5 - resolution: "perfect-scrollbar@npm:1.5.5" - checksum: 7a8d3097e91df1dd112f28ee9539c1a36ae7a836d986798af2e0d1e32c3ef21380215b3c06bc12434d89547d7f763637ac19b877549049b6c2166da85956c9dc + version: 1.5.6 + resolution: "perfect-scrollbar@npm:1.5.6" + checksum: 5e1eaede41a08c687fec1eef90a63a936b693224604cc1c9a4c96cbc3d2cc374a4c0d1128d3682ee2cf8271c4dbe20a9202def371a2ecb1e574a3e321971292b languageName: node linkType: hard @@ -17882,6 +18036,15 @@ __metadata: languageName: node linkType: hard +"phin@npm:^3.7.1": + version: 3.7.1 + resolution: "phin@npm:3.7.1" + dependencies: + centra: ^2.7.0 + checksum: eebbfb0ab63d90f1513a2da05ef5ccc4bfb17216567fe62e9f0b8a4da27ff301b6409da8dcada6a66711c040b318ffb456e1adf24e8d261e24a916d30d91aadf + languageName: node + linkType: hard + "physical-cpu-count@npm:^2.0.0": version: 2.0.0 resolution: "physical-cpu-count@npm:2.0.0" @@ -17896,27 +18059,27 @@ __metadata: languageName: node linkType: hard -"picocolors@npm:^1.0.0": - version: 1.0.0 - resolution: "picocolors@npm:1.0.0" - checksum: a2e8092dd86c8396bdba9f2b5481032848525b3dc295ce9b57896f931e63fc16f79805144321f72976383fc249584672a75cc18d6777c6b757603f372f745981 - languageName: node - linkType: hard - -"picocolors@npm:^1.0.1": - version: 1.0.1 - resolution: "picocolors@npm:1.0.1" - checksum: fa68166d1f56009fc02a34cdfd112b0dd3cf1ef57667ac57281f714065558c01828cdf4f18600ad6851cbe0093952ed0660b1e0156bddf2184b6aaf5817553a5 +"picocolors@npm:^1.0.0, picocolors@npm:^1.1.1": + version: 1.1.1 + resolution: "picocolors@npm:1.1.1" + checksum: e1cf46bf84886c79055fdfa9dcb3e4711ad259949e3565154b004b260cd356c5d54b31a1437ce9782624bf766272fe6b0154f5f0c744fb7af5d454d2b60db045 languageName: node linkType: hard -"picomatch@npm:^2.0.4, picomatch@npm:^2.2.1, picomatch@npm:^2.3.0, picomatch@npm:^2.3.1": +"picomatch@npm:^2.0.4, picomatch@npm:^2.2.1, picomatch@npm:^2.3.1": version: 2.3.1 resolution: "picomatch@npm:2.3.1" checksum: 050c865ce81119c4822c45d3c84f1ced46f93a0126febae20737bd05ca20589c564d6e9226977df859ed5e03dc73f02584a2b0faad36e896936238238b0446cf languageName: node linkType: hard +"picomatch@npm:^4.0.3": + version: 4.0.3 + resolution: "picomatch@npm:4.0.3" + checksum: 6817fb74eb745a71445debe1029768de55fd59a42b75606f478ee1d0dc1aa6e78b711d041a7c9d5550e042642029b7f373dc1a43b224c4b7f12d23436735dba0 + languageName: node + linkType: hard + "pify@npm:^4.0.1": version: 4.0.1 resolution: "pify@npm:4.0.1" @@ -17982,11 +18145,11 @@ __metadata: linkType: hard "polished@npm:^4.1.3": - version: 4.2.2 - resolution: "polished@npm:4.2.2" + version: 4.3.1 + resolution: "polished@npm:4.3.1" dependencies: "@babel/runtime": ^7.17.8 - checksum: 97fb927dc55cd34aeb11b31ae2a3332463f114351c86e8aa6580d7755864a0120164fdc3770e6160c8b1775052f0eda14db9a6e34402cd4b08ab2d658a593725 + checksum: a6f863c23f1d2f3f5cda3427b5885c9fb9e83b036d681e24820b143c7df40d2685bebb01c0939767120a28e1183671ae17c93db82ac30b3c20942180bb153bc7 languageName: node linkType: hard @@ -18019,17 +18182,17 @@ __metadata: languageName: node linkType: hard -"postcss-colormin@npm:^5.3.0": - version: 5.3.0 - resolution: "postcss-colormin@npm:5.3.0" +"postcss-colormin@npm:^5.3.1": + version: 5.3.1 + resolution: "postcss-colormin@npm:5.3.1" dependencies: - browserslist: ^4.16.6 + browserslist: ^4.21.4 caniuse-api: ^3.0.0 colord: ^2.9.1 postcss-value-parser: ^4.2.0 peerDependencies: postcss: ^8.2.15 - checksum: 3d3e3cc25071407fb73d68541ca1039ebd154fceb649041461a8a3cab0400cc89b42dbb34a4eeaf573be4ba2370ce23af5e01aff5e03a8d72275f40605577212 + checksum: e5778baab30877cd1f51e7dc9d2242a162aeca6360a52956acd7f668c5bc235c2ccb7e4df0370a804d65ebe00c5642366f061db53aa823f9ed99972cebd16024 languageName: node linkType: hard @@ -18116,9 +18279,9 @@ __metadata: languageName: node linkType: hard -"postcss-merge-rules@npm:^5.1.3": - version: 5.1.3 - resolution: "postcss-merge-rules@npm:5.1.3" +"postcss-merge-rules@npm:^5.1.4": + version: 5.1.4 + resolution: "postcss-merge-rules@npm:5.1.4" dependencies: browserslist: ^4.21.4 caniuse-api: ^3.0.0 @@ -18126,7 +18289,7 @@ __metadata: postcss-selector-parser: ^6.0.5 peerDependencies: postcss: ^8.2.15 - checksum: 0ddaddff98cd7f3fac2b0e716c641f529a61a8668be6d5b48d60770d0a1246126088e1d606f309b9748ff598a3794f3fd6dd5b8c3d79112f84744cab5375d4d9 + checksum: 8ab6a569babe6cb412d6612adee74f053cea7edb91fa013398515ab36754b1fec830d68782ed8cdfb44cffdc6b78c79eab157bff650f428aa4460d3f3857447e languageName: node linkType: hard @@ -18179,35 +18342,35 @@ __metadata: linkType: hard "postcss-modules-extract-imports@npm:^3.0.0": - version: 3.0.0 - resolution: "postcss-modules-extract-imports@npm:3.0.0" + version: 3.1.0 + resolution: "postcss-modules-extract-imports@npm:3.1.0" peerDependencies: postcss: ^8.1.0 - checksum: 4b65f2f1382d89c4bc3c0a1bdc5942f52f3cb19c110c57bd591ffab3a5fee03fcf831604168205b0c1b631a3dce2255c70b61aaae3ef39d69cd7eb450c2552d2 + checksum: b9192e0f4fb3d19431558be6f8af7ca45fc92baaad9b2778d1732a5880cd25c3df2074ce5484ae491e224f0d21345ffc2d419bd51c25b019af76d7a7af88c17f languageName: node linkType: hard "postcss-modules-local-by-default@npm:^4.0.0": - version: 4.0.0 - resolution: "postcss-modules-local-by-default@npm:4.0.0" + version: 4.2.0 + resolution: "postcss-modules-local-by-default@npm:4.2.0" dependencies: icss-utils: ^5.0.0 - postcss-selector-parser: ^6.0.2 + postcss-selector-parser: ^7.0.0 postcss-value-parser: ^4.1.0 peerDependencies: postcss: ^8.1.0 - checksum: 6cf570badc7bc26c265e073f3ff9596b69bb954bc6ac9c5c1b8cba2995b80834226b60e0a3cbb87d5f399dbb52e6466bba8aa1d244f6218f99d834aec431a69d + checksum: 720d145453f82ad5f1c1d0ff7386d64722f0812808e4132e573c1a49909745e109fcce3792a0b0cb18770dbeb3d9741867e81c698dc8353a18bc664b7d6d9533 languageName: node linkType: hard "postcss-modules-scope@npm:^3.0.0": - version: 3.0.0 - resolution: "postcss-modules-scope@npm:3.0.0" + version: 3.2.1 + resolution: "postcss-modules-scope@npm:3.2.1" dependencies: - postcss-selector-parser: ^6.0.4 + postcss-selector-parser: ^7.0.0 peerDependencies: postcss: ^8.1.0 - checksum: 330b9398dbd44c992c92b0dc612c0626135e2cc840fee41841eb61247a6cfed95af2bd6f67ead9dd9d0bb41f5b0367129d93c6e434fa3e9c58ade391d9a5a138 + checksum: 085f65863bb7d8bf08209a979ceb22b2b07bb466574e0e698d34aaad832d614957bb05f2418348a14e4035f65e23b2be2951369d26ea429dd5762c6a020f0f7c languageName: node linkType: hard @@ -18333,15 +18496,15 @@ __metadata: languageName: node linkType: hard -"postcss-reduce-initial@npm:^5.1.1": - version: 5.1.1 - resolution: "postcss-reduce-initial@npm:5.1.1" +"postcss-reduce-initial@npm:^5.1.2": + version: 5.1.2 + resolution: "postcss-reduce-initial@npm:5.1.2" dependencies: browserslist: ^4.21.4 caniuse-api: ^3.0.0 peerDependencies: postcss: ^8.2.15 - checksum: 1b704aba8c38103cbb5a75c6201dbf58ec2f3a978013c7f7e8957fd3bf3282f992050dec5a01bc050d031bad836e187dd6622b922ca78ab92bcd0afd21fb0b98 + checksum: 55db697f85231a81f1969d54c894e4773912d9ddb914f9b03d2e73abc4030f2e3bef4d7465756d0c1acfcc2c2d69974bfb50a972ab27546a7d68b5a4fc90282b languageName: node linkType: hard @@ -18356,13 +18519,23 @@ __metadata: languageName: node linkType: hard -"postcss-selector-parser@npm:^6.0.2, postcss-selector-parser@npm:^6.0.4, postcss-selector-parser@npm:^6.0.5, postcss-selector-parser@npm:^6.0.9": - version: 6.0.10 - resolution: "postcss-selector-parser@npm:6.0.10" +"postcss-selector-parser@npm:^6.0.4, postcss-selector-parser@npm:^6.0.5, postcss-selector-parser@npm:^6.0.9": + version: 6.1.2 + resolution: "postcss-selector-parser@npm:6.1.2" + dependencies: + cssesc: ^3.0.0 + util-deprecate: ^1.0.2 + checksum: ce9440fc42a5419d103f4c7c1847cb75488f3ac9cbe81093b408ee9701193a509f664b4d10a2b4d82c694ee7495e022f8f482d254f92b7ffd9ed9dea696c6f84 + languageName: node + linkType: hard + +"postcss-selector-parser@npm:^7.0.0": + version: 7.1.1 + resolution: "postcss-selector-parser@npm:7.1.1" dependencies: cssesc: ^3.0.0 util-deprecate: ^1.0.2 - checksum: 46afaa60e3d1998bd7adf6caa374baf857cc58d3ff944e29459c9a9e4680a7fe41597bd5b755fc81d7c388357e9bf67c0251d047c640a09f148e13606b8a8608 + checksum: 36d71bd8e1c9db9c3d4ecefd3f8c30aace141a3a1a266473bc9a1b7a0c1c2dfbaef2ac20cc8ea287b17131cbb3690c1c0fe7a4d9272db9f09b136da2413bc3ea languageName: node linkType: hard @@ -18406,25 +18579,14 @@ __metadata: languageName: node linkType: hard -"postcss@npm:^8.2.15, postcss@npm:^8.2.9, postcss@npm:^8.3.11, postcss@npm:^8.4.16": - version: 8.4.19 - resolution: "postcss@npm:8.4.19" - dependencies: - nanoid: ^3.3.4 - picocolors: ^1.0.0 - source-map-js: ^1.0.2 - checksum: 62782723a385f92b7525f66d29614624de7c5643855423db3a5efd9287e677650300192749adddbbb6734cea9b1d5f5fd4f6ea00ca3f9a95dbbb88f835f5ca64 - languageName: node - linkType: hard - -"postcss@npm:^8.4.19": - version: 8.4.39 - resolution: "postcss@npm:8.4.39" +"postcss@npm:^8.2.15, postcss@npm:^8.2.9, postcss@npm:^8.3.11, postcss@npm:^8.4.16, postcss@npm:^8.4.19": + version: 8.5.6 + resolution: "postcss@npm:8.5.6" dependencies: - nanoid: ^3.3.7 - picocolors: ^1.0.1 - source-map-js: ^1.2.0 - checksum: 14b130c90f165961772bdaf99c67f907f3d16494adf0868e57ef68baa67e0d1f6762db9d41ab0f4d09bab6fb7888588dba3596afd1a235fd5c2d43fba7006ac6 + nanoid: ^3.3.11 + picocolors: ^1.1.1 + source-map-js: ^1.2.1 + checksum: 20f3b5d673ffeec2b28d65436756d31ee33f65b0a8bedb3d32f556fbd5973be38c3a7fb5b959a5236c60a5db7b91b0a6b14ffaac0d717dce1b903b964ee1c1bb languageName: node linkType: hard @@ -18438,31 +18600,31 @@ __metadata: linkType: hard "preact-render-to-string@npm:^6.5.5": - version: 6.5.5 - resolution: "preact-render-to-string@npm:6.5.5" + version: 6.6.5 + resolution: "preact-render-to-string@npm:6.6.5" peerDependencies: - preact: ">=10" - checksum: 4b2309be252d25b85a6c942e1874560eb19d2b0efa9a0aa247ad4b882b0de0f812a28a94d8d9b9ef5c9a3c3d27e8291e7ee529f95a480447ee48022a73a6465f + preact: ">=10 || >= 11.0.0-0" + checksum: 63e049d22adbafa071ec26df41a50caf918f496feb12f2113f637f6361259466a8e9c1e9d211355f124af9f59cb63c5ca644a6a8849d35f8ddf37ae9f092193d languageName: node linkType: hard "preact@npm:^10.11.0": - version: 10.11.2 - resolution: "preact@npm:10.11.2" - checksum: 92b4087a4048595e43fc5c005e9a1f3c890ec83657689de9b40b1894e26f8c2b6b071c63e08941a44044d1612532f8313483b62e3d6e1aa3c39bde27614ed790 + version: 10.28.2 + resolution: "preact@npm:10.28.2" + checksum: 5f65087ab00ab270ca514e43b5aaba79101da92eb2ea3199a2b54776a159032b0ee4749a529f624ccc7d456c71b56ddeed2cbcd92cd1e6a3b4dcecfaa7cacf36 languageName: node linkType: hard "prebuild-install@npm:^7.1.1": - version: 7.1.1 - resolution: "prebuild-install@npm:7.1.1" + version: 7.1.3 + resolution: "prebuild-install@npm:7.1.3" dependencies: detect-libc: ^2.0.0 expand-template: ^2.0.3 github-from-package: 0.0.0 minimist: ^1.2.3 mkdirp-classic: ^0.5.3 - napi-build-utils: ^1.0.1 + napi-build-utils: ^2.0.0 node-abi: ^3.3.0 pump: ^3.0.0 rc: ^1.2.7 @@ -18471,7 +18633,7 @@ __metadata: tunnel-agent: ^0.6.0 bin: prebuild-install: bin.js - checksum: dbf96d0146b6b5827fc8f67f72074d2e19c69628b9a7a0a17d0fad1bf37e9f06922896972e074197fc00a52eae912993e6ef5a0d471652f561df5cb516f3f467 + checksum: 300740ca415e9ddbf2bd363f1a6d2673cc11dd0665c5ec431bbb5bf024c2f13c56791fb939ce2b2a2c12f2d2a09c91316169e8063a80eb4482a44b8fe5b265e1 languageName: node linkType: hard @@ -18547,6 +18709,13 @@ __metadata: languageName: node linkType: hard +"proc-log@npm:^6.0.0": + version: 6.1.0 + resolution: "proc-log@npm:6.1.0" + checksum: ac450ff8244e95b0c9935b52d629fef92ae69b7e39aea19972a8234259614d644402dd62ce9cb094f4a637d8a4514cba90c1456ad785a40ad5b64d502875a817 + languageName: node + linkType: hard + "process-nextick-args@npm:~2.0.0": version: 2.0.1 resolution: "process-nextick-args@npm:2.0.1" @@ -18661,9 +18830,9 @@ __metadata: linkType: hard "protocols@npm:^2.0.0, protocols@npm:^2.0.1": - version: 2.0.1 - resolution: "protocols@npm:2.0.1" - checksum: 4a9bef6aa0449a0245ded319ac3cbfd032c3e76ebb562777037a3a832c99253d0e8bc2847f7be350236df620a11f7d4fe683ea7f59a2cc14c69f746b6259eda4 + version: 2.0.2 + resolution: "protocols@npm:2.0.2" + checksum: 031cc068eb800468a50eb7c1e1c528bf142fb8314f5df9b9ea3c3f9df1697a19f97b9915b1229cef694d156812393172d9c3051ef7878d26eaa8c6faa5cccec4 languageName: node linkType: hard @@ -18685,13 +18854,15 @@ __metadata: linkType: hard "psl@npm:^1.1.28, psl@npm:^1.1.33": - version: 1.9.0 - resolution: "psl@npm:1.9.0" - checksum: 20c4277f640c93d393130673f392618e9a8044c6c7bf61c53917a0fddb4952790f5f362c6c730a9c32b124813e173733f9895add8d26f566ed0ea0654b2e711d + version: 1.15.0 + resolution: "psl@npm:1.15.0" + dependencies: + punycode: ^2.3.1 + checksum: 6f777d82eecfe1c2406dadbc15e77467b186fec13202ec887a45d0209a2c6fca530af94a462a477c3c4a767ad892ec9ede7c482d98f61f653dd838b50e89dc15 languageName: node linkType: hard -"public-encrypt@npm:^4.0.0": +"public-encrypt@npm:^4.0.3": version: 4.0.3 resolution: "public-encrypt@npm:4.0.3" dependencies: @@ -18706,33 +18877,26 @@ __metadata: linkType: hard "pump@npm:^3.0.0": - version: 3.0.0 - resolution: "pump@npm:3.0.0" + version: 3.0.3 + resolution: "pump@npm:3.0.3" dependencies: end-of-stream: ^1.1.0 once: ^1.3.1 - checksum: e42e9229fba14732593a718b04cb5e1cfef8254544870997e0ecd9732b189a48e1256e4e5478148ecb47c8511dca2b09eae56b4d0aad8009e6fac8072923cfc9 - languageName: node - linkType: hard - -"punycode@npm:1.3.2": - version: 1.3.2 - resolution: "punycode@npm:1.3.2" - checksum: b8807fd594b1db33335692d1f03e8beeddde6fda7fbb4a2e32925d88d20a3aa4cd8dcc0c109ccaccbd2ba761c208dfaaada83007087ea8bfb0129c9ef1b99ed6 + checksum: 52843fc933b838c0330f588388115a1b28ef2a5ffa7774709b142e35431e8ab0c2edec90de3fa34ebb72d59fef854f151eea7dfc211b6dcf586b384556bd2f39 languageName: node linkType: hard -"punycode@npm:^1.2.4": +"punycode@npm:^1.2.4, punycode@npm:^1.4.1": version: 1.4.1 resolution: "punycode@npm:1.4.1" checksum: fa6e698cb53db45e4628559e557ddaf554103d2a96a1d62892c8f4032cd3bc8871796cae9eabc1bc700e2b6677611521ce5bb1d9a27700086039965d0cf34518 languageName: node linkType: hard -"punycode@npm:^2.1.0, punycode@npm:^2.1.1": - version: 2.1.1 - resolution: "punycode@npm:2.1.1" - checksum: 823bf443c6dd14f669984dea25757b37993f67e8d94698996064035edd43bed8a5a17a9f12e439c2b35df1078c6bec05a6c86e336209eb1061e8025c481168e8 +"punycode@npm:^2.1.0, punycode@npm:^2.1.1, punycode@npm:^2.3.1": + version: 2.3.1 + resolution: "punycode@npm:2.3.1" + checksum: bb0a0ceedca4c3c57a9b981b90601579058903c62be23c5e8e843d2c2d4148a3ecf029d5133486fb0e1822b098ba8bba09e89d6b21742d02fa26bda6441a6fb2 languageName: node linkType: hard @@ -18745,21 +18909,12 @@ __metadata: languageName: node linkType: hard -"qs@npm:6.13.0": - version: 6.13.0 - resolution: "qs@npm:6.13.0" - dependencies: - side-channel: ^1.0.6 - checksum: e9404dc0fc2849245107108ce9ec2766cde3be1b271de0bf1021d049dc5b98d1a2901e67b431ac5509f865420a7ed80b7acb3980099fe1c118a1c5d2e1432ad8 - languageName: node - linkType: hard - -"qs@npm:^6.4.0": - version: 6.11.0 - resolution: "qs@npm:6.11.0" +"qs@npm:^6.12.3, qs@npm:^6.4.0, qs@npm:~6.14.0": + version: 6.14.1 + resolution: "qs@npm:6.14.1" dependencies: - side-channel: ^1.0.4 - checksum: 6e1f29dd5385f7488ec74ac7b6c92f4d09a90408882d0c208414a34dd33badc1a621019d4c799a3df15ab9b1d0292f97c1dd71dc7c045e69f81a8064e5af7297 + side-channel: ^1.1.0 + checksum: 7fffab0344fd75bfb6b8c94b8ba17f3d3e823d25b615900f68b473c3a078e497de8eaa08f709eaaa170eedfcee50638a7159b98abef7d8c89c2ede79291522f2 languageName: node linkType: hard @@ -18783,14 +18938,14 @@ __metadata: linkType: hard "query-string@npm:^7.1.1": - version: 7.1.1 - resolution: "query-string@npm:7.1.1" + version: 7.1.3 + resolution: "query-string@npm:7.1.3" dependencies: - decode-uri-component: ^0.2.0 + decode-uri-component: ^0.2.2 filter-obj: ^1.1.0 split-on-first: ^1.0.0 strict-uri-encode: ^2.0.0 - checksum: b227d1f588ae93f9f0ad078c6b811295fa151dc5a160a03bb2bac5fa0e6919cb1daa570aad1d288e77c8e89fde5362ba505b1014e6e793da9b1e885b59a690a6 + checksum: 91af02dcd9cc9227a052841d5c2eecb80a0d6489d05625df506a097ef1c59037cfb5e907f39b84643cbfd535c955abec3e553d0130a7b510120c37d06e0f4346 languageName: node linkType: hard @@ -18801,13 +18956,6 @@ __metadata: languageName: node linkType: hard -"querystring@npm:0.2.0": - version: 0.2.0 - resolution: "querystring@npm:0.2.0" - checksum: 8258d6734f19be27e93f601758858c299bdebe71147909e367101ba459b95446fbe5b975bf9beb76390156a592b6f4ac3a68b6087cea165c259705b8b4e56a69 - languageName: node - linkType: hard - "querystringify@npm:^2.1.1": version: 2.2.0 resolution: "querystringify@npm:2.2.0" @@ -18838,7 +18986,7 @@ __metadata: languageName: node linkType: hard -"randomfill@npm:^1.0.3": +"randomfill@npm:^1.0.4": version: 1.0.4 resolution: "randomfill@npm:1.0.4" dependencies: @@ -18855,27 +19003,15 @@ __metadata: languageName: node linkType: hard -"raw-body@npm:2.5.2": - version: 2.5.2 - resolution: "raw-body@npm:2.5.2" - dependencies: - bytes: 3.1.2 - http-errors: 2.0.0 - iconv-lite: 0.4.24 - unpipe: 1.0.0 - checksum: ba1583c8d8a48e8fbb7a873fdbb2df66ea4ff83775421bfe21ee120140949ab048200668c47d9ae3880012f6e217052690628cf679ddfbd82c9fc9358d574676 - languageName: node - linkType: hard - -"raw-body@npm:^2.3.0, raw-body@npm:^2.4.1": - version: 2.5.1 - resolution: "raw-body@npm:2.5.1" +"raw-body@npm:^2.3.0, raw-body@npm:^2.4.1, raw-body@npm:~2.5.3": + version: 2.5.3 + resolution: "raw-body@npm:2.5.3" dependencies: - bytes: 3.1.2 - http-errors: 2.0.0 - iconv-lite: 0.4.24 - unpipe: 1.0.0 - checksum: 5362adff1575d691bb3f75998803a0ffed8c64eabeaa06e54b4ada25a0cd1b2ae7f4f5ec46565d1bec337e08b5ac90c76eaa0758de6f72a633f025d754dec29e + bytes: ~3.1.2 + http-errors: ~2.0.1 + iconv-lite: ~0.4.24 + unpipe: ~1.0.0 + checksum: 16aa51e504318ebeef7f84a4d884c0f273cb0b7f3f14ea88788f92f5f488870617c97d4f886e84f119f21a2d6cdda3c4554821f8b18ed6be0d731ecb5a063d2a languageName: node linkType: hard @@ -18968,16 +19104,16 @@ __metadata: linkType: hard "react-error-overlay@npm:^6.0.11": - version: 6.0.11 - resolution: "react-error-overlay@npm:6.0.11" - checksum: ce7b44c38fadba9cedd7c095cf39192e632daeccf1d0747292ed524f17dcb056d16bc197ddee5723f9dd888f0b9b19c3b486c430319e30504289b9296f2d2c42 + version: 6.1.0 + resolution: "react-error-overlay@npm:6.1.0" + checksum: 4f0785ea14390e333d040e7d7d6f8b915ad9bd4b8ae6eb28e1a5338f23a0325798d20deea7572c3c129bd1d32c432b01e7a4d40ca99710e2fa1f8157929e6cda languageName: node linkType: hard "react-fast-compare@npm:^3.1.1": - version: 3.2.0 - resolution: "react-fast-compare@npm:3.2.0" - checksum: 8ef272c825ae329f61633ce4ce7f15aa5b84e5214d88bc0823880236e03e985a13195befa2c7a4eda7db3b017dc7985729152d88445823f652403cf36c2b86aa + version: 3.2.2 + resolution: "react-fast-compare@npm:3.2.2" + checksum: 2071415b4f76a3e6b55c84611c4d24dcb12ffc85811a2840b5a3f1ff2d1a99be1020d9437ee7c6e024c9f4cbb84ceb35e48cf84f28fcb00265ad2dfdd3947704 languageName: node linkType: hard @@ -19075,22 +19211,7 @@ __metadata: languageName: node linkType: hard -"readable-stream@npm:^2.0.2, readable-stream@npm:^2.2.2, readable-stream@npm:^2.3.3, readable-stream@npm:^2.3.6": - version: 2.3.7 - resolution: "readable-stream@npm:2.3.7" - dependencies: - core-util-is: ~1.0.0 - inherits: ~2.0.3 - isarray: ~1.0.0 - process-nextick-args: ~2.0.0 - safe-buffer: ~5.1.1 - string_decoder: ~1.1.1 - util-deprecate: ~1.0.1 - checksum: e4920cf7549a60f8aaf694d483a0e61b2a878b969d224f89b3bc788b8d920075132c4b55a7494ee944c7b6a9a0eada28a7f6220d80b0312ece70bbf08eeca755 - languageName: node - linkType: hard - -"readable-stream@npm:^2.3.8, readable-stream@npm:~2.3.6": +"readable-stream@npm:^2.0.2, readable-stream@npm:^2.2.2, readable-stream@npm:^2.3.3, readable-stream@npm:^2.3.6, readable-stream@npm:^2.3.8, readable-stream@npm:~2.3.6": version: 2.3.8 resolution: "readable-stream@npm:2.3.8" dependencies: @@ -19106,22 +19227,42 @@ __metadata: linkType: hard "readable-stream@npm:^3.0.2, readable-stream@npm:^3.1.1, readable-stream@npm:^3.4.0, readable-stream@npm:^3.6.0": - version: 3.6.0 - resolution: "readable-stream@npm:3.6.0" + version: 3.6.2 + resolution: "readable-stream@npm:3.6.2" dependencies: inherits: ^2.0.3 string_decoder: ^1.1.1 util-deprecate: ^1.0.1 - checksum: d4ea81502d3799439bb955a3a5d1d808592cf3133350ed352aeaa499647858b27b1c4013984900238b0873ec8d0d8defce72469fb7a83e61d53f5ad61cb80dc8 + checksum: bdcbe6c22e846b6af075e32cf8f4751c2576238c5043169a1c221c92ee2878458a816a4ea33f4c67623c0b6827c8a400409bfb3cf0bf3381392d0b1dfb52ac8d + languageName: node + linkType: hard + +"readable-stream@npm:^4.7.0": + version: 4.7.0 + resolution: "readable-stream@npm:4.7.0" + dependencies: + abort-controller: ^3.0.0 + buffer: ^6.0.3 + events: ^3.3.0 + process: ^0.11.10 + string_decoder: ^1.3.0 + checksum: 03ec762faed8e149dc6452798b60394a8650861a1bb4bf936fa07b94044826bc25abe73696f5f45372abc404eec01876c560f64b479eba108b56397312dbe2ae languageName: node linkType: hard "readable-web-to-node-stream@npm:^3.0.0": - version: 3.0.2 - resolution: "readable-web-to-node-stream@npm:3.0.2" + version: 3.0.4 + resolution: "readable-web-to-node-stream@npm:3.0.4" dependencies: - readable-stream: ^3.6.0 - checksum: 8c56cc62c68513425ddfa721954875b382768f83fa20e6b31e365ee00cbe7a3d6296f66f7f1107b16cd3416d33aa9f1680475376400d62a081a88f81f0ea7f9c + readable-stream: ^4.7.0 + checksum: a11704035cab9ad857a3081e7663dca28a7befd7328e5b2eb2c124e4150e08534ea00c3159e5f7ff2588fca366b348a7d8d2bc0bc7d5eabc6b7108dd753886b7 + languageName: node + linkType: hard + +"readdirp@npm:^4.0.1": + version: 4.1.2 + resolution: "readdirp@npm:4.1.2" + checksum: 3242ee125422cb7c0e12d51452e993f507e6ed3d8c490bc8bf3366c5cdd09167562224e429b13e9cb2b98d4b8b2b11dc100d3c73883aa92d657ade5a21ded004 languageName: node linkType: hard @@ -19153,24 +19294,23 @@ __metadata: linkType: hard "redoc-cli@npm:^0.13.20": - version: 0.13.20 - resolution: "redoc-cli@npm:0.13.20" + version: 0.13.21 + resolution: "redoc-cli@npm:0.13.21" dependencies: + boxen: 5.1.2 chokidar: ^3.5.1 handlebars: ^4.7.7 - isarray: ^2.0.5 mkdirp: ^1.0.4 mobx: ^6.3.2 node-libs-browser: ^2.2.1 react: ^17.0.1 react-dom: ^17.0.1 - redoc: 2.0.0-rc.77 + redoc: 2.0.0 styled-components: ^5.3.0 - update-notifier: ^5.0.1 yargs: ^17.3.1 bin: redoc-cli: index.js - checksum: 11779752c1276438aa16dc67cc4911490452fc474e92532278222e7d9655c05bee4e68a65d379cab5af8d55bd3552213f30eb707b74d8b5f3f4e354f030e835e + checksum: 0ef34187383f01bd0768c6f60b5d0fc4a8ab3e5d7807587ba5f33265d27813579dbaca0f429b6f20a0a65c44d3f1b5cc6708089babc9598a34b0faa92d13f5a6 languageName: node linkType: hard @@ -19210,42 +19350,6 @@ __metadata: languageName: node linkType: hard -"redoc@npm:2.0.0-rc.77": - version: 2.0.0-rc.77 - resolution: "redoc@npm:2.0.0-rc.77" - dependencies: - "@redocly/openapi-core": ^1.0.0-beta.104 - classnames: ^2.3.1 - decko: ^1.2.0 - dompurify: ^2.2.8 - eventemitter3: ^4.0.7 - json-pointer: ^0.6.2 - lunr: ^2.3.9 - mark.js: ^8.11.1 - marked: ^4.0.15 - mobx-react: ^7.2.0 - openapi-sampler: ^1.3.0 - path-browserify: ^1.0.1 - perfect-scrollbar: ^1.5.5 - polished: ^4.1.3 - prismjs: ^1.27.0 - prop-types: ^15.7.2 - react-tabs: ^3.2.2 - slugify: ~1.4.7 - stickyfill: ^1.1.1 - style-loader: ^3.3.1 - swagger2openapi: ^7.0.6 - url-template: ^2.0.8 - peerDependencies: - core-js: ^3.1.4 - mobx: ^6.0.4 - react: ^16.8.4 || ^17.0.0 - react-dom: ^16.8.4 || ^17.0.0 - styled-components: ^4.1.1 || ^5.1.1 - checksum: 960759320a1d81236712c4ded7dbdbec7f24892d1c4c188b0b800d8f416852557f7f91d7b123dd897f709bd1e45af52233ca122a596b28902b8a396c85e5a4ab - languageName: node - linkType: hard - "redux-thunk@npm:^2.4.0": version: 2.4.2 resolution: "redux-thunk@npm:2.4.2" @@ -19264,6 +19368,22 @@ __metadata: languageName: node linkType: hard +"reflect.getprototypeof@npm:^1.0.6, reflect.getprototypeof@npm:^1.0.9": + version: 1.0.10 + resolution: "reflect.getprototypeof@npm:1.0.10" + dependencies: + call-bind: ^1.0.8 + define-properties: ^1.2.1 + es-abstract: ^1.23.9 + es-errors: ^1.3.0 + es-object-atoms: ^1.0.0 + get-intrinsic: ^1.2.7 + get-proto: ^1.0.1 + which-builtin-type: ^1.2.1 + checksum: ccc5debeb66125e276ae73909cecb27e47c35d9bb79d9cc8d8d055f008c58010ab8cb401299786e505e4aab733a64cba9daf5f312a58e96a43df66adad221870 + languageName: node + linkType: hard + "reftools@npm:^1.1.9": version: 1.1.9 resolution: "reftools@npm:1.1.9" @@ -19271,12 +19391,12 @@ __metadata: languageName: node linkType: hard -"regenerate-unicode-properties@npm:^10.1.0": - version: 10.1.0 - resolution: "regenerate-unicode-properties@npm:10.1.0" +"regenerate-unicode-properties@npm:^10.2.2": + version: 10.2.2 + resolution: "regenerate-unicode-properties@npm:10.2.2" dependencies: regenerate: ^1.4.2 - checksum: b1a8929588433ab8b9dc1a34cf3665b3b472f79f2af6ceae00d905fc496b332b9af09c6718fb28c730918f19a00dc1d7310adbaa9b72a2ec7ad2f435da8ace17 + checksum: 7ae4c1c32460c4360e3118c45eec0621424908f430fdd6f162c9172067786bf2b1682fbc885a33b26bc85e76e06f4d3f398b52425e801b0bb0cbae147dafb0b2 languageName: node linkType: hard @@ -19288,36 +19408,23 @@ __metadata: linkType: hard "regenerator-runtime@npm:^0.13.3, regenerator-runtime@npm:^0.13.7": - version: 0.13.10 - resolution: "regenerator-runtime@npm:0.13.10" - checksum: 09893f5a9e82932642d9a999716b6c626dc53ef2a01307c952ebbf8e011802360163a37c304c18a6c358548be5a72b448e37209954a18696f21e438c81cbb4b9 - languageName: node - linkType: hard - -"regenerator-runtime@npm:^0.14.0": - version: 0.14.1 - resolution: "regenerator-runtime@npm:0.14.1" - checksum: 9f57c93277b5585d3c83b0cf76be47b473ae8c6d9142a46ce8b0291a04bb2cf902059f0f8445dcabb3fb7378e5fe4bb4ea1e008876343d42e46d3b484534ce38 - languageName: node - linkType: hard - -"regenerator-transform@npm:^0.15.0": - version: 0.15.0 - resolution: "regenerator-transform@npm:0.15.0" - dependencies: - "@babel/runtime": ^7.8.4 - checksum: 86e54849ab1167618d28bb56d214c52a983daf29b0d115c976d79840511420049b6b42c9ebdf187defa8e7129bdd74b6dd266420d0d3868c9fa7f793b5d15d49 + version: 0.13.11 + resolution: "regenerator-runtime@npm:0.13.11" + checksum: 27481628d22a1c4e3ff551096a683b424242a216fee44685467307f14d58020af1e19660bf2e26064de946bad7eff28950eae9f8209d55723e2d9351e632bbb4 languageName: node linkType: hard -"regexp.prototype.flags@npm:^1.4.3": - version: 1.4.3 - resolution: "regexp.prototype.flags@npm:1.4.3" +"regexp.prototype.flags@npm:^1.5.1, regexp.prototype.flags@npm:^1.5.3, regexp.prototype.flags@npm:^1.5.4": + version: 1.5.4 + resolution: "regexp.prototype.flags@npm:1.5.4" dependencies: - call-bind: ^1.0.2 - define-properties: ^1.1.3 - functions-have-names: ^1.2.2 - checksum: 51228bae732592adb3ededd5e15426be25f289e9c4ef15212f4da73f4ec3919b6140806374b8894036a86020d054a8d2657d3fee6bb9b4d35d8939c20030b7a6 + call-bind: ^1.0.8 + define-properties: ^1.2.1 + es-errors: ^1.3.0 + get-proto: ^1.0.1 + gopd: ^1.2.0 + set-function-name: ^2.0.2 + checksum: 18cb667e56cb328d2dda569d7f04e3ea78f2683135b866d606538cf7b1d4271f7f749f09608c877527799e6cf350e531368f3c7a20ccd1bb41048a48926bdeeb languageName: node linkType: hard @@ -19328,17 +19435,17 @@ __metadata: languageName: node linkType: hard -"regexpu-core@npm:^5.1.0": - version: 5.2.1 - resolution: "regexpu-core@npm:5.2.1" +"regexpu-core@npm:^6.3.1": + version: 6.4.0 + resolution: "regexpu-core@npm:6.4.0" dependencies: regenerate: ^1.4.2 - regenerate-unicode-properties: ^10.1.0 - regjsgen: ^0.7.1 - regjsparser: ^0.9.1 + regenerate-unicode-properties: ^10.2.2 + regjsgen: ^0.8.0 + regjsparser: ^0.13.0 unicode-match-property-ecmascript: ^2.0.0 - unicode-match-property-value-ecmascript: ^2.0.0 - checksum: c1244db79f7a4597414cd7fdf5171fa73905f0cbc684385c78127fc6198f9cade8fe829a1c4036c8ec57ac75b1ffb8c196451abdd2e153f26a4d8043fa10bbb3 + unicode-match-property-value-ecmascript: ^2.2.1 + checksum: a316eb988599b7fb9d77f4adb937c41c022504dc91ddd18175c11771addc7f1d9dce550f34e36038395e459a2cf9ffc0d663bfe8d3c6c186317ca000ba79a8cf languageName: node linkType: hard @@ -19360,21 +19467,21 @@ __metadata: languageName: node linkType: hard -"regjsgen@npm:^0.7.1": - version: 0.7.1 - resolution: "regjsgen@npm:0.7.1" - checksum: 7cac399921c58db8e16454869283ff66871531180218064fa938ac05c11c2976792a00706c3c78bbc625e1d793ca373065ea90564e06189a751a7b4ae33acadc +"regjsgen@npm:^0.8.0": + version: 0.8.0 + resolution: "regjsgen@npm:0.8.0" + checksum: a1d925ff14a4b2be774e45775ee6b33b256f89c42d480e6d85152d2133f18bd3d6af662161b226fa57466f7efec367eaf7ccd2a58c0ec2a1306667ba2ad07b0d languageName: node linkType: hard -"regjsparser@npm:^0.9.1": - version: 0.9.1 - resolution: "regjsparser@npm:0.9.1" +"regjsparser@npm:^0.13.0": + version: 0.13.0 + resolution: "regjsparser@npm:0.13.0" dependencies: - jsesc: ~0.5.0 + jsesc: ~3.1.0 bin: regjsparser: bin/parser - checksum: 5e1b76afe8f1d03c3beaf9e0d935dd467589c3625f6d65fb8ffa14f224d783a0fed4bf49c2c1b8211043ef92b6117313419edf055a098ed8342e340586741afc + checksum: 1cf09f6afde2b2d1c1e89e1ce3034e3ee8d9433912728dbaa48e123f5f43ce34e263b2a8ab228817dce85d676ee0c801a512101b015ac9ab80ed449cf7329d3a languageName: node linkType: hard @@ -19636,7 +19743,7 @@ __metadata: languageName: node linkType: hard -"remark-validate-links@npm:^13.0.1": +"remark-validate-links@npm:13.0.1": version: 13.0.1 resolution: "remark-validate-links@npm:13.0.1" dependencies: @@ -19850,6 +19957,13 @@ __metadata: languageName: node linkType: hard +"resolve-from@npm:3.0.0": + version: 3.0.0 + resolution: "resolve-from@npm:3.0.0" + checksum: fff9819254d2d62b57f74e5c2ca9c0bdd425ca47287c4d801bc15f947533148d858229ded7793b0f59e61e49e782fffd6722048add12996e1bd4333c29669062 + languageName: node + linkType: hard + "resolve-from@npm:^4.0.0": version: 4.0.0 resolution: "resolve-from@npm:4.0.0" @@ -19864,55 +19978,55 @@ __metadata: languageName: node linkType: hard -"resolve@npm:^1.10.0, resolve@npm:^1.14.2, resolve@npm:^1.19.0, resolve@npm:^1.20.0, resolve@npm:^1.22.0, resolve@npm:^1.3.2, resolve@npm:^1.9.0": - version: 1.22.1 - resolution: "resolve@npm:1.22.1" +"resolve@npm:^1.10.0, resolve@npm:^1.19.0, resolve@npm:^1.22.10, resolve@npm:^1.22.4, resolve@npm:^1.3.2, resolve@npm:^1.9.0": + version: 1.22.11 + resolution: "resolve@npm:1.22.11" dependencies: - is-core-module: ^2.9.0 + is-core-module: ^2.16.1 path-parse: ^1.0.7 supports-preserve-symlinks-flag: ^1.0.0 bin: resolve: bin/resolve - checksum: 07af5fc1e81aa1d866cbc9e9460fbb67318a10fa3c4deadc35c3ad8a898ee9a71a86a65e4755ac3195e0ea0cfbe201eb323ebe655ce90526fd61917313a34e4e + checksum: 6d5baa2156b95a65ac431e7642e21106584e9f4194da50871cae8bc1bbd2b53bb7cee573c92543d83bb999620b224a087f62379d800ed1ccb189da6df5d78d50 languageName: node linkType: hard -"resolve@npm:^2.0.0-next.3": - version: 2.0.0-next.4 - resolution: "resolve@npm:2.0.0-next.4" +"resolve@npm:^2.0.0-next.5": + version: 2.0.0-next.5 + resolution: "resolve@npm:2.0.0-next.5" dependencies: - is-core-module: ^2.9.0 + is-core-module: ^2.13.0 path-parse: ^1.0.7 supports-preserve-symlinks-flag: ^1.0.0 bin: resolve: bin/resolve - checksum: c438ac9a650f2030fd074219d7f12ceb983b475da2d89ad3d6dd05fbf6b7a0a8cd37d4d10b43cb1f632bc19f22246ab7f36ebda54d84a29bfb2910a0680906d3 + checksum: a73ac69a1c4bd34c56b213d91f5b17ce390688fdb4a1a96ed3025cc7e08e7bfb90b3a06fcce461780cb0b589c958afcb0080ab802c71c01a7ecc8c64feafc89f languageName: node linkType: hard -"resolve@patch:resolve@^1.10.0#~builtin, resolve@patch:resolve@^1.14.2#~builtin, resolve@patch:resolve@^1.19.0#~builtin, resolve@patch:resolve@^1.20.0#~builtin, resolve@patch:resolve@^1.22.0#~builtin, resolve@patch:resolve@^1.3.2#~builtin, resolve@patch:resolve@^1.9.0#~builtin": - version: 1.22.1 - resolution: "resolve@patch:resolve@npm%3A1.22.1#~builtin::version=1.22.1&hash=07638b" +"resolve@patch:resolve@^1.10.0#~builtin, resolve@patch:resolve@^1.19.0#~builtin, resolve@patch:resolve@^1.22.10#~builtin, resolve@patch:resolve@^1.22.4#~builtin, resolve@patch:resolve@^1.3.2#~builtin, resolve@patch:resolve@^1.9.0#~builtin": + version: 1.22.11 + resolution: "resolve@patch:resolve@npm%3A1.22.11#~builtin::version=1.22.11&hash=07638b" dependencies: - is-core-module: ^2.9.0 + is-core-module: ^2.16.1 path-parse: ^1.0.7 supports-preserve-symlinks-flag: ^1.0.0 bin: resolve: bin/resolve - checksum: 5656f4d0bedcf8eb52685c1abdf8fbe73a1603bb1160a24d716e27a57f6cecbe2432ff9c89c2bd57542c3a7b9d14b1882b73bfe2e9d7849c9a4c0b8b39f02b8b + checksum: 1462da84ac3410d7c2e12e4f5f25c1423d8a174c3b4245c43eafea85e7bbe6af3eb7ec10a4850b5e518e8531608604742b8cbd761e1acd7ad1035108b7c98013 languageName: node linkType: hard -"resolve@patch:resolve@^2.0.0-next.3#~builtin": - version: 2.0.0-next.4 - resolution: "resolve@patch:resolve@npm%3A2.0.0-next.4#~builtin::version=2.0.0-next.4&hash=07638b" +"resolve@patch:resolve@^2.0.0-next.5#~builtin": + version: 2.0.0-next.5 + resolution: "resolve@patch:resolve@npm%3A2.0.0-next.5#~builtin::version=2.0.0-next.5&hash=07638b" dependencies: - is-core-module: ^2.9.0 + is-core-module: ^2.13.0 path-parse: ^1.0.7 supports-preserve-symlinks-flag: ^1.0.0 bin: resolve: bin/resolve - checksum: 4bf9f4f8a458607af90518ff73c67a4bc1a38b5a23fef2bb0ccbd45e8be89820a1639b637b0ba377eb2be9eedfb1739a84cde24fe4cd670c8207d8fea922b011 + checksum: 064d09c1808d0c51b3d90b5d27e198e6d0c5dad0eb57065fd40803d6a20553e5398b07f76739d69cbabc12547058bec6b32106ea66622375fb0d7e8fca6a846c languageName: node linkType: hard @@ -19962,9 +20076,9 @@ __metadata: linkType: hard "reusify@npm:^1.0.4": - version: 1.0.4 - resolution: "reusify@npm:1.0.4" - checksum: c3076ebcc22a6bc252cb0b9c77561795256c22b757f40c0d8110b1300723f15ec0fc8685e8d4ea6d7666f36c79ccc793b1939c748bf36f18f542744a4e379fcc + version: 1.1.0 + resolution: "reusify@npm:1.1.0" + checksum: 64cb3142ac5e9ad689aca289585cb41d22521f4571f73e9488af39f6b1bd62f0cbb3d65e2ecc768ec6494052523f473f1eb4b55c3e9014b3590c17fc6a03e22a languageName: node linkType: hard @@ -19979,7 +20093,7 @@ __metadata: languageName: node linkType: hard -"rimraf@npm:^3.0.0, rimraf@npm:^3.0.2, rimraf@npm:~3.0.2": +"rimraf@npm:^3.0.2, rimraf@npm:~3.0.2": version: 3.0.2 resolution: "rimraf@npm:3.0.2" dependencies: @@ -19990,23 +20104,22 @@ __metadata: languageName: node linkType: hard -"ripemd160@npm:=2.0.1": - version: 2.0.1 - resolution: "ripemd160@npm:2.0.1" +"ripemd160@npm:^2.0.0, ripemd160@npm:^2.0.1, ripemd160@npm:^2.0.3": + version: 2.0.3 + resolution: "ripemd160@npm:2.0.3" dependencies: - hash-base: ^2.0.0 - inherits: ^2.0.1 - checksum: 865bcb4be1f04762c4afc9375f9172c326bed7057f388913512850493c22af9092efe21d7a488ec25665530333a1900f2f81d39b3fdfcc37a39f97b8f4ce13d0 + hash-base: ^3.1.2 + inherits: ^2.0.4 + checksum: da25591f15d3f03d3a26cabc8255634ee9e0ae89fc053846e6b3975bbdbae6941baeb539dba30e0aaec9a726c7442149de064e13c2510332e119e50beaf3314d languageName: node linkType: hard -"ripemd160@npm:^2.0.0, ripemd160@npm:^2.0.1": - version: 2.0.2 - resolution: "ripemd160@npm:2.0.2" +"rollup-pluginutils@npm:^2.8.2": + version: 2.8.2 + resolution: "rollup-pluginutils@npm:2.8.2" dependencies: - hash-base: ^3.0.0 - inherits: ^2.0.1 - checksum: 006accc40578ee2beae382757c4ce2908a826b27e2b079efdcd2959ee544ddf210b7b5d7d5e80467807604244e7388427330f5c6d4cd61e6edaddc5773ccc393 + estree-walker: ^0.6.1 + checksum: 339fdf866d8f4ff6e408fa274c0525412f7edb01dc46b5ccda51f575b7e0d20ad72965773376fb5db95a77a7fcfcab97bf841ec08dbadf5d6b08af02b7a2cf5e languageName: node linkType: hard @@ -20035,6 +20148,19 @@ __metadata: languageName: node linkType: hard +"safe-array-concat@npm:^1.1.3": + version: 1.1.3 + resolution: "safe-array-concat@npm:1.1.3" + dependencies: + call-bind: ^1.0.8 + call-bound: ^1.0.2 + get-intrinsic: ^1.2.6 + has-symbols: ^1.1.0 + isarray: ^2.0.5 + checksum: 00f6a68140e67e813f3ad5e73e6dedcf3e42a9fa01f04d44b0d3f7b1f4b257af876832a9bfc82ac76f307e8a6cc652e3cf95876048a26cbec451847cf6ae3707 + languageName: node + linkType: hard + "safe-buffer@npm:5.1.2, safe-buffer@npm:~5.1.0, safe-buffer@npm:~5.1.1": version: 5.1.2 resolution: "safe-buffer@npm:5.1.2" @@ -20042,7 +20168,7 @@ __metadata: languageName: node linkType: hard -"safe-buffer@npm:5.2.1, safe-buffer@npm:>=5.1.0, safe-buffer@npm:^5.0.1, safe-buffer@npm:^5.1.0, safe-buffer@npm:^5.1.1, safe-buffer@npm:^5.1.2, safe-buffer@npm:^5.2.0, safe-buffer@npm:^5.2.1, safe-buffer@npm:~5.2.0": +"safe-buffer@npm:5.2.1, safe-buffer@npm:>=5.1.0, safe-buffer@npm:^5.0.1, safe-buffer@npm:^5.1.0, safe-buffer@npm:^5.1.1, safe-buffer@npm:^5.1.2, safe-buffer@npm:^5.2.1, safe-buffer@npm:~5.2.0": version: 5.2.1 resolution: "safe-buffer@npm:5.2.1" checksum: b99c4b41fdd67a6aaf280fcd05e9ffb0813654894223afb78a31f14a19ad220bba8aba1cb14eddce1fcfb037155fe6de4e861784eb434f7d11ed58d1e70dd491 @@ -20056,14 +20182,24 @@ __metadata: languageName: node linkType: hard -"safe-regex-test@npm:^1.0.0": +"safe-push-apply@npm:^1.0.0": version: 1.0.0 - resolution: "safe-regex-test@npm:1.0.0" + resolution: "safe-push-apply@npm:1.0.0" dependencies: - call-bind: ^1.0.2 - get-intrinsic: ^1.1.3 - is-regex: ^1.1.4 - checksum: bc566d8beb8b43c01b94e67de3f070fd2781685e835959bbbaaec91cc53381145ca91f69bd837ce6ec244817afa0a5e974fc4e40a2957f0aca68ac3add1ddd34 + es-errors: ^1.3.0 + isarray: ^2.0.5 + checksum: 8c11cbee6dc8ff5cc0f3d95eef7052e43494591384015902e4292aef4ae9e539908288520ed97179cee17d6ffb450fe5f05a46ce7a1749685f7524fd568ab5db + languageName: node + linkType: hard + +"safe-regex-test@npm:^1.0.3, safe-regex-test@npm:^1.1.0": + version: 1.1.0 + resolution: "safe-regex-test@npm:1.1.0" + dependencies: + call-bound: ^1.0.2 + es-errors: ^1.3.0 + is-regex: ^1.2.1 + checksum: 3c809abeb81977c9ed6c869c83aca6873ea0f3ab0f806b8edbba5582d51713f8a6e9757d24d2b4b088f563801475ea946c8e77e7713e8c65cdd02305b6caedab languageName: node linkType: hard @@ -20087,22 +20223,26 @@ __metadata: linkType: hard "sass@npm:^1.32.13": - version: 1.56.1 - resolution: "sass@npm:1.56.1" + version: 1.97.2 + resolution: "sass@npm:1.97.2" dependencies: - chokidar: ">=3.0.0 <4.0.0" - immutable: ^4.0.0 + "@parcel/watcher": ^2.4.1 + chokidar: ^4.0.0 + immutable: ^5.0.2 source-map-js: ">=0.6.2 <2.0.0" + dependenciesMeta: + "@parcel/watcher": + optional: true bin: sass: sass.js - checksum: 78e693e5992b149574c95d5adfe39ca3e5b97d80befa11191a20d1daa41fe201a98ac099beab726cd3095e2d2e7991a2c408ba0fcc3fa9f525879de7eee18dad + checksum: d0cdc2fb82a6eabe59d386f939ff265b9b98c53a4622feae1354014dc9413eb6e020aac9c5b450d387ed88328dc883242530401428af777b63a32fa581f7b1d8 languageName: node linkType: hard "sax@npm:>=0.6.0, sax@npm:^1.2.4": - version: 1.2.4 - resolution: "sax@npm:1.2.4" - checksum: d3df7d32b897a2c2f28e941f732c71ba90e27c24f62ee918bd4d9a8cfb3553f2f81e5493c7f0be94a11c1911b643a9108f231dd6f60df3fa9586b5d2e3e9e1fe + version: 1.4.3 + resolution: "sax@npm:1.4.3" + checksum: 136a202eee9364f312fb1c6abadb045ef430a7468853f804758d8f2dc8d2560801245620e2bfd4ead2e332c025bef50865271974d142a0c26f69d5fc3de9baf1 languageName: node linkType: hard @@ -20148,24 +20288,25 @@ __metadata: linkType: hard "schema-utils@npm:^3.0.0, schema-utils@npm:^3.1.1": - version: 3.1.1 - resolution: "schema-utils@npm:3.1.1" + version: 3.3.0 + resolution: "schema-utils@npm:3.3.0" dependencies: "@types/json-schema": ^7.0.8 ajv: ^6.12.5 ajv-keywords: ^3.5.2 - checksum: fb73f3d759d43ba033c877628fe9751620a26879f6301d3dbeeb48cf2a65baec5cdf99da65d1bf3b4ff5444b2e59cbe4f81c2456b5e0d2ba7d7fd4aed5da29ce + checksum: ea56971926fac2487f0757da939a871388891bc87c6a82220d125d587b388f1704788f3706e7f63a7b70e49fc2db974c41343528caea60444afd5ce0fe4b85c0 languageName: node linkType: hard -"schema-utils@npm:^3.2.0": - version: 3.3.0 - resolution: "schema-utils@npm:3.3.0" +"schema-utils@npm:^4.2.0, schema-utils@npm:^4.3.0, schema-utils@npm:^4.3.3": + version: 4.3.3 + resolution: "schema-utils@npm:4.3.3" dependencies: - "@types/json-schema": ^7.0.8 - ajv: ^6.12.5 - ajv-keywords: ^3.5.2 - checksum: ea56971926fac2487f0757da939a871388891bc87c6a82220d125d587b388f1704788f3706e7f63a7b70e49fc2db974c41343528caea60444afd5ce0fe4b85c0 + "@types/json-schema": ^7.0.9 + ajv: ^8.9.0 + ajv-formats: ^2.1.1 + ajv-keywords: ^5.1.0 + checksum: 4e20404962fd45d5feb5942f7c9ab334a3d3dab94e15001049bd49e2959015f2c59089353953d4976fe664462c79121dea50392968182d4e2c4b75803f822fa3 languageName: node linkType: hard @@ -20206,42 +20347,42 @@ __metadata: languageName: node linkType: hard -"semver@npm:^6.0.0, semver@npm:^6.1.1, semver@npm:^6.1.2, semver@npm:^6.2.0, semver@npm:^6.3.0": - version: 6.3.0 - resolution: "semver@npm:6.3.0" +"semver@npm:^6.0.0, semver@npm:^6.2.0, semver@npm:^6.3.0, semver@npm:^6.3.1": + version: 6.3.1 + resolution: "semver@npm:6.3.1" bin: - semver: ./bin/semver.js - checksum: 1b26ecf6db9e8292dd90df4e781d91875c0dcc1b1909e70f5d12959a23c7eebb8f01ea581c00783bbee72ceeaad9505797c381756326073850dc36ed284b21b9 + semver: bin/semver.js + checksum: ae47d06de28836adb9d3e25f22a92943477371292d9b665fb023fae278d345d508ca1958232af086d85e0155aee22e313e100971898bbb8d5d89b8b1d4054ca2 languageName: node linkType: hard "semver@npm:^7.1.1, semver@npm:^7.2.1, semver@npm:^7.3.2, semver@npm:^7.3.4, semver@npm:^7.3.5, semver@npm:^7.3.7, semver@npm:^7.5.3, semver@npm:^7.5.4": - version: 7.6.3 - resolution: "semver@npm:7.6.3" + version: 7.7.3 + resolution: "semver@npm:7.7.3" bin: semver: bin/semver.js - checksum: 4110ec5d015c9438f322257b1c51fe30276e5f766a3f64c09edd1d7ea7118ecbc3f379f3b69032bacf13116dc7abc4ad8ce0d7e2bd642e26b0d271b56b61a7d8 + checksum: f013a3ee4607857bcd3503b6ac1d80165f7f8ea94f5d55e2d3e33df82fce487aa3313b987abf9b39e0793c83c9fc67b76c36c067625141a9f6f704ae0ea18db2 languageName: node linkType: hard -"send@npm:0.19.0": - version: 0.19.0 - resolution: "send@npm:0.19.0" +"send@npm:~0.19.0, send@npm:~0.19.1": + version: 0.19.2 + resolution: "send@npm:0.19.2" dependencies: debug: 2.6.9 depd: 2.0.0 destroy: 1.2.0 - encodeurl: ~1.0.2 + encodeurl: ~2.0.0 escape-html: ~1.0.3 etag: ~1.8.1 - fresh: 0.5.2 - http-errors: 2.0.0 + fresh: ~0.5.2 + http-errors: ~2.0.1 mime: 1.6.0 ms: 2.1.3 - on-finished: 2.4.1 + on-finished: ~2.4.1 range-parser: ~1.2.1 - statuses: 2.0.1 - checksum: 5ae11bd900c1c2575525e2aa622e856804e2f96a09281ec1e39610d089f53aa69e13fd8db84b52f001d0318cf4bb0b3b904ad532fc4c0014eb90d32db0cff55f + statuses: ~2.0.2 + checksum: f9e11b718b48dbea72daa6a80e36e5a00fb6d01b1a6cfda8b3135c9ca9db84257738283da23371f437148ccd8f400e6171cd2a3642fb43fda462da407d9d30c0 languageName: node linkType: hard @@ -20275,16 +20416,7 @@ __metadata: languageName: node linkType: hard -"serialize-javascript@npm:^6.0.0": - version: 6.0.0 - resolution: "serialize-javascript@npm:6.0.0" - dependencies: - randombytes: ^2.1.0 - checksum: 56f90b562a1bdc92e55afb3e657c6397c01a902c588c0fe3d4c490efdcc97dcd2a3074ba12df9e94630f33a5ce5b76a74784a7041294628a6f4306e0ec84bf93 - languageName: node - linkType: hard - -"serialize-javascript@npm:^6.0.1": +"serialize-javascript@npm:^6.0.2": version: 6.0.2 resolution: "serialize-javascript@npm:6.0.2" dependencies: @@ -20308,15 +20440,15 @@ __metadata: languageName: node linkType: hard -"serve-static@npm:1.16.2, serve-static@npm:^1.15.0": - version: 1.16.2 - resolution: "serve-static@npm:1.16.2" +"serve-static@npm:^1.15.0, serve-static@npm:~1.16.2": + version: 1.16.3 + resolution: "serve-static@npm:1.16.3" dependencies: encodeurl: ~2.0.0 escape-html: ~1.0.3 parseurl: ~1.3.3 - send: 0.19.0 - checksum: dffc52feb4cc5c68e66d0c7f3c1824d4e989f71050aefc9bd5f822a42c54c9b814f595fc5f2b717f4c7cc05396145f3e90422af31186a93f76cf15f707019759 + send: ~0.19.1 + checksum: ec7599540215e6676b223ea768bf7c256819180bf14f89d0b5d249a61bbb8f10b05b2a53048a153cb2cc7f3b367f1227d2fb715fe4b09d07299a9233eda1a453 languageName: node linkType: hard @@ -20327,7 +20459,7 @@ __metadata: languageName: node linkType: hard -"set-function-length@npm:^1.2.1, set-function-length@npm:^1.2.2": +"set-function-length@npm:^1.2.2": version: 1.2.2 resolution: "set-function-length@npm:1.2.2" dependencies: @@ -20341,6 +20473,29 @@ __metadata: languageName: node linkType: hard +"set-function-name@npm:^2.0.2": + version: 2.0.2 + resolution: "set-function-name@npm:2.0.2" + dependencies: + define-data-property: ^1.1.4 + es-errors: ^1.3.0 + functions-have-names: ^1.2.3 + has-property-descriptors: ^1.0.2 + checksum: d6229a71527fd0404399fc6227e0ff0652800362510822a291925c9d7b48a1ca1a468b11b281471c34cd5a2da0db4f5d7ff315a61d26655e77f6e971e6d0c80f + languageName: node + linkType: hard + +"set-proto@npm:^1.0.0": + version: 1.0.0 + resolution: "set-proto@npm:1.0.0" + dependencies: + dunder-proto: ^1.0.1 + es-errors: ^1.3.0 + es-object-atoms: ^1.0.0 + checksum: ec27cbbe334598547e99024403e96da32aca3e530583e4dba7f5db1c43cbc4affa9adfbd77c7b2c210b9b8b2e7b2e600bad2a6c44fd62e804d8233f96bbb62f4 + languageName: node + linkType: hard + "setimmediate@npm:^1.0.4, setimmediate@npm:^1.0.5": version: 1.0.5 resolution: "setimmediate@npm:1.0.5" @@ -20355,26 +20510,14 @@ __metadata: languageName: node linkType: hard -"setprototypeof@npm:1.2.0": +"setprototypeof@npm:1.2.0, setprototypeof@npm:~1.2.0": version: 1.2.0 resolution: "setprototypeof@npm:1.2.0" checksum: be18cbbf70e7d8097c97f713a2e76edf84e87299b40d085c6bf8b65314e994cc15e2e317727342fa6996e38e1f52c59720b53fe621e2eb593a6847bf0356db89 languageName: node linkType: hard -"sha.js@npm:^2.4.0, sha.js@npm:^2.4.8": - version: 2.4.11 - resolution: "sha.js@npm:2.4.11" - dependencies: - inherits: ^2.0.1 - safe-buffer: ^5.0.1 - bin: - sha.js: ./bin.js - checksum: ebd3f59d4b799000699097dadb831c8e3da3eb579144fd7eb7a19484cbcbb7aca3c68ba2bb362242eb09e33217de3b4ea56e4678184c334323eca24a58e3ad07 - languageName: node - linkType: hard - -"sha.js@npm:^2.4.11": +"sha.js@npm:^2.4.0, sha.js@npm:^2.4.12, sha.js@npm:^2.4.8": version: 2.4.12 resolution: "sha.js@npm:2.4.12" dependencies: @@ -20529,9 +20672,9 @@ __metadata: linkType: hard "shell-quote@npm:^1.7.3": - version: 1.7.4 - resolution: "shell-quote@npm:1.7.4" - checksum: 2874ea9c1a7c3ebfc9ec5734a897e16533d0d06f2e4cddc22ba3d1cab5cdc07d0f825364c1b1e39abe61236f44d8e60e933c7ad7349ce44de4f5dddc7b4354e9 + version: 1.8.3 + resolution: "shell-quote@npm:1.8.3" + checksum: 550dd84e677f8915eb013d43689c80bb114860649ec5298eb978f40b8f3d4bc4ccb072b82c094eb3548dc587144bb3965a8676f0d685c1cf4c40b5dc27166242 languageName: node linkType: hard @@ -20591,30 +20734,55 @@ __metadata: languageName: node linkType: hard -"side-channel@npm:^1.0.4": - version: 1.0.4 - resolution: "side-channel@npm:1.0.4" +"side-channel-list@npm:^1.0.0": + version: 1.0.0 + resolution: "side-channel-list@npm:1.0.0" dependencies: - call-bind: ^1.0.0 - get-intrinsic: ^1.0.2 - object-inspect: ^1.9.0 - checksum: 351e41b947079c10bd0858364f32bb3a7379514c399edb64ab3dce683933483fc63fb5e4efe0a15a2e8a7e3c436b6a91736ddb8d8c6591b0460a24bb4a1ee245 + es-errors: ^1.3.0 + object-inspect: ^1.13.3 + checksum: 603b928997abd21c5a5f02ae6b9cc36b72e3176ad6827fab0417ead74580cc4fb4d5c7d0a8a2ff4ead34d0f9e35701ed7a41853dac8a6d1a664fcce1a044f86f languageName: node linkType: hard -"side-channel@npm:^1.0.6": - version: 1.0.6 - resolution: "side-channel@npm:1.0.6" +"side-channel-map@npm:^1.0.1": + version: 1.0.1 + resolution: "side-channel-map@npm:1.0.1" dependencies: - call-bind: ^1.0.7 + call-bound: ^1.0.2 es-errors: ^1.3.0 - get-intrinsic: ^1.2.4 - object-inspect: ^1.13.1 - checksum: bfc1afc1827d712271453e91b7cd3878ac0efd767495fd4e594c4c2afaa7963b7b510e249572bfd54b0527e66e4a12b61b80c061389e129755f34c493aad9b97 + get-intrinsic: ^1.2.5 + object-inspect: ^1.13.3 + checksum: 42501371cdf71f4ccbbc9c9e2eb00aaaab80a4c1c429d5e8da713fd4d39ef3b8d4a4b37ed4f275798a65260a551a7131fd87fe67e922dba4ac18586d6aab8b06 + languageName: node + linkType: hard + +"side-channel-weakmap@npm:^1.0.2": + version: 1.0.2 + resolution: "side-channel-weakmap@npm:1.0.2" + dependencies: + call-bound: ^1.0.2 + es-errors: ^1.3.0 + get-intrinsic: ^1.2.5 + object-inspect: ^1.13.3 + side-channel-map: ^1.0.1 + checksum: a815c89bc78c5723c714ea1a77c938377ea710af20d4fb886d362b0d1f8ac73a17816a5f6640f354017d7e292a43da9c5e876c22145bac00b76cfb3468001736 + languageName: node + linkType: hard + +"side-channel@npm:^1.0.4, side-channel@npm:^1.1.0": + version: 1.1.0 + resolution: "side-channel@npm:1.1.0" + dependencies: + es-errors: ^1.3.0 + object-inspect: ^1.13.3 + side-channel-list: ^1.0.0 + side-channel-map: ^1.0.1 + side-channel-weakmap: ^1.0.2 + checksum: bf73d6d6682034603eb8e99c63b50155017ed78a522d27c2acec0388a792c3ede3238b878b953a08157093b85d05797217d270b7666ba1f111345fbe933380ff languageName: node linkType: hard -"signal-exit@npm:^3.0.0, signal-exit@npm:^3.0.2, signal-exit@npm:^3.0.3, signal-exit@npm:^3.0.5, signal-exit@npm:^3.0.6, signal-exit@npm:^3.0.7": +"signal-exit@npm:^3.0.0, signal-exit@npm:^3.0.2, signal-exit@npm:^3.0.3, signal-exit@npm:^3.0.5, signal-exit@npm:^3.0.6": version: 3.0.7 resolution: "signal-exit@npm:3.0.7" checksum: a2f098f247adc367dffc27845853e9959b9e88b01cb301658cfe4194352d8d2bb32e18467c786a7fe15f1d44b233ea35633d076d5e737870b7139949d1ab6318 @@ -20654,11 +20822,11 @@ __metadata: linkType: hard "simple-swizzle@npm:^0.2.2": - version: 0.2.2 - resolution: "simple-swizzle@npm:0.2.2" + version: 0.2.4 + resolution: "simple-swizzle@npm:0.2.4" dependencies: is-arrayish: ^0.3.1 - checksum: a7f3f2ab5c76c4472d5c578df892e857323e452d9f392e1b5cf74b74db66e6294a1e1b8b390b519fa1b96b5b613f2a37db6cffef52c3f1f8f3c5ea64eb2d54c0 + checksum: 9a2f6f39a6b9fab68f96903523bf19953ec21e5e843108154cf47a9cc0f78955dd44f64499ffb71a849ac10c758d9fab7533627c7ca3ab40b5c177117acfdc1b languageName: node linkType: hard @@ -20688,9 +20856,9 @@ __metadata: linkType: hard "slugify@npm:^1.4.4, slugify@npm:^1.6.1": - version: 1.6.5 - resolution: "slugify@npm:1.6.5" - checksum: a955a1b600201030f4c1daa9bb74a17d4402a0693fc40978bbd17e44e64fd72dad3bac4037422aa8aed55b5170edd57f3f4cd8f59ba331f5cf0f10f1a7795609 + version: 1.6.6 + resolution: "slugify@npm:1.6.6" + checksum: 04773c2d3b7aea8d2a61fa47cc7e5d29ce04e1a96cbaec409da57139df906acb3a449fac30b167d203212c806e73690abd4ff94fbad0a9a7b7ea109a2a638ae9 languageName: node linkType: hard @@ -20777,24 +20945,24 @@ __metadata: languageName: node linkType: hard -"socks-proxy-agent@npm:^7.0.0": - version: 7.0.0 - resolution: "socks-proxy-agent@npm:7.0.0" +"socks-proxy-agent@npm:^8.0.3": + version: 8.0.5 + resolution: "socks-proxy-agent@npm:8.0.5" dependencies: - agent-base: ^6.0.2 - debug: ^4.3.3 - socks: ^2.6.2 - checksum: 720554370154cbc979e2e9ce6a6ec6ced205d02757d8f5d93fe95adae454fc187a5cbfc6b022afab850a5ce9b4c7d73e0f98e381879cf45f66317a4895953846 + agent-base: ^7.1.2 + debug: ^4.3.4 + socks: ^2.8.3 + checksum: b4fbcdb7ad2d6eec445926e255a1fb95c975db0020543fbac8dfa6c47aecc6b3b619b7fb9c60a3f82c9b2969912a5e7e174a056ae4d98cb5322f3524d6036e1d languageName: node linkType: hard -"socks@npm:^2.6.2": - version: 2.7.1 - resolution: "socks@npm:2.7.1" +"socks@npm:^2.8.3": + version: 2.8.7 + resolution: "socks@npm:2.8.7" dependencies: - ip: ^2.0.0 + ip-address: ^10.0.1 smart-buffer: ^4.2.0 - checksum: 259d9e3e8e1c9809a7f5c32238c3d4d2a36b39b83851d0f573bfde5f21c4b1288417ce1af06af1452569cd1eb0841169afd4998f0e04ba04656f6b7f0e46d748 + checksum: 4bbe2c88cf0eeaf49f94b7f11564a99b2571bde6fd1e714ff95b38f89e1f97858c19e0ab0e6d39eb7f6a984fa67366825895383ed563fe59962a1d57a1d55318 languageName: node linkType: hard @@ -20812,17 +20980,10 @@ __metadata: languageName: node linkType: hard -"source-map-js@npm:>=0.6.2 <2.0.0, source-map-js@npm:^1.0.2": - version: 1.0.2 - resolution: "source-map-js@npm:1.0.2" - checksum: c049a7fc4deb9a7e9b481ae3d424cc793cb4845daa690bc5a05d428bf41bf231ced49b4cf0c9e77f9d42fdb3d20d6187619fc586605f5eabe995a316da8d377c - languageName: node - linkType: hard - -"source-map-js@npm:^1.2.0": - version: 1.2.0 - resolution: "source-map-js@npm:1.2.0" - checksum: 791a43306d9223792e84293b00458bf102a8946e7188f3db0e4e22d8d530b5f80a4ce468eb5ec0bf585443ad55ebbd630bf379c98db0b1f317fd902500217f97 +"source-map-js@npm:>=0.6.2 <2.0.0, source-map-js@npm:^1.2.1": + version: 1.2.1 + resolution: "source-map-js@npm:1.2.1" + checksum: 4eb0cd997cdf228bc253bcaff9340afeb706176e64868ecd20efbe6efea931465f43955612346d6b7318789e5265bdc419bc7669c1cebe3db0eb255f57efa76b languageName: node linkType: hard @@ -20851,9 +21012,16 @@ __metadata: linkType: hard "source-map@npm:^0.7.3": - version: 0.7.4 - resolution: "source-map@npm:0.7.4" - checksum: 01cc5a74b1f0e1d626a58d36ad6898ea820567e87f18dfc9d24a9843a351aaa2ec09b87422589906d6ff1deed29693e176194dc88bcae7c9a852dc74b311dbf5 + version: 0.7.6 + resolution: "source-map@npm:0.7.6" + checksum: 932f4a2390aa7100e91357d88cc272de984ad29139ac09eedfde8cc78d46da35f389065d0c5343c5d71d054a6ebd4939a8c0f2c98d5df64fe97bb8a730596c2d + languageName: node + linkType: hard + +"sourcemap-codec@npm:^1.4.4, sourcemap-codec@npm:^1.4.8": + version: 1.4.8 + resolution: "sourcemap-codec@npm:1.4.8" + checksum: b57981c05611afef31605732b598ccf65124a9fcb03b833532659ac4d29ac0f7bfacbc0d6c5a28a03e84c7510e7e556d758d0bb57786e214660016fb94279316 languageName: node linkType: hard @@ -20892,21 +21060,21 @@ __metadata: linkType: hard "spdx-license-ids@npm:^3.0.0": - version: 3.0.18 - resolution: "spdx-license-ids@npm:3.0.18" - checksum: 457825df5dd1fc0135b0bb848c896143f70945cc2da148afc71c73ed0837d1d651f809006e406d82109c9dd71a8cb39785a3604815fe46bc0548e9d3976f6b69 + version: 3.0.22 + resolution: "spdx-license-ids@npm:3.0.22" + checksum: 3810ce1ddd8c67d7cfa76a0af05157090a2d93e5bb93bd85bf9735f1fd8062c5b510423a4669dc7d8c34b0892b27a924b1c6f8965f85d852aa25062cceff5e29 languageName: node linkType: hard -"spectaql@npm:^3.0.2": - version: 3.0.2 - resolution: "spectaql@npm:3.0.2" +"spectaql@npm:^3.0.6": + version: 3.0.6 + resolution: "spectaql@npm:3.0.6" dependencies: "@anvilco/apollo-server-plugin-introspection-metadata": ^2.2.3 "@graphql-tools/load-files": ^6.3.2 "@graphql-tools/merge": ^8.1.2 - "@graphql-tools/schema": ^9.0.1 - "@graphql-tools/utils": ^9.1.1 + "@graphql-tools/schema": ^10.0.6 + "@graphql-tools/utils": ^10.6.1 cheerio: 1.0.0-rc.12 coffeescript: ^2.6.1 commander: ^10.0.0 @@ -20936,10 +21104,10 @@ __metadata: postcss: ^8.4.19 sass: ^1.32.13 sync-request: ^6.1.0 - tmp: 0.2.1 + tmp: 0.2.4 bin: spectaql: bin/spectaql.js - checksum: 132da4d326d3d4ab3667ef93a501d3d3a9fb522f612e1de8b8a2da2c38f655531ea2b26d584fbbe669733d46547b5827c35899e19d45f23f08328ece10b47a20 + checksum: deac07bc83e37f797345ad35f0a4a4f567ad76b94f29f389b5ff63db0427746e99567232f1a9d5583d8b12ef6e6f4176402a032c0fd79ef49c95b6126b766461 languageName: node linkType: hard @@ -20960,9 +21128,9 @@ __metadata: linkType: hard "sprintf-js@npm:^1.1.1": - version: 1.1.2 - resolution: "sprintf-js@npm:1.1.2" - checksum: d4bb46464632b335e5faed381bd331157e0af64915a98ede833452663bc672823db49d7531c32d58798e85236581fb7342fd0270531ffc8f914e186187bf1c90 + version: 1.1.3 + resolution: "sprintf-js@npm:1.1.3" + checksum: a3fdac7b49643875b70864a9d9b469d87a40dfeaf5d34d9d0c5b1cda5fd7d065531fcb43c76357d62254c57184a7b151954156563a4d6a747015cfb41021cad0 languageName: node linkType: hard @@ -20974,8 +21142,8 @@ __metadata: linkType: hard "sshpk@npm:^1.7.0": - version: 1.17.0 - resolution: "sshpk@npm:1.17.0" + version: 1.18.0 + resolution: "sshpk@npm:1.18.0" dependencies: asn1: ~0.2.3 assert-plus: ^1.0.0 @@ -20990,7 +21158,7 @@ __metadata: sshpk-conv: bin/sshpk-conv sshpk-sign: bin/sshpk-sign sshpk-verify: bin/sshpk-verify - checksum: ba109f65c8e6c35133b8e6ed5576abeff8aa8d614824b7275ec3ca308f081fef483607c28d97780c1e235818b0f93ed8c8b56d0a5968d5a23fd6af57718c7597 + checksum: 01d43374eee3a7e37b3b82fdbecd5518cbb2e47ccbed27d2ae30f9753f22bd6ffad31225cb8ef013bc3fb7785e686cea619203ee1439a228f965558c367c3cfa languageName: node linkType: hard @@ -21001,12 +21169,12 @@ __metadata: languageName: node linkType: hard -"ssri@npm:^9.0.0": - version: 9.0.1 - resolution: "ssri@npm:9.0.1" +"ssri@npm:^13.0.0": + version: 13.0.0 + resolution: "ssri@npm:13.0.0" dependencies: - minipass: ^3.1.1 - checksum: fb58f5e46b6923ae67b87ad5ef1c5ab6d427a17db0bead84570c2df3cd50b4ceb880ebdba2d60726588272890bae842a744e1ecce5bd2a2a582fccd5068309eb + minipass: ^7.0.3 + checksum: 9705dff9e686b11f3035fb4c3d44ce690359a15a54adcd6a18951f2763f670877321178dc72c37a2b804dba3287ecaa48726dbd0cff79b2715b1cc24521b3af3 languageName: node linkType: hard @@ -21070,13 +21238,6 @@ __metadata: languageName: node linkType: hard -"statuses@npm:2.0.1": - version: 2.0.1 - resolution: "statuses@npm:2.0.1" - checksum: 18c7623fdb8f646fb213ca4051be4df7efb3484d4ab662937ca6fbef7ced9b9e12842709872eb3020cc3504b93bde88935c9f6417489627a7786f24f8031cbcb - languageName: node - linkType: hard - "statuses@npm:>= 1.4.0 < 2, statuses@npm:>= 1.5.0 < 2, statuses@npm:~1.5.0": version: 1.5.0 resolution: "statuses@npm:1.5.0" @@ -21084,6 +21245,13 @@ __metadata: languageName: node linkType: hard +"statuses@npm:~2.0.1, statuses@npm:~2.0.2": + version: 2.0.2 + resolution: "statuses@npm:2.0.2" + checksum: 6927feb50c2a75b2a4caab2c565491f7a93ad3d8dbad7b1398d52359e9243a20e2ebe35e33726dee945125ef7a515e9097d8a1b910ba2bbd818265a2f6c39879 + languageName: node + linkType: hard + "stealthy-require@npm:^1.1.1": version: 1.1.1 resolution: "stealthy-require@npm:1.1.1" @@ -21098,6 +21266,16 @@ __metadata: languageName: node linkType: hard +"stop-iteration-iterator@npm:^1.0.0, stop-iteration-iterator@npm:^1.1.0": + version: 1.1.0 + resolution: "stop-iteration-iterator@npm:1.1.0" + dependencies: + es-errors: ^1.3.0 + internal-slot: ^1.1.0 + checksum: be944489d8829fb3bdec1a1cc4a2142c6b6eb317305eeace1ece978d286d6997778afa1ae8cb3bd70e2b274b9aa8c69f93febb1e15b94b1359b11058f9d3c3a1 + languageName: node + linkType: hard + "stream-browserify@npm:^2.0.1": version: 2.0.2 resolution: "stream-browserify@npm:2.0.2" @@ -21183,7 +21361,7 @@ __metadata: languageName: node linkType: hard -"string-width-cjs@npm:string-width@^4.2.0, string-width@npm:^1.0.2 || 2 || 3 || 4, string-width@npm:^4.0.0, string-width@npm:^4.1.0, string-width@npm:^4.2.0, string-width@npm:^4.2.2, string-width@npm:^4.2.3": +"string-width-cjs@npm:string-width@^4.2.0, string-width@npm:^4.0.0, string-width@npm:^4.1.0, string-width@npm:^4.2.0, string-width@npm:^4.2.2, string-width@npm:^4.2.3": version: 4.2.3 resolution: "string-width@npm:4.2.3" dependencies: @@ -21216,41 +21394,83 @@ __metadata: languageName: node linkType: hard -"string.prototype.matchall@npm:^4.0.7": - version: 4.0.8 - resolution: "string.prototype.matchall@npm:4.0.8" +"string.prototype.includes@npm:^2.0.1": + version: 2.0.1 + resolution: "string.prototype.includes@npm:2.0.1" dependencies: - call-bind: ^1.0.2 - define-properties: ^1.1.4 - es-abstract: ^1.20.4 - get-intrinsic: ^1.1.3 - has-symbols: ^1.0.3 - internal-slot: ^1.0.3 - regexp.prototype.flags: ^1.4.3 - side-channel: ^1.0.4 - checksum: 952da3a818de42ad1c10b576140a5e05b4de7b34b8d9dbf00c3ac8c1293e9c0f533613a39c5cda53e0a8221f2e710bc2150e730b1c2278d60004a8a35726efb6 + call-bind: ^1.0.7 + define-properties: ^1.2.1 + es-abstract: ^1.23.3 + checksum: ed4b7058b092f30d41c4df1e3e805eeea92479d2c7a886aa30f42ae32fde8924a10cc99cccc99c29b8e18c48216608a0fe6bf887f8b4aadf9559096a758f313a + languageName: node + linkType: hard + +"string.prototype.matchall@npm:^4.0.12": + version: 4.0.12 + resolution: "string.prototype.matchall@npm:4.0.12" + dependencies: + call-bind: ^1.0.8 + call-bound: ^1.0.3 + define-properties: ^1.2.1 + es-abstract: ^1.23.6 + es-errors: ^1.3.0 + es-object-atoms: ^1.0.0 + get-intrinsic: ^1.2.6 + gopd: ^1.2.0 + has-symbols: ^1.1.0 + internal-slot: ^1.1.0 + regexp.prototype.flags: ^1.5.3 + set-function-name: ^2.0.2 + side-channel: ^1.1.0 + checksum: 98a09d6af91bfc6ee25556f3d7cd6646d02f5f08bda55d45528ed273d266d55a71af7291fe3fc76854deffb9168cc1a917d0b07a7d5a178c7e9537c99e6d2b57 + languageName: node + linkType: hard + +"string.prototype.repeat@npm:^1.0.0": + version: 1.0.0 + resolution: "string.prototype.repeat@npm:1.0.0" + dependencies: + define-properties: ^1.1.3 + es-abstract: ^1.17.5 + checksum: 95dfc514ed7f328d80a066dabbfbbb1615c3e51490351085409db2eb7cbfed7ea29fdadaf277647fbf9f4a1e10e6dd9e95e78c0fd2c4e6bb6723ea6e59401004 + languageName: node + linkType: hard + +"string.prototype.trim@npm:^1.2.10": + version: 1.2.10 + resolution: "string.prototype.trim@npm:1.2.10" + dependencies: + call-bind: ^1.0.8 + call-bound: ^1.0.2 + define-data-property: ^1.1.4 + define-properties: ^1.2.1 + es-abstract: ^1.23.5 + es-object-atoms: ^1.0.0 + has-property-descriptors: ^1.0.2 + checksum: 87659cd8561237b6c69f5376328fda934693aedde17bb7a2c57008e9d9ff992d0c253a391c7d8d50114e0e49ff7daf86a362f7961cf92f7564cd01342ca2e385 languageName: node linkType: hard -"string.prototype.trimend@npm:^1.0.5": - version: 1.0.6 - resolution: "string.prototype.trimend@npm:1.0.6" +"string.prototype.trimend@npm:^1.0.9": + version: 1.0.9 + resolution: "string.prototype.trimend@npm:1.0.9" dependencies: - call-bind: ^1.0.2 - define-properties: ^1.1.4 - es-abstract: ^1.20.4 - checksum: 0fdc34645a639bd35179b5a08227a353b88dc089adf438f46be8a7c197fc3f22f8514c1c9be4629b3cd29c281582730a8cbbad6466c60f76b5f99cf2addb132e + call-bind: ^1.0.8 + call-bound: ^1.0.2 + define-properties: ^1.2.1 + es-object-atoms: ^1.0.0 + checksum: cb86f639f41d791a43627784be2175daa9ca3259c7cb83e7a207a729909b74f2ea0ec5d85de5761e6835e5f443e9420c6ff3f63a845378e4a61dd793177bc287 languageName: node linkType: hard -"string.prototype.trimstart@npm:^1.0.5": - version: 1.0.6 - resolution: "string.prototype.trimstart@npm:1.0.6" +"string.prototype.trimstart@npm:^1.0.8": + version: 1.0.8 + resolution: "string.prototype.trimstart@npm:1.0.8" dependencies: - call-bind: ^1.0.2 - define-properties: ^1.1.4 - es-abstract: ^1.20.4 - checksum: 89080feef416621e6ef1279588994305477a7a91648d9436490d56010a1f7adc39167cddac7ce0b9884b8cdbef086987c4dcb2960209f2af8bac0d23ceff4f41 + call-bind: ^1.0.7 + define-properties: ^1.2.1 + es-object-atoms: ^1.0.0 + checksum: df1007a7f580a49d692375d996521dc14fd103acda7f3034b3c558a60b82beeed3a64fa91e494e164581793a8ab0ae2f59578a49896a7af6583c1f20472bce96 languageName: node linkType: hard @@ -21261,7 +21481,7 @@ __metadata: languageName: node linkType: hard -"string_decoder@npm:^1.0.0, string_decoder@npm:^1.1.1": +"string_decoder@npm:^1.0.0, string_decoder@npm:^1.1.1, string_decoder@npm:^1.3.0": version: 1.3.0 resolution: "string_decoder@npm:1.3.0" dependencies: @@ -21329,21 +21549,12 @@ __metadata: languageName: node linkType: hard -"strip-ansi@npm:^7.0.0": - version: 7.1.0 - resolution: "strip-ansi@npm:7.1.0" - dependencies: - ansi-regex: ^6.0.1 - checksum: 859c73fcf27869c22a4e4d8c6acfe690064659e84bef9458aa6d13719d09ca88dcfd40cbf31fd0be63518ea1a643fe070b4827d353e09533a5b0b9fd4553d64d - languageName: node - linkType: hard - -"strip-ansi@npm:^7.0.1": - version: 7.0.1 - resolution: "strip-ansi@npm:7.0.1" +"strip-ansi@npm:^7.0.0, strip-ansi@npm:^7.0.1": + version: 7.1.2 + resolution: "strip-ansi@npm:7.1.2" dependencies: ansi-regex: ^6.0.1 - checksum: 257f78fa433520e7f9897722731d78599cb3fce29ff26a20a5e12ba4957463b50a01136f37c43707f4951817a75e90820174853d6ccc240997adc5df8f966039 + checksum: db0e3f9654e519c8a33c50fc9304d07df5649388e7da06d3aabf66d29e5ad65d5e6315d8519d409c15b32fa82c1df7e11ed6f8cd50b0e4404463f0c9d77c8d0b languageName: node linkType: hard @@ -21398,6 +21609,13 @@ __metadata: languageName: node linkType: hard +"strnum@npm:^1.1.1": + version: 1.1.2 + resolution: "strnum@npm:1.1.2" + checksum: a85219eda13e97151c95e343a9e5960eacfb0a0ff98104b4c9cb7a212e3008bddf0c9714c9c37c2e508be78e741a04afc80027c2dc18509d1b5ffd4c37191fc2 + languageName: node + linkType: hard + "strtok3@npm:^6.2.4": version: 6.3.0 resolution: "strtok3@npm:6.3.0" @@ -21421,11 +21639,11 @@ __metadata: linkType: hard "style-loader@npm:^3.3.1": - version: 3.3.1 - resolution: "style-loader@npm:3.3.1" + version: 3.3.4 + resolution: "style-loader@npm:3.3.4" peerDependencies: webpack: ^5.0.0 - checksum: 470feef680f59e2fce4d6601b5c55b88c01ad8d1dd693c528ffd591ff5fd7c01a4eff3bdbe62f26f847d6bd2430c9ab594be23307cfe7a3446ab236683f0d066 + checksum: caac3f2fe2c3c89e49b7a2a9329e1cfa515ecf5f36b9c4885f9b218019fda207a9029939b2c35821dec177a264a007e7c391ccdd3ff7401881ce6287b9c8f38b languageName: node linkType: hard @@ -21439,8 +21657,8 @@ __metadata: linkType: hard "styled-components@npm:^5.3.0, styled-components@npm:^5.3.5": - version: 5.3.6 - resolution: "styled-components@npm:5.3.6" + version: 5.3.11 + resolution: "styled-components@npm:5.3.11" dependencies: "@babel/helper-module-imports": ^7.0.0 "@babel/traverse": ^7.4.5 @@ -21456,7 +21674,7 @@ __metadata: react: ">= 16.8.0" react-dom: ">= 16.8.0" react-is: ">= 16.8.0" - checksum: 68eac1e451be81d66739cf86de8ec9e72f46e7584aa359271761a2437468210bd7cf0a864281fc97dab08c32b35e6bf7513dc8b4104ed6b196cf8d65674dd289 + checksum: 10edd4dae3b0231ec02d86bdd09c88e894eedfa7e9d4f8e562b09fb69c67a27d586cbcf35c785002d59b3bf11e6c0940b0efce40d13ae9ed148b26b1dc8f3284 languageName: node linkType: hard @@ -21472,10 +21690,10 @@ __metadata: languageName: node linkType: hard -"stylis@npm:4.1.3": - version: 4.1.3 - resolution: "stylis@npm:4.1.3" - checksum: d04dbffcb9bf2c5ca8d8dc09534203c75df3bf711d33973ea22038a99cc475412a350b661ebd99cbc01daa50d7eedcf0d130d121800eb7318759a197023442a6 +"stylis@npm:4.2.0": + version: 4.2.0 + resolution: "stylis@npm:4.2.0" + checksum: 0eb6cc1b866dc17a6037d0a82ac7fa877eba6a757443e79e7c4f35bacedbf6421fadcab4363b39667b43355cbaaa570a3cde850f776498e5450f32ed2f9b7584 languageName: node linkType: hard @@ -21521,9 +21739,9 @@ __metadata: linkType: hard "supports-color@npm:^9.0.0": - version: 9.2.3 - resolution: "supports-color@npm:9.2.3" - checksum: 47d598b70d2bac3cbce98950344134de17c2935f45e8ad6256cde78ebe5da440e240d9fa17c1146bd84b1c36f865239fef6c563d70068a8d901ca5a6c56960af + version: 9.4.0 + resolution: "supports-color@npm:9.4.0" + checksum: cb8ff8daeaf1db642156f69a9aa545b6c01dd9c4def4f90a49f46cbf24be0c245d392fcf37acd119cd1819b99dad2cc9b7e3260813f64bcfd7f5b18b5a1eefb8 languageName: node linkType: hard @@ -21534,7 +21752,7 @@ __metadata: languageName: node linkType: hard -"svgo@npm:^2.7.0, svgo@npm:^2.8.0": +"svgo@npm:^2.7.0": version: 2.8.0 resolution: "svgo@npm:2.8.0" dependencies: @@ -21594,12 +21812,12 @@ __metadata: linkType: hard "swiper@npm:^8.3.2": - version: 8.4.4 - resolution: "swiper@npm:8.4.4" + version: 8.4.7 + resolution: "swiper@npm:8.4.7" dependencies: dom7: ^4.0.4 ssr-window: ^4.0.2 - checksum: 1b016e2be22573f764d00963c919dc3338a47e261bce3d5b50d6e2abb5e1760c606441739b789c96a777675457e85595d76d851a80c3d34417e0c78c9886cb93 + checksum: c52be6105e12984ba024f8cb4c0627919d4069172c0021ed7c5743c3709b5a814dd50d134813ea4f7019048be6ff9dda96db8f1adf38e317c8bb285574fcd006 languageName: node linkType: hard @@ -21631,15 +21849,15 @@ __metadata: linkType: hard "table@npm:^6.0.9": - version: 6.8.1 - resolution: "table@npm:6.8.1" + version: 6.9.0 + resolution: "table@npm:6.9.0" dependencies: ajv: ^8.0.1 lodash.truncate: ^4.4.2 slice-ansi: ^4.0.0 string-width: ^4.2.3 strip-ansi: ^6.0.1 - checksum: 08249c7046125d9d0a944a6e96cfe9ec66908d6b8a9db125531be6eb05fa0de047fd5542e9d43b4f987057f00a093b276b8d3e19af162a9c40db2681058fd306 + checksum: f54a7d1c11cda8c676e1e9aff5e723646905ed4579cca14b3ce12d2b12eac3e18f5dbe2549fe0b79697164858e18961145db4dd0660bbeb0fb4032af0aaf32b4 languageName: node linkType: hard @@ -21650,22 +21868,22 @@ __metadata: languageName: node linkType: hard -"tapable@npm:^2.1.1, tapable@npm:^2.2.0": - version: 2.2.1 - resolution: "tapable@npm:2.2.1" - checksum: 3b7a1b4d86fa940aad46d9e73d1e8739335efd4c48322cb37d073eb6f80f5281889bf0320c6d8ffcfa1a0dd5bfdbd0f9d037e252ef972aca595330538aac4d51 +"tapable@npm:^2.2.0, tapable@npm:^2.3.0": + version: 2.3.0 + resolution: "tapable@npm:2.3.0" + checksum: ada1194219ad550e3626d15019d87a2b8e77521d8463ab1135f46356e987a4c37eff1e87ffdd5acd573590962e519cc81e8ea6f7ed632c66bb58c0f12bd772a4 languageName: node linkType: hard "tar-fs@npm:^2.0.0, tar-fs@npm:^2.1.1": - version: 2.1.3 - resolution: "tar-fs@npm:2.1.3" + version: 2.1.4 + resolution: "tar-fs@npm:2.1.4" dependencies: chownr: ^1.1.1 mkdirp-classic: ^0.5.2 pump: ^3.0.0 tar-stream: ^2.1.4 - checksum: 8dd66c20779c1fe535df5cf2ab5132705c12aba3ab95283f225a798329c5aaa8bbe92144c8e21bc9404f46a0d3ce59fc4997f5c42bafc55b6a225d4ad15aa966 + checksum: a9e18e2e6114b8ac2568d7c2b42d006b1fe30d83957e4e75ba2361a889c2fc54e54236476782d06494e081358a393feacdf19311df12b3056c8a64dc1f7ed309 languageName: node linkType: hard @@ -21682,17 +21900,16 @@ __metadata: languageName: node linkType: hard -"tar@npm:^6.1.11, tar@npm:^6.1.2": - version: 6.2.1 - resolution: "tar@npm:6.2.1" +"tar@npm:^7.4.0, tar@npm:^7.5.2": + version: 7.5.2 + resolution: "tar@npm:7.5.2" dependencies: - chownr: ^2.0.0 - fs-minipass: ^2.0.0 - minipass: ^5.0.0 - minizlib: ^2.1.1 - mkdirp: ^1.0.3 - yallist: ^4.0.0 - checksum: f1322768c9741a25356c11373bce918483f40fa9a25c69c59410c8a1247632487edef5fe76c5f12ac51a6356d2f1829e96d2bc34098668a2fc34d76050ac2b6c + "@isaacs/fs-minipass": ^4.0.0 + chownr: ^3.0.0 + minipass: ^7.1.2 + minizlib: ^3.1.0 + yallist: ^5.0.0 + checksum: 192559b0e7af17d57c7747592ef22c14d5eba2d9c35996320ccd20c3e2038160fe8d928fc5c08b2aa1b170c4d0a18c119441e81eae8f227ca2028d5bcaa6bf23 languageName: node linkType: hard @@ -21703,37 +21920,15 @@ __metadata: languageName: node linkType: hard -"terser-webpack-plugin@npm:^5.2.4": - version: 5.3.6 - resolution: "terser-webpack-plugin@npm:5.3.6" - dependencies: - "@jridgewell/trace-mapping": ^0.3.14 - jest-worker: ^27.4.5 - schema-utils: ^3.1.1 - serialize-javascript: ^6.0.0 - terser: ^5.14.1 - peerDependencies: - webpack: ^5.1.0 - peerDependenciesMeta: - "@swc/core": - optional: true - esbuild: - optional: true - uglify-js: - optional: true - checksum: 8f3448d7fdb0434ce6a0c09d95c462bfd2f4a5a430233d854163337f734a7f5c07c74513d16081e06d4ca33d366d5b1a36f5444219bc41a7403afd6162107bad - languageName: node - linkType: hard - -"terser-webpack-plugin@npm:^5.3.10": - version: 5.3.10 - resolution: "terser-webpack-plugin@npm:5.3.10" +"terser-webpack-plugin@npm:^5.2.4, terser-webpack-plugin@npm:^5.3.16": + version: 5.3.16 + resolution: "terser-webpack-plugin@npm:5.3.16" dependencies: - "@jridgewell/trace-mapping": ^0.3.20 + "@jridgewell/trace-mapping": ^0.3.25 jest-worker: ^27.4.5 - schema-utils: ^3.1.1 - serialize-javascript: ^6.0.1 - terser: ^5.26.0 + schema-utils: ^4.3.0 + serialize-javascript: ^6.0.2 + terser: ^5.31.1 peerDependencies: webpack: ^5.1.0 peerDependenciesMeta: @@ -21743,35 +21938,21 @@ __metadata: optional: true uglify-js: optional: true - checksum: bd6e7596cf815f3353e2a53e79cbdec959a1b0276f5e5d4e63e9d7c3c5bb5306df567729da287d1c7b39d79093e56863c569c42c6c24cc34c76aa313bd2cbcea - languageName: node - linkType: hard - -"terser@npm:^5.14.1, terser@npm:^5.2.0": - version: 5.15.1 - resolution: "terser@npm:5.15.1" - dependencies: - "@jridgewell/source-map": ^0.3.2 - acorn: ^8.5.0 - commander: ^2.20.0 - source-map-support: ~0.5.20 - bin: - terser: bin/terser - checksum: 9880a1e0956983a1ce5de204ea35121c0009fa41d582a6904ae850e1953a1a2cc021168439565280c5a8eee67c85a874175627e24989b046c7a72589b81c3979 + checksum: 4a9ba15a0917fa0de565f6d722cac1c5291fbb517a9afe3a2cce7edf851f0e02ee44ea45e2547aeb4fb7d599df3f1ccb04ba405879839d5425481c7180655679 languageName: node linkType: hard -"terser@npm:^5.26.0": - version: 5.31.3 - resolution: "terser@npm:5.31.3" +"terser@npm:^5.2.0, terser@npm:^5.31.1": + version: 5.44.1 + resolution: "terser@npm:5.44.1" dependencies: "@jridgewell/source-map": ^0.3.3 - acorn: ^8.8.2 + acorn: ^8.15.0 commander: ^2.20.0 source-map-support: ~0.5.20 bin: terser: bin/terser - checksum: cb4ccd5cb42c719272959dcae63d41e4696fb304123392943282caa6dfcdc49f94e7c48353af8bcd4fbc34457b240b7f843db7fec21bb2bdc18e01d4f45b035e + checksum: 1113c5711bb53127f9886e3c906fde8a93a665b532db9c7e36ff7bf287e032ed48ea0e5a3a1a27f6a27c3c0f934e47e7590fcd15c76b7b7bd44ad751b8a9ede4 languageName: node linkType: hard @@ -21818,12 +21999,12 @@ __metadata: linkType: hard "timers-ext@npm:^0.1.7": - version: 0.1.7 - resolution: "timers-ext@npm:0.1.7" + version: 0.1.8 + resolution: "timers-ext@npm:0.1.8" dependencies: - es5-ext: ~0.10.46 - next-tick: 1 - checksum: ef3f27a0702a88d885bcbb0317c3e3ecd094ce644da52e7f7d362394a125d9e3578292a8f8966071a980d8abbc3395725333b1856f3ae93835b46589f700d938 + es5-ext: ^0.10.64 + next-tick: ^1.1.0 + checksum: 7d37f90bdcee900aa4ba13e983905e2d16538bb13d38315f1ea3670656d91e7898f018909caedc8ebe964974ddeb3eedb5ffdc21f2329e34e6bcc353d0ee2903 languageName: node linkType: hard @@ -21849,9 +22030,19 @@ __metadata: linkType: hard "tinycolor2@npm:^1.4.1": - version: 1.4.2 - resolution: "tinycolor2@npm:1.4.2" - checksum: 57ed262e08815a4ab0ed933edafdbc6555a17081781766149813b44a080ecbe58b3ee281e81c0e75b42e4d41679f138cfa98eabf043f829e0683c04adb12c031 + version: 1.6.0 + resolution: "tinycolor2@npm:1.6.0" + checksum: 6df4d07fceeedc0a878d7bac47e2cd47c1ceeb1078340a9eb8a295bc0651e17c750f73d47b3028d829f30b85c15e0572c0fd4142083e4c21a30a597e47f47230 + languageName: node + linkType: hard + +"tinyglobby@npm:^0.2.12": + version: 0.2.15 + resolution: "tinyglobby@npm:0.2.15" + dependencies: + fdir: ^6.5.0 + picomatch: ^4.0.3 + checksum: 0e33b8babff966c6ab86e9b825a350a6a98a63700fa0bb7ae6cf36a7770a508892383adc272f7f9d17aaf46a9d622b455e775b9949a3f951eaaf5dfb26331d44 languageName: node linkType: hard @@ -21874,12 +22065,10 @@ __metadata: languageName: node linkType: hard -"tmp@npm:0.2.1, tmp@npm:^0.2.1": - version: 0.2.1 - resolution: "tmp@npm:0.2.1" - dependencies: - rimraf: ^3.0.0 - checksum: 8b1214654182575124498c87ca986ac53dc76ff36e8f0e0b67139a8d221eaecfdec108c0e6ec54d76f49f1f72ab9325500b246f562b926f85bcdfca8bf35df9e +"tmp@npm:0.2.4": + version: 0.2.4 + resolution: "tmp@npm:0.2.4" + checksum: fde5fcdbd741c957458d6f7310750879172b399ac62b468c6707cef6fd0e77d0e632dd05471f607530a248c483abaa00187a6eee8561030268ac98bfb5e41720 languageName: node linkType: hard @@ -21892,6 +22081,13 @@ __metadata: languageName: node linkType: hard +"tmp@npm:^0.2.1": + version: 0.2.5 + resolution: "tmp@npm:0.2.5" + checksum: 9d18e58060114154939930457b9e198b34f9495bcc05a343bc0a0a29aa546d2c1c2b343dae05b87b17c8fde0af93ab7d8fe8574a8f6dc2cd8fd3f2ca1ad0d8e1 + languageName: node + linkType: hard + "to-arraybuffer@npm:^1.0.0, to-arraybuffer@npm:^1.0.1": version: 1.0.1 resolution: "to-arraybuffer@npm:1.0.1" @@ -21899,21 +22095,14 @@ __metadata: languageName: node linkType: hard -"to-buffer@npm:^1.2.0": - version: 1.2.1 - resolution: "to-buffer@npm:1.2.1" +"to-buffer@npm:^1.2.0, to-buffer@npm:^1.2.1, to-buffer@npm:^1.2.2": + version: 1.2.2 + resolution: "to-buffer@npm:1.2.2" dependencies: isarray: ^2.0.5 safe-buffer: ^5.2.1 typed-array-buffer: ^1.0.3 - checksum: a683dcf19bea02ed6af477513248d514b7590641170c2d64dd2b235bd9896193b0aea5f46ab64f50b787562aafce421569db6e44230b95beb8fb675a9169464b - languageName: node - linkType: hard - -"to-fast-properties@npm:^2.0.0": - version: 2.0.0 - resolution: "to-fast-properties@npm:2.0.0" - checksum: be2de62fe58ead94e3e592680052683b1ec986c72d589e7b21e5697f8744cdbf48c266fa72f6c15932894c10187b5f54573a3bcf7da0bfd964d5caf23d436168 + checksum: b0cd2417989a9f3d47273301e8cec2c9798b19a117822424686f385f3ec0239d2defd5fd9f8e76cda0b21e2a2f5de65a58e806506bf4c296c31750c5efd3ae4b languageName: node linkType: hard @@ -21940,7 +22129,7 @@ __metadata: languageName: node linkType: hard -"toidentifier@npm:1.0.1": +"toidentifier@npm:~1.0.1": version: 1.0.1 resolution: "toidentifier@npm:1.0.1" checksum: 952c29e2a85d7123239b5cfdd889a0dde47ab0497f0913d70588f19c53f7e0b5327c95f4651e413c74b785147f9637b17410ac8c846d5d4a20a5a33eb6dc3a45 @@ -21968,14 +22157,14 @@ __metadata: linkType: hard "tough-cookie@npm:^4.1.2": - version: 4.1.2 - resolution: "tough-cookie@npm:4.1.2" + version: 4.1.4 + resolution: "tough-cookie@npm:4.1.4" dependencies: psl: ^1.1.33 punycode: ^2.1.1 universalify: ^0.2.0 url-parse: ^1.5.3 - checksum: a7359e9a3e875121a84d6ba40cc184dec5784af84f67f3a56d1d2ae39b87c0e004e6ba7c7331f9622a7d2c88609032473488b28fe9f59a1fec115674589de39a + checksum: 5815059f014c31179a303c673f753f7899a6fce94ac93712c88ea5f3c26e0c042b5f0c7a599a00f8e0feeca4615dba75c3dffc54f3c1a489978aa8205e09307c languageName: node linkType: hard @@ -22042,9 +22231,9 @@ __metadata: linkType: hard "trough@npm:^2.0.0": - version: 2.1.0 - resolution: "trough@npm:2.1.0" - checksum: a577bb561c2b401cc0e1d9e188fcfcdf63b09b151ff56a668da12197fe97cac15e3d77d5b51f426ccfd94255744a9118e9e9935afe81a3644fa1be9783c82886 + version: 2.2.0 + resolution: "trough@npm:2.2.0" + checksum: 6097df63169aca1f9b08c263b1b501a9b878387f46e161dde93f6d0bba7febba93c95f876a293c5ea370f6cb03bcb687b2488c8955c3cfb66c2c0161ea8c00f6 languageName: node linkType: hard @@ -22055,15 +22244,15 @@ __metadata: languageName: node linkType: hard -"tsconfig-paths@npm:^3.14.1": - version: 3.14.1 - resolution: "tsconfig-paths@npm:3.14.1" +"tsconfig-paths@npm:^3.15.0": + version: 3.15.0 + resolution: "tsconfig-paths@npm:3.15.0" dependencies: "@types/json5": ^0.0.29 - json5: ^1.0.1 + json5: ^1.0.2 minimist: ^1.2.6 strip-bom: ^3.0.0 - checksum: 8afa01c673ebb4782ba53d3a12df97fa837ce524f8ad38ee4e2b2fd57f5ac79abc21c574e9e9eb014d93efe7fe8214001b96233b5c6ea75bd1ea82afe17a4c6d + checksum: 59f35407a390d9482b320451f52a411a256a130ff0e7543d18c6f20afab29ac19fbe55c360a93d6476213cc335a4d76ce90f67df54c4e9037f7d240920832201 languageName: node linkType: hard @@ -22074,7 +22263,14 @@ __metadata: languageName: node linkType: hard -"tslib@npm:^2.0.3, tslib@npm:^2.1.0, tslib@npm:^2.4.0, tslib@npm:~2.4.0": +"tslib@npm:^2.0.3, tslib@npm:^2.1.0, tslib@npm:^2.4.0, tslib@npm:^2.5.0, tslib@npm:^2.6.3": + version: 2.8.1 + resolution: "tslib@npm:2.8.1" + checksum: e4aba30e632b8c8902b47587fd13345e2827fa639e7c3121074d5ee0880723282411a8838f830b55100cbe4517672f84a2472667d355b81e8af165a55dc6203a + languageName: node + linkType: hard + +"tslib@npm:~2.4.0": version: 2.4.1 resolution: "tslib@npm:2.4.1" checksum: 19480d6e0313292bd6505d4efe096a6b31c70e21cf08b5febf4da62e95c265c8f571f7b36fcc3d1a17e068032f59c269fab3459d6cd3ed6949eafecf64315fca @@ -22192,17 +22388,10 @@ __metadata: languageName: node linkType: hard -"type@npm:^1.0.1": - version: 1.2.0 - resolution: "type@npm:1.2.0" - checksum: dae8c64f82c648b985caf321e9dd6e8b7f4f2e2d4f846fc6fd2c8e9dc7769382d8a52369ddbaccd59aeeceb0df7f52fb339c465be5f2e543e81e810e413451ee - languageName: node - linkType: hard - "type@npm:^2.7.2": - version: 2.7.2 - resolution: "type@npm:2.7.2" - checksum: 0f42379a8adb67fe529add238a3e3d16699d95b42d01adfe7b9a7c5da297f5c1ba93de39265ba30ffeb37dfd0afb3fb66ae09f58d6515da442219c086219f6f4 + version: 2.7.3 + resolution: "type@npm:2.7.3" + checksum: 69cfda3248847998f93b9d292fd251c10facf8d29513e2047d4684509d67bae82d910d7a00c1e9d9bbf2af242d36425b6616807d6c652c5c370c2be1f0008a47 languageName: node linkType: hard @@ -22217,6 +22406,48 @@ __metadata: languageName: node linkType: hard +"typed-array-byte-length@npm:^1.0.3": + version: 1.0.3 + resolution: "typed-array-byte-length@npm:1.0.3" + dependencies: + call-bind: ^1.0.8 + for-each: ^0.3.3 + gopd: ^1.2.0 + has-proto: ^1.2.0 + is-typed-array: ^1.1.14 + checksum: cda9352178ebeab073ad6499b03e938ebc30c4efaea63a26839d89c4b1da9d2640b0d937fc2bd1f049eb0a38def6fbe8a061b601292ae62fe079a410ce56e3a6 + languageName: node + linkType: hard + +"typed-array-byte-offset@npm:^1.0.4": + version: 1.0.4 + resolution: "typed-array-byte-offset@npm:1.0.4" + dependencies: + available-typed-arrays: ^1.0.7 + call-bind: ^1.0.8 + for-each: ^0.3.3 + gopd: ^1.2.0 + has-proto: ^1.2.0 + is-typed-array: ^1.1.15 + reflect.getprototypeof: ^1.0.9 + checksum: 670b7e6bb1d3c2cf6160f27f9f529e60c3f6f9611c67e47ca70ca5cfa24ad95415694c49d1dbfeda016d3372cab7dfc9e38c7b3e1bb8d692cae13a63d3c144d7 + languageName: node + linkType: hard + +"typed-array-length@npm:^1.0.7": + version: 1.0.7 + resolution: "typed-array-length@npm:1.0.7" + dependencies: + call-bind: ^1.0.7 + for-each: ^0.3.3 + gopd: ^1.0.1 + is-typed-array: ^1.1.13 + possible-typed-array-names: ^1.0.0 + reflect.getprototypeof: ^1.0.6 + checksum: deb1a4ffdb27cd930b02c7030cb3e8e0993084c643208e52696e18ea6dd3953dfc37b939df06ff78170423d353dc8b10d5bae5796f3711c1b3abe52872b3774c + languageName: node + linkType: hard + "typedarray-to-buffer@npm:^3.1.5": version: 3.1.5 resolution: "typedarray-to-buffer@npm:3.1.5" @@ -22233,31 +22464,33 @@ __metadata: languageName: node linkType: hard -"ua-parser-js@npm:^0.7.30": - version: 0.7.38 - resolution: "ua-parser-js@npm:0.7.38" - checksum: e9cbf26c0029746b1be4672280b4a88183787297a90b645a30a79bafde3c46542c7d80df9007092f7d76f80181da7ad9722af7f0d87c7df706de3ab833e69384 +"ua-parser-js@npm:^1.0.35": + version: 1.0.41 + resolution: "ua-parser-js@npm:1.0.41" + bin: + ua-parser-js: script/cli.js + checksum: a57c258ea3a242ade7601460ddf9a7e990d8d8bffc15df2ca87057a81993ca19f5045432c744d07bf2d9f280665d84aebb08630c5af5bea3922fdbe8f6fe6cb0 languageName: node linkType: hard "uglify-js@npm:^3.1.4, uglify-js@npm:^3.16.1": - version: 3.17.4 - resolution: "uglify-js@npm:3.17.4" + version: 3.19.3 + resolution: "uglify-js@npm:3.19.3" bin: uglifyjs: bin/uglifyjs - checksum: 7b3897df38b6fc7d7d9f4dcd658599d81aa2b1fb0d074829dd4e5290f7318dbca1f4af2f45acb833b95b1fe0ed4698662ab61b87e94328eb4c0a0d3435baf924 + checksum: 7ed6272fba562eb6a3149cfd13cda662f115847865c03099e3995a0e7a910eba37b82d4fccf9e88271bb2bcbe505bb374967450f433c17fa27aa36d94a8d0553 languageName: node linkType: hard -"unbox-primitive@npm:^1.0.2": - version: 1.0.2 - resolution: "unbox-primitive@npm:1.0.2" +"unbox-primitive@npm:^1.1.0": + version: 1.1.0 + resolution: "unbox-primitive@npm:1.1.0" dependencies: - call-bind: ^1.0.2 + call-bound: ^1.0.3 has-bigints: ^1.0.2 - has-symbols: ^1.0.3 - which-boxed-primitive: ^1.0.2 - checksum: b7a1cf5862b5e4b5deb091672ffa579aa274f648410009c81cca63fed3b62b610c4f3b773f912ce545bb4e31edc3138975b5bc777fc6e4817dca51affb6380e9 + has-symbols: ^1.1.0 + which-boxed-primitive: ^1.1.1 + checksum: 729f13b84a5bfa3fead1d8139cee5c38514e63a8d6a437819a473e241ba87eeb593646568621c7fc7f133db300ef18d65d1a5a60dc9c7beb9000364d93c581df languageName: node linkType: hard @@ -22278,10 +22511,24 @@ __metadata: languageName: node linkType: hard -"undici-types@npm:~5.26.4": - version: 5.26.5 - resolution: "undici-types@npm:5.26.5" - checksum: 3192ef6f3fd5df652f2dc1cd782b49d6ff14dc98e5dced492aa8a8c65425227da5da6aafe22523c67f035a272c599bb89cfe803c1db6311e44bed3042fc25487 +"undici-types@npm:~6.21.0": + version: 6.21.0 + resolution: "undici-types@npm:6.21.0" + checksum: 46331c7d6016bf85b3e8f20c159d62f5ae471aba1eb3dc52fff35a0259d58dcc7d592d4cc4f00c5f9243fa738a11cfa48bd20203040d4a9e6bc25e807fab7ab3 + languageName: node + linkType: hard + +"undici-types@npm:~7.16.0": + version: 7.16.0 + resolution: "undici-types@npm:7.16.0" + checksum: 1ef68fc6c5bad200c8b6f17de8e5bc5cfdcadc164ba8d7208cd087cfa8583d922d8316a7fd76c9a658c22b4123d3ff847429185094484fbc65377d695c905857 + languageName: node + linkType: hard + +"undici@npm:^7.12.0": + version: 7.18.2 + resolution: "undici@npm:7.18.2" + checksum: 6bab6fdcea6e3f0b7c5dd01da3f8956147bed90a79cbcaac3c97ccc9eb66abdd739054d45fa224c81e9a6eb6f53b3d0faf1fd4e5f0019ee9c693006de0c9688c languageName: node linkType: hard @@ -22296,9 +22543,9 @@ __metadata: linkType: hard "unicode-canonical-property-names-ecmascript@npm:^2.0.0": - version: 2.0.0 - resolution: "unicode-canonical-property-names-ecmascript@npm:2.0.0" - checksum: 39be078afd014c14dcd957a7a46a60061bc37c4508ba146517f85f60361acf4c7539552645ece25de840e17e293baa5556268d091ca6762747fdd0c705001a45 + version: 2.0.1 + resolution: "unicode-canonical-property-names-ecmascript@npm:2.0.1" + checksum: 3c3dabdb1d22aef4904399f9e810d0b71c0b12b3815169d96fac97e56d5642840c6071cf709adcace2252bc6bb80242396c2ec74b37224eb015c5f7aca40bad7 languageName: node linkType: hard @@ -22312,17 +22559,17 @@ __metadata: languageName: node linkType: hard -"unicode-match-property-value-ecmascript@npm:^2.0.0": - version: 2.0.0 - resolution: "unicode-match-property-value-ecmascript@npm:2.0.0" - checksum: 8fe6a09d9085a625cabcead5d95bdbc1a2d5d481712856092ce0347231e81a60b93a68f1b69e82b3076a07e415a72c708044efa2aa40ae23e2e7b5c99ed4a9ea +"unicode-match-property-value-ecmascript@npm:^2.2.1": + version: 2.2.1 + resolution: "unicode-match-property-value-ecmascript@npm:2.2.1" + checksum: e6c73e07bb4dc4aa399797a14b170e84a30ed290bcf97cc4305cf67dde8744119721ce17cef03f4f9d4ff48654bfa26eadc7fe1e8dd4b71b8f3b2e9a9742f013 languageName: node linkType: hard "unicode-property-aliases-ecmascript@npm:^2.0.0": - version: 2.1.0 - resolution: "unicode-property-aliases-ecmascript@npm:2.1.0" - checksum: 243524431893649b62cc674d877bd64ef292d6071dd2fd01ab4d5ad26efbc104ffcd064f93f8a06b7e4ec54c172bf03f6417921a0d8c3a9994161fe1f88f815b + version: 2.2.0 + resolution: "unicode-property-aliases-ecmascript@npm:2.2.0" + checksum: 0dd0f6e70130c59b4a841bac206758f70227b113145e4afe238161e3e8540e8eb79963e7a228cd90ad13d499e96f7ef4ee8940835404b2181ad9bf9c174818e3 languageName: node linkType: hard @@ -22344,19 +22591,19 @@ __metadata: linkType: hard "unified-engine@npm:^11.0.0": - version: 11.2.1 - resolution: "unified-engine@npm:11.2.1" + version: 11.2.2 + resolution: "unified-engine@npm:11.2.2" dependencies: "@types/concat-stream": ^2.0.0 "@types/debug": ^4.0.0 "@types/is-empty": ^1.0.0 - "@types/node": ^20.0.0 + "@types/node": ^22.0.0 "@types/unist": ^3.0.0 concat-stream: ^2.0.0 debug: ^4.0.0 extend: ^3.0.0 glob: ^10.0.0 - ignore: ^5.0.0 + ignore: ^6.0.0 is-empty: ^1.0.0 is-plain-obj: ^4.0.0 load-plugin: ^6.0.0 @@ -22368,7 +22615,7 @@ __metadata: vfile-reporter: ^8.0.0 vfile-statistics: ^3.0.0 yaml: ^2.0.0 - checksum: e0c1e82bc264ff1b478e5cd2ade839f8fcc8ba9192253e0e56ac59bc69b561f3e43e45cfa0854a1c807d750b8a77cd40e897c58f8a952eda01ee88b8e4661153 + checksum: 294d56b57293b315bf879458bc5897917033cb5bf586b3d412bae33dfe0a87d6406787b84f2b09c668badc9d264500279e55abf9ed14d2e9b2582f26963b3a45 languageName: node linkType: hard @@ -22471,21 +22718,21 @@ __metadata: languageName: node linkType: hard -"unique-filename@npm:^2.0.0": - version: 2.0.1 - resolution: "unique-filename@npm:2.0.1" +"unique-filename@npm:^5.0.0": + version: 5.0.0 + resolution: "unique-filename@npm:5.0.0" dependencies: - unique-slug: ^3.0.0 - checksum: 807acf3381aff319086b64dc7125a9a37c09c44af7620bd4f7f3247fcd5565660ac12d8b80534dcbfd067e6fe88a67e621386dd796a8af828d1337a8420a255f + unique-slug: ^6.0.0 + checksum: a5f67085caef74bdd2a6869a200ed5d68d171f5cc38435a836b5fd12cce4e4eb55e6a190298035c325053a5687ed7a3c96f0a91e82215fd14729769d9ac57d9b languageName: node linkType: hard -"unique-slug@npm:^3.0.0": - version: 3.0.0 - resolution: "unique-slug@npm:3.0.0" +"unique-slug@npm:^6.0.0": + version: 6.0.0 + resolution: "unique-slug@npm:6.0.0" dependencies: imurmurhash: ^0.1.4 - checksum: 49f8d915ba7f0101801b922062ee46b7953256c93ceca74303bd8e6413ae10aa7e8216556b54dc5382895e8221d04f1efaf75f945c2e4a515b4139f77aa6640c + checksum: ad6cf238b10292d944521714d31bc9f3ca79fa80cb7a154aad183056493f98e85de669412c6bbfe527ffa9bdeff36d3dd4d5bccaf562c794f2580ab11932b691 languageName: node linkType: hard @@ -22543,18 +22790,20 @@ __metadata: linkType: hard "unist-util-is@npm:^5.0.0": - version: 5.1.1 - resolution: "unist-util-is@npm:5.1.1" - checksum: e8743a19a304d8a8f5684f3e5ddb5546f2655847b42123687277d76566a2aba89beb7b4a8a9e9ebc4d904cd1cecc285356d7923d973a43cfc19a1e10ff6bdee4 + version: 5.2.1 + resolution: "unist-util-is@npm:5.2.1" + dependencies: + "@types/unist": ^2.0.0 + checksum: ae76fdc3d35352cd92f1bedc3a0d407c3b9c42599a52ab9141fe89bdd786b51f0ec5a2ab68b93fb532e239457cae62f7e39eaa80229e1cb94875da2eafcbe5c4 languageName: node linkType: hard "unist-util-is@npm:^6.0.0": - version: 6.0.0 - resolution: "unist-util-is@npm:6.0.0" + version: 6.0.1 + resolution: "unist-util-is@npm:6.0.1" dependencies: "@types/unist": ^3.0.0 - checksum: f630a925126594af9993b091cf807b86811371e465b5049a6283e08537d3e6ba0f7e248e1e7dab52cfe33f9002606acef093441137181b327f6fe504884b20e2 + checksum: e57733e1766b55c9a873a42d2f34daa211580788b1bba26af2fc22e48e147bdcff0f9a752ed2a19238864823735fbbe27a1804d6a5a22b182c23aa0191e41c12 languageName: node linkType: hard @@ -22678,11 +22927,11 @@ __metadata: linkType: hard "unist-util-stringify-position@npm:^3.0.0": - version: 3.0.2 - resolution: "unist-util-stringify-position@npm:3.0.2" + version: 3.0.3 + resolution: "unist-util-stringify-position@npm:3.0.3" dependencies: "@types/unist": ^2.0.0 - checksum: 2dfd7a0fb2a55e99cc319c3bf7f9f1f73ed652978fa70d19117faa7245d20f21738ec926ecc47f341705ca1bb157e87ced0b6bb5ecaa666bd2ae6b2510d6a671 + checksum: dbd66c15183607ca942a2b1b7a9f6a5996f91c0d30cf8966fb88955a02349d9eefd3974e9010ee67e71175d784c5a9fea915b0aa0b0df99dcb921b95c4c9e124 languageName: node linkType: hard @@ -22722,22 +22971,22 @@ __metadata: linkType: hard "unist-util-visit-parents@npm:^5.1.1": - version: 5.1.1 - resolution: "unist-util-visit-parents@npm:5.1.1" + version: 5.1.3 + resolution: "unist-util-visit-parents@npm:5.1.3" dependencies: "@types/unist": ^2.0.0 unist-util-is: ^5.0.0 - checksum: c699d18f5b26461dee37612b84c243fd5457c98f4c0540d9ba8bee05062aece5f3b4fb1af6b07423ce6750d8926e8c01fc2b1a4de1e54925ef6795c177ed8e18 + checksum: 8ecada5978994f846b64658cf13b4092cd78dea39e1ba2f5090a5de842ba4852712c02351a8ae95250c64f864635e7b02aedf3b4a093552bb30cf1bd160efbaa languageName: node linkType: hard "unist-util-visit-parents@npm:^6.0.0": - version: 6.0.1 - resolution: "unist-util-visit-parents@npm:6.0.1" + version: 6.0.2 + resolution: "unist-util-visit-parents@npm:6.0.2" dependencies: "@types/unist": ^3.0.0 unist-util-is: ^6.0.0 - checksum: 08927647c579f63b91aafcbec9966dc4a7d0af1e5e26fc69f4e3e6a01215084835a2321b06f3cbe7bf7914a852830fc1439f0fc3d7153d8804ac3ef851ddfa20 + checksum: cf28578a6f0b81877965e261fe82460f83b8c3a9cab3b2080c046b215f3223c6195b01064256619ca3411a1930face93a1a2a72d34d8716e684d6cd59f53cd9a languageName: node linkType: hard @@ -22762,13 +23011,13 @@ __metadata: linkType: hard "unist-util-visit@npm:^4.0.0": - version: 4.1.1 - resolution: "unist-util-visit@npm:4.1.1" + version: 4.1.2 + resolution: "unist-util-visit@npm:4.1.2" dependencies: "@types/unist": ^2.0.0 unist-util-is: ^5.0.0 unist-util-visit-parents: ^5.1.1 - checksum: c4a63734b0a5b439c62d20901bb472bdafdbbcd80c383e254aedeb98b23d0bae815a331e776ce7d63ea3c8018a54318abb8709d07cdf7dd094f79b2f07bb39f0 + checksum: 95a34e3f7b5b2d4b68fd722b6229972099eb97b6df18913eda44a5c11df8b1e27efe7206dd7b88c4ed244a48c474a5b2e2629ab79558ff9eb936840295549cee languageName: node linkType: hard @@ -22791,9 +23040,9 @@ __metadata: linkType: hard "universalify@npm:^2.0.0": - version: 2.0.0 - resolution: "universalify@npm:2.0.0" - checksum: 2406a4edf4a8830aa6813278bab1f953a8e40f2f63a37873ffa9a3bc8f9745d06cc8e88f3572cb899b7e509013f7f6fcc3e37e8a6d914167a5381d8440518c44 + version: 2.0.1 + resolution: "universalify@npm:2.0.1" + checksum: ecd8469fe0db28e7de9e5289d32bd1b6ba8f7183db34f3bfc4ca53c49891c2d6aa05f3fb3936a81285a905cc509fb641a0c3fc131ec786167eff41236ae32e60 languageName: node linkType: hard @@ -22806,42 +23055,28 @@ __metadata: languageName: node linkType: hard -"unpipe@npm:1.0.0, unpipe@npm:~1.0.0": +"unpipe@npm:~1.0.0": version: 1.0.0 resolution: "unpipe@npm:1.0.0" checksum: 4fa18d8d8d977c55cb09715385c203197105e10a6d220087ec819f50cb68870f02942244f1017565484237f1f8c5d3cd413631b1ae104d3096f24fdfde1b4aa2 languageName: node linkType: hard -"update-browserslist-db@npm:^1.0.9": - version: 1.0.10 - resolution: "update-browserslist-db@npm:1.0.10" - dependencies: - escalade: ^3.1.1 - picocolors: ^1.0.0 - peerDependencies: - browserslist: ">= 4.21.0" - bin: - browserslist-lint: cli.js - checksum: 12db73b4f63029ac407b153732e7cd69a1ea8206c9100b482b7d12859cd3cd0bc59c602d7ae31e652706189f1acb90d42c53ab24a5ba563ed13aebdddc5561a0 - languageName: node - linkType: hard - -"update-browserslist-db@npm:^1.1.0": - version: 1.1.0 - resolution: "update-browserslist-db@npm:1.1.0" +"update-browserslist-db@npm:^1.2.0": + version: 1.2.3 + resolution: "update-browserslist-db@npm:1.2.3" dependencies: - escalade: ^3.1.2 - picocolors: ^1.0.1 + escalade: ^3.2.0 + picocolors: ^1.1.1 peerDependencies: browserslist: ">= 4.21.0" bin: update-browserslist-db: cli.js - checksum: 7b74694d96f0c360f01b702e72353dc5a49df4fe6663d3ee4e5c628f061576cddf56af35a3a886238c01dd3d8f231b7a86a8ceaa31e7a9220ae31c1c1238e562 + checksum: 6f209a97ae8eacdd3a1ef2eb365adf49d1e2a757e5b2dd4ac87dc8c99236cbe3e572d3e605a87dd7b538a11751b71d9f93edc47c7405262a293a493d155316cd languageName: node linkType: hard -"update-notifier@npm:^5.0.1, update-notifier@npm:^5.1.0": +"update-notifier@npm:^5.1.0": version: 5.1.0 resolution: "update-notifier@npm:5.1.0" dependencies: @@ -22957,12 +23192,12 @@ __metadata: linkType: hard "url@npm:^0.11.0": - version: 0.11.0 - resolution: "url@npm:0.11.0" + version: 0.11.4 + resolution: "url@npm:0.11.4" dependencies: - punycode: 1.3.2 - querystring: 0.2.0 - checksum: 50d100d3dd2d98b9fe3ada48cadb0b08aa6be6d3ac64112b867b56b19be4bfcba03c2a9a0d7922bfd7ac17d4834e88537749fe182430dfd9b68e520175900d90 + punycode: ^1.4.1 + qs: ^6.12.3 + checksum: c25e587723d343d5d4248892393bfa5039ded9c2c07095a9d005bc64b7cb8956d623c0d8da8d1a28f71986a7a8d80fc2e9f9cf84235e48fa435a5cb4451062c6 languageName: node linkType: hard @@ -22991,12 +23226,12 @@ __metadata: languageName: node linkType: hard -"util@npm:0.10.3": - version: 0.10.3 - resolution: "util@npm:0.10.3" +"util@npm:^0.10.4": + version: 0.10.4 + resolution: "util@npm:0.10.4" dependencies: - inherits: 2.0.1 - checksum: bd800f5d237a82caddb61723a6cbe45297d25dd258651a31335a4d5d981fd033cb4771f82db3d5d59b582b187cb69cfe727dc6f4d8d7826f686ee6c07ce611e0 + inherits: 2.0.3 + checksum: 913f9a90d05a60e91f91af01b8bd37e06bca4cc02d7b49e01089f9d5b78be2fffd61fb1a41b517de7238c5fc7337fa939c62d1fb4eb82e014894c7bee6637aaf languageName: node linkType: hard @@ -23017,9 +23252,9 @@ __metadata: linkType: hard "utility-types@npm:^3.10.0": - version: 3.10.0 - resolution: "utility-types@npm:3.10.0" - checksum: 8f274415c6196ab62883b8bd98c9d2f8829b58016e4269aaa1ebd84184ac5dda7dc2ca45800c0d5e0e0650966ba063bf9a412aaeaea6850ca4440a391283d5c8 + version: 3.11.0 + resolution: "utility-types@npm:3.11.0" + checksum: 35a4866927bbea5d037726744028d05c6e37772ded2aabaca21480ce9380185436aef586ead525e327c7f3c640b1a3287769a12ef269c7b165a2ddd50ea6ad61 languageName: node linkType: hard @@ -23049,18 +23284,18 @@ __metadata: linkType: hard "uuid@npm:^9.0.0": - version: 9.0.0 - resolution: "uuid@npm:9.0.0" + version: 9.0.1 + resolution: "uuid@npm:9.0.1" bin: uuid: dist/bin/uuid - checksum: 8dd2c83c43ddc7e1c71e36b60aea40030a6505139af6bee0f382ebcd1a56f6cd3028f7f06ffb07f8cf6ced320b76aea275284b224b002b289f89fe89c389b028 + checksum: 39931f6da74e307f51c0fb463dc2462807531dc80760a9bff1e35af4316131b4fc3203d16da60ae33f07fdca5b56f3f1dd662da0c99fea9aaeab2004780cc5f4 languageName: node linkType: hard "v8-compile-cache@npm:^2.0.3": - version: 2.3.0 - resolution: "v8-compile-cache@npm:2.3.0" - checksum: adb0a271eaa2297f2f4c536acbfee872d0dd26ec2d76f66921aa7fc437319132773483344207bdbeee169225f4739016d8d2dbf0553913a52bb34da6d0334f8e + version: 2.4.0 + resolution: "v8-compile-cache@npm:2.4.0" + checksum: 8eb6ddb59d86f24566503f1e6ca98f3e6f43599f05359bd3ab737eaaf1585b338091478a4d3d5c2646632cf8030288d7888684ea62238cdce15a65ae2416718f languageName: node linkType: hard @@ -23097,10 +23332,10 @@ __metadata: languageName: node linkType: hard -"value-or-promise@npm:1.0.11": - version: 1.0.11 - resolution: "value-or-promise@npm:1.0.11" - checksum: 13f8f2ef620118c73b4d1beee8ce6045d7182bbf15090ecfbcafb677ec43698506a5e9ace6bea5ea35c32bc612c9b1f824bb59b6581cdfb5c919052745c277d5 +"value-or-promise@npm:^1.0.12": + version: 1.0.12 + resolution: "value-or-promise@npm:1.0.12" + checksum: f53a66c75b7447c90bbaf946a757ca09c094629cb80ba742f59c980ec3a69be0a385a0e75505dedb4e757862f1a994ca4beaf083a831f24d3ffb3d4bb18cd1e1 languageName: node linkType: hard @@ -23156,22 +23391,22 @@ __metadata: linkType: hard "vfile-message@npm:^3.0.0": - version: 3.1.2 - resolution: "vfile-message@npm:3.1.2" + version: 3.1.4 + resolution: "vfile-message@npm:3.1.4" dependencies: "@types/unist": ^2.0.0 unist-util-stringify-position: ^3.0.0 - checksum: 96fbd9e9b5e0babb5ee61e3a716dc7a6a8c28f2c8c711837d95c88b782161b31549ad16059a78990d7b836d0f4d3b4d8c9ffde44370d48d9cac991fc1e3e17c5 + checksum: d0ee7da1973ad76513c274e7912adbed4d08d180eaa34e6bd40bc82459f4b7bc50fcaff41556135e3339995575eac5f6f709aba9332b80f775618ea4880a1367 languageName: node linkType: hard "vfile-message@npm:^4.0.0": - version: 4.0.2 - resolution: "vfile-message@npm:4.0.2" + version: 4.0.3 + resolution: "vfile-message@npm:4.0.3" dependencies: "@types/unist": ^3.0.0 unist-util-stringify-position: ^4.0.0 - checksum: 964e7e119f4c0e0270fc269119c41c96da20afa01acb7c9809a88365c8e0c64aa692fafbd952669382b978002ecd7ad31ef4446d85e8a22cdb62f6df20186c2d + checksum: f5e8516f2aa0feb4c866d507543d4e90f9ab309e2c988577dbf4ebd268d495f72f2b48149849d14300164d5d60b5f74b5641cd285bb4408a3942b758683d9276 languageName: node linkType: hard @@ -23236,25 +23471,24 @@ __metadata: linkType: hard "vfile@npm:^5.0.0": - version: 5.3.5 - resolution: "vfile@npm:5.3.5" + version: 5.3.7 + resolution: "vfile@npm:5.3.7" dependencies: "@types/unist": ^2.0.0 is-buffer: ^2.0.0 unist-util-stringify-position: ^3.0.0 vfile-message: ^3.0.0 - checksum: 14a9ea19d1801bb99fc9a451d220d2ee84d891bae52094db660f9bf637c1cada0c45a3e00962ff3e901da16dd5051367e25a4a214e40db57ae40f57363796b45 + checksum: 642cce703afc186dbe7cabf698dc954c70146e853491086f5da39e1ce850676fc96b169fcf7898aa3ff245e9313aeec40da93acd1e1fcc0c146dc4f6308b4ef9 languageName: node linkType: hard "vfile@npm:^6.0.0": - version: 6.0.2 - resolution: "vfile@npm:6.0.2" + version: 6.0.3 + resolution: "vfile@npm:6.0.3" dependencies: "@types/unist": ^3.0.0 - unist-util-stringify-position: ^4.0.0 vfile-message: ^4.0.0 - checksum: 2f3f405654aa549f1902dfe0cefa5f0d785f9f65cb90989b9ab543166afabf30f9c5c4bda734d78cf08e169dd7cba08af4cdcae5563f89782caf1d4719c57646 + checksum: 152b6729be1af70df723efb65c1a1170fd483d41086557da3651eea69a1dd1f0c22ea4344834d56d30734b9185bcab63e22edc81d3f0e9bed8aa4660d61080af languageName: node linkType: hard @@ -23274,12 +23508,12 @@ __metadata: languageName: node linkType: hard -"w3c-xmlserializer@npm:^3.0.0": - version: 3.0.0 - resolution: "w3c-xmlserializer@npm:3.0.0" +"w3c-xmlserializer@npm:^4.0.0": + version: 4.0.0 + resolution: "w3c-xmlserializer@npm:4.0.0" dependencies: xml-name-validator: ^4.0.0 - checksum: 0af8589942eeb11c9fe29eb31a1a09f3d5dd136aea53a9848dfbabff79ac0dd26fe13eb54d330d5555fe27bb50b28dca0715e09f9cc2bfa7670ccc8b7f919ca2 + checksum: eba070e78deb408ae8defa4d36b429f084b2b47a4741c4a9be3f27a0a3d1845e277e3072b04391a138f7e43776842627d1334e448ff13ff90ad9fb1214ee7091 languageName: node linkType: hard @@ -23290,13 +23524,13 @@ __metadata: languageName: node linkType: hard -"watchpack@npm:^2.4.1": - version: 2.4.1 - resolution: "watchpack@npm:2.4.1" +"watchpack@npm:^2.4.4": + version: 2.5.0 + resolution: "watchpack@npm:2.5.0" dependencies: glob-to-regexp: ^0.4.1 graceful-fs: ^4.1.2 - checksum: 5b0179348655dcdf19cac7cb4ff923fdc024d630650c0bf6bec8899cf47c60e19d4f810a88dba692ed0e7f684cf0fcffea86efdbf6c35d81f031e328043b7fab + checksum: eadf369edc781d69acf47713dd889ac2e8e7b25827f121a3514a531d73f50ff40ff2d8f050184fbb00007e9f931e9a07291433a430e739cd5c4fea6a324c7aca languageName: node linkType: hard @@ -23352,12 +23586,13 @@ __metadata: linkType: hard "webpack-merge@npm:^5.8.0": - version: 5.8.0 - resolution: "webpack-merge@npm:5.8.0" + version: 5.10.0 + resolution: "webpack-merge@npm:5.10.0" dependencies: clone-deep: ^4.0.1 + flat: ^5.0.2 wildcard: ^2.0.0 - checksum: 88786ab91013f1bd2a683834ff381be81c245a4b0f63304a5103e90f6653f44dab496a0768287f8531761f8ad957d1f9f3ccb2cb55df0de1bd9ee343e079da26 + checksum: 1fe8bf5309add7298e1ac72fb3f2090e1dfa80c48c7e79fa48aa60b5961332c7d0d61efa8851acb805e6b91a4584537a347bc106e05e9aec87fa4f7088c62f2f languageName: node linkType: hard @@ -23381,17 +23616,17 @@ __metadata: languageName: node linkType: hard -"webpack-sources@npm:^3.2.3": - version: 3.2.3 - resolution: "webpack-sources@npm:3.2.3" - checksum: 989e401b9fe3536529e2a99dac8c1bdc50e3a0a2c8669cbafad31271eadd994bc9405f88a3039cd2e29db5e6d9d0926ceb7a1a4e7409ece021fe79c37d9c4607 +"webpack-sources@npm:^3.3.3": + version: 3.3.3 + resolution: "webpack-sources@npm:3.3.3" + checksum: 243d438ec4dfe805cca20fa66d111114b1f277b8ecfa95bb6ee0a6c7d996aee682539952028c2b203a6c170e6ef56f71ecf3e366e90bf1cb58b0ae982176b651 languageName: node linkType: hard "webpack-stats-plugin@npm:^1.0.3": - version: 1.1.1 - resolution: "webpack-stats-plugin@npm:1.1.1" - checksum: aa553ccfb9389f2d8a2d04eb6289230bc323edb11b0cbdd676d41617dd790a7f0d0844c46b927a9465139b3edb9da2cc7a2ef664891920c052ef4fa5f2797230 + version: 1.1.3 + resolution: "webpack-stats-plugin@npm:1.1.3" + checksum: 9a71d329c5d55e33105abfe4c72d715a0a6ce4ab8da6faa2bc5a65953915d656cdf3c420b3fc0628b0d9859cc59c09e49f731645746739e417da531130a7a9a8 languageName: node linkType: hard @@ -23405,38 +23640,40 @@ __metadata: linkType: hard "webpack@npm:^5.61.0": - version: 5.94.0 - resolution: "webpack@npm:5.94.0" - dependencies: - "@types/estree": ^1.0.5 - "@webassemblyjs/ast": ^1.12.1 - "@webassemblyjs/wasm-edit": ^1.12.1 - "@webassemblyjs/wasm-parser": ^1.12.1 - acorn: ^8.7.1 - acorn-import-attributes: ^1.9.5 - browserslist: ^4.21.10 + version: 5.104.1 + resolution: "webpack@npm:5.104.1" + dependencies: + "@types/eslint-scope": ^3.7.7 + "@types/estree": ^1.0.8 + "@types/json-schema": ^7.0.15 + "@webassemblyjs/ast": ^1.14.1 + "@webassemblyjs/wasm-edit": ^1.14.1 + "@webassemblyjs/wasm-parser": ^1.14.1 + acorn: ^8.15.0 + acorn-import-phases: ^1.0.3 + browserslist: ^4.28.1 chrome-trace-event: ^1.0.2 - enhanced-resolve: ^5.17.1 - es-module-lexer: ^1.2.1 + enhanced-resolve: ^5.17.4 + es-module-lexer: ^2.0.0 eslint-scope: 5.1.1 events: ^3.2.0 glob-to-regexp: ^0.4.1 graceful-fs: ^4.2.11 json-parse-even-better-errors: ^2.3.1 - loader-runner: ^4.2.0 + loader-runner: ^4.3.1 mime-types: ^2.1.27 neo-async: ^2.6.2 - schema-utils: ^3.2.0 - tapable: ^2.1.1 - terser-webpack-plugin: ^5.3.10 - watchpack: ^2.4.1 - webpack-sources: ^3.2.3 + schema-utils: ^4.3.3 + tapable: ^2.3.0 + terser-webpack-plugin: ^5.3.16 + watchpack: ^2.4.4 + webpack-sources: ^3.3.3 peerDependenciesMeta: webpack-cli: optional: true bin: webpack: bin/webpack.js - checksum: 6a3d667be304a69cd6dcb8d676bc29f47642c0d389af514cfcd646eaaa809961bc6989fc4b2621a717dfc461130f29c6e20006d62a32e012dafaa9517813a4e6 + checksum: 4d187c246da5c03215a9a583682d1b8972fa0c5a446ba479d63507fe2d844dacf88a46ff7f3133dba22f07f1482f866b14e84c509c0f371ae7ad9316cad83fcb languageName: node linkType: hard @@ -23476,10 +23713,19 @@ __metadata: languageName: node linkType: hard +"whatwg-encoding@npm:^3.1.1": + version: 3.1.1 + resolution: "whatwg-encoding@npm:3.1.1" + dependencies: + iconv-lite: 0.6.3 + checksum: f75a61422421d991e4aec775645705beaf99a16a88294d68404866f65e92441698a4f5b9fa11dd609017b132d7b286c3c1534e2de5b3e800333856325b549e3c + languageName: node + linkType: hard + "whatwg-fetch@npm:>=0.10.0": - version: 3.6.2 - resolution: "whatwg-fetch@npm:3.6.2" - checksum: ee976b7249e7791edb0d0a62cd806b29006ad7ec3a3d89145921ad8c00a3a67e4be8f3fb3ec6bc7b58498724fd568d11aeeeea1f7827e7e1e5eae6c8a275afed + version: 3.6.20 + resolution: "whatwg-fetch@npm:3.6.20" + checksum: c58851ea2c4efe5c2235f13450f426824cf0253c1d45da28f45900290ae602a20aff2ab43346f16ec58917d5562e159cd691efa368354b2e82918c2146a519c5 languageName: node linkType: hard @@ -23497,6 +23743,13 @@ __metadata: languageName: node linkType: hard +"whatwg-mimetype@npm:^4.0.0": + version: 4.0.0 + resolution: "whatwg-mimetype@npm:4.0.0" + checksum: f97edd4b4ee7e46a379f3fb0e745de29fe8b839307cc774300fd49059fcdd560d38cb8fe21eae5575b8f39b022f23477cc66e40b0355c2851ce84760339cef30 + languageName: node + linkType: hard + "whatwg-url@npm:^11.0.0": version: 11.0.0 resolution: "whatwg-url@npm:11.0.0" @@ -23539,39 +23792,60 @@ __metadata: languageName: node linkType: hard -"which-boxed-primitive@npm:^1.0.2": - version: 1.0.2 - resolution: "which-boxed-primitive@npm:1.0.2" +"which-boxed-primitive@npm:^1.0.2, which-boxed-primitive@npm:^1.1.0, which-boxed-primitive@npm:^1.1.1": + version: 1.1.1 + resolution: "which-boxed-primitive@npm:1.1.1" dependencies: - is-bigint: ^1.0.1 - is-boolean-object: ^1.1.0 - is-number-object: ^1.0.4 - is-string: ^1.0.5 - is-symbol: ^1.0.3 - checksum: 53ce774c7379071729533922adcca47220228405e1895f26673bbd71bdf7fb09bee38c1d6399395927c6289476b5ae0629863427fd151491b71c4b6cb04f3a5e + is-bigint: ^1.1.0 + is-boolean-object: ^1.2.1 + is-number-object: ^1.1.1 + is-string: ^1.1.1 + is-symbol: ^1.1.1 + checksum: ee41d0260e4fd39551ad77700c7047d3d281ec03d356f5e5c8393fe160ba0db53ef446ff547d05f76ffabfd8ad9df7c9a827e12d4cccdbc8fccf9239ff8ac21e languageName: node linkType: hard -"which-collection@npm:^1.0.1": - version: 1.0.1 - resolution: "which-collection@npm:1.0.1" +"which-builtin-type@npm:^1.2.1": + version: 1.2.1 + resolution: "which-builtin-type@npm:1.2.1" + dependencies: + call-bound: ^1.0.2 + function.prototype.name: ^1.1.6 + has-tostringtag: ^1.0.2 + is-async-function: ^2.0.0 + is-date-object: ^1.1.0 + is-finalizationregistry: ^1.1.0 + is-generator-function: ^1.0.10 + is-regex: ^1.2.1 + is-weakref: ^1.0.2 + isarray: ^2.0.5 + which-boxed-primitive: ^1.1.0 + which-collection: ^1.0.2 + which-typed-array: ^1.1.16 + checksum: 7a3617ba0e7cafb795f74db418df889867d12bce39a477f3ee29c6092aa64d396955bf2a64eae3726d8578440e26777695544057b373c45a8bcf5fbe920bf633 + languageName: node + linkType: hard + +"which-collection@npm:^1.0.1, which-collection@npm:^1.0.2": + version: 1.0.2 + resolution: "which-collection@npm:1.0.2" dependencies: - is-map: ^2.0.1 - is-set: ^2.0.1 - is-weakmap: ^2.0.1 - is-weakset: ^2.0.1 - checksum: c815bbd163107ef9cb84f135e6f34453eaf4cca994e7ba85ddb0d27cea724c623fae2a473ceccfd5549c53cc65a5d82692de418166df3f858e1e5dc60818581c + is-map: ^2.0.3 + is-set: ^2.0.3 + is-weakmap: ^2.0.2 + is-weakset: ^2.0.3 + checksum: c51821a331624c8197916598a738fc5aeb9a857f1e00d89f5e4c03dc7c60b4032822b8ec5696d28268bb83326456a8b8216344fb84270d18ff1d7628051879d9 languageName: node linkType: hard "which-module@npm:^2.0.0": - version: 2.0.0 - resolution: "which-module@npm:2.0.0" - checksum: 809f7fd3dfcb2cdbe0180b60d68100c88785084f8f9492b0998c051d7a8efe56784492609d3f09ac161635b78ea29219eb1418a98c15ce87d085bce905705c9c + version: 2.0.1 + resolution: "which-module@npm:2.0.1" + checksum: 1967b7ce17a2485544a4fdd9063599f0f773959cca24176dbe8f405e55472d748b7c549cd7920ff6abb8f1ab7db0b0f1b36de1a21c57a8ff741f4f1e792c52be languageName: node linkType: hard -"which-typed-array@npm:^1.1.16": +"which-typed-array@npm:^1.1.13, which-typed-array@npm:^1.1.16, which-typed-array@npm:^1.1.19": version: 1.1.19 resolution: "which-typed-array@npm:1.1.19" dependencies: @@ -23586,20 +23860,6 @@ __metadata: languageName: node linkType: hard -"which-typed-array@npm:^1.1.8": - version: 1.1.9 - resolution: "which-typed-array@npm:1.1.9" - dependencies: - available-typed-arrays: ^1.0.5 - call-bind: ^1.0.2 - for-each: ^0.3.3 - gopd: ^1.0.1 - has-tostringtag: ^1.0.0 - is-typed-array: ^1.1.10 - checksum: fe0178ca44c57699ca2c0e657b64eaa8d2db2372a4e2851184f568f98c478ae3dc3fdb5f7e46c384487046b0cf9e23241423242b277e03e8ba3dabc7c84c98ef - languageName: node - linkType: hard - "which@npm:^1.2.14, which@npm:^1.2.9, which@npm:^1.3.1": version: 1.3.1 resolution: "which@npm:1.3.1" @@ -23611,7 +23871,7 @@ __metadata: languageName: node linkType: hard -"which@npm:^2.0.1, which@npm:^2.0.2, which@npm:~2.0.2": +"which@npm:^2.0.1, which@npm:~2.0.2": version: 2.0.2 resolution: "which@npm:2.0.2" dependencies: @@ -23633,12 +23893,14 @@ __metadata: languageName: node linkType: hard -"wide-align@npm:^1.1.5": - version: 1.1.5 - resolution: "wide-align@npm:1.1.5" +"which@npm:^6.0.0": + version: 6.0.0 + resolution: "which@npm:6.0.0" dependencies: - string-width: ^1.0.2 || 2 || 3 || 4 - checksum: d5fc37cd561f9daee3c80e03b92ed3e84d80dde3365a8767263d03dacfc8fa06b065ffe1df00d8c2a09f731482fcacae745abfbb478d4af36d0a891fad4834d3 + isexe: ^3.1.1 + bin: + node-which: bin/which.js + checksum: df19b2cd8aac94b333fa29b42e8e371a21e634a742a3b156716f7752a5afe1d73fb5d8bce9b89326f453d96879e8fe626eb421e0117eb1a3ce9fd8c97f6b7db9 languageName: node linkType: hard @@ -23652,13 +23914,13 @@ __metadata: linkType: hard "wildcard@npm:^2.0.0": - version: 2.0.0 - resolution: "wildcard@npm:2.0.0" - checksum: 1f4fe4c03dfc492777c60f795bbba597ac78794f1b650d68f398fbee9adb765367c516ebd4220889b6a81e9626e7228bbe0d66237abb311573c2ee1f4902a5ad + version: 2.0.1 + resolution: "wildcard@npm:2.0.1" + checksum: e0c60a12a219e4b12065d1199802d81c27b841ed6ad6d9d28240980c73ceec6f856771d575af367cbec2982d9ae7838759168b551776577f155044f5a5ba843c languageName: node linkType: hard -"word-wrap@npm:^1.2.3, word-wrap@npm:~1.2.3": +"word-wrap@npm:^1.2.5, word-wrap@npm:~1.2.3": version: 1.2.5 resolution: "word-wrap@npm:1.2.5" checksum: f93ba3586fc181f94afdaff3a6fef27920b4b6d9eaefed0f428f8e07adea2a7f54a5f2830ce59406c8416f033f86902b91eb824072354645eea687dff3691ccb @@ -23733,18 +23995,18 @@ __metadata: languageName: node linkType: hard -"ws@npm:^8.9.0": - version: 8.11.0 - resolution: "ws@npm:8.11.0" +"ws@npm:^8.11.0": + version: 8.19.0 + resolution: "ws@npm:8.19.0" peerDependencies: bufferutil: ^4.0.1 - utf-8-validate: ^5.0.2 + utf-8-validate: ">=5.0.2" peerDependenciesMeta: bufferutil: optional: true utf-8-validate: optional: true - checksum: 316b33aba32f317cd217df66dbfc5b281a2f09ff36815de222bc859e3424d83766d9eb2bd4d667de658b6ab7be151f258318fb1da812416b30be13103e5b5c67 + checksum: 7a426122c373e053a65a2affbcdcdbf8f643ba0265577afd4e08595397ca244c05de81570300711e2363a9dab5aea3ae644b445bc7468b1ebbb51bfe2efb20e1 languageName: node linkType: hard @@ -23810,13 +24072,13 @@ __metadata: languageName: node linkType: hard -"xml2js@npm:^0.4.5": - version: 0.4.23 - resolution: "xml2js@npm:0.4.23" +"xml2js@npm:^0.5.0": + version: 0.5.0 + resolution: "xml2js@npm:0.5.0" dependencies: sax: ">=0.6.0" xmlbuilder: ~11.0.0 - checksum: ca0cf2dfbf6deeaae878a891c8fbc0db6fd04398087084edf143cdc83d0509ad0fe199b890f62f39c4415cf60268a27a6aed0d343f0658f8779bd7add690fa98 + checksum: 1aa71d62e5bc2d89138e3929b9ea46459157727759cbc62ef99484b778641c0cd21fb637696c052d901a22f82d092a3e740a16b4ce218e81ac59b933535124ea languageName: node linkType: hard @@ -23842,14 +24104,14 @@ __metadata: linkType: hard "xss@npm:^1.0.6": - version: 1.0.14 - resolution: "xss@npm:1.0.14" + version: 1.0.15 + resolution: "xss@npm:1.0.15" dependencies: commander: ^2.20.3 cssfilter: 0.0.10 bin: xss: bin/xss - checksum: 77c6a60a5f96490098ef837c3b49321c0f31963f323c748cb0a01bc02fc6e465a6accbe4c54cad62f8d6ffe647d984be173879433af861883f6213d9416d3f53 + checksum: dee066ba0962105475f12ae39fecf4cd6108cb980aefad67578a349d521e6059e184c2d63695a99d58483a02f0c0d48a36816d95c0a0beb56fba60ed53ccd824 languageName: node linkType: hard @@ -23895,6 +24157,13 @@ __metadata: languageName: node linkType: hard +"yallist@npm:^3.0.2": + version: 3.1.1 + resolution: "yallist@npm:3.1.1" + checksum: 48f7bb00dc19fc635a13a39fe547f527b10c9290e7b3e836b9a8f1ca04d4d342e85714416b3c2ab74949c9c66f9cebb0473e6bc353b79035356103b47641285d + languageName: node + linkType: hard + "yallist@npm:^4.0.0": version: 4.0.0 resolution: "yallist@npm:4.0.0" @@ -23902,6 +24171,13 @@ __metadata: languageName: node linkType: hard +"yallist@npm:^5.0.0": + version: 5.0.0 + resolution: "yallist@npm:5.0.0" + checksum: eba51182400b9f35b017daa7f419f434424410691bbc5de4f4240cc830fdef906b504424992700dc047f16b4d99100a6f8b8b11175c193f38008e9c96322b6a5 + languageName: node + linkType: hard + "yaml-ast-parser@npm:0.0.43": version: 0.0.43 resolution: "yaml-ast-parser@npm:0.0.43" @@ -23934,11 +24210,11 @@ __metadata: linkType: hard "yaml@npm:^2.0.0": - version: 2.4.5 - resolution: "yaml@npm:2.4.5" + version: 2.8.2 + resolution: "yaml@npm:2.8.2" bin: yaml: bin.mjs - checksum: f8efd407c07e095f00f3031108c9960b2b12971d10162b1ec19007200f6c987d2e28f73283f4731119aa610f177a3ea03d4a8fcf640600a25de1b74d00c69b3d + checksum: 5ffd9f23bc7a450129cbd49dcf91418988f154ede10c83fd28ab293661ac2783c05da19a28d76a22cbd77828eae25d4bd7453f9a9fe2d287d085d72db46fd105 languageName: node linkType: hard @@ -23979,8 +24255,8 @@ __metadata: linkType: hard "yargs@npm:^17.0.1, yargs@npm:^17.3.1": - version: 17.6.2 - resolution: "yargs@npm:17.6.2" + version: 17.7.2 + resolution: "yargs@npm:17.7.2" dependencies: cliui: ^8.0.1 escalade: ^3.1.1 @@ -23989,7 +24265,7 @@ __metadata: string-width: ^4.2.3 y18n: ^5.0.5 yargs-parser: ^21.1.1 - checksum: 47da1b0d854fa16d45a3ded57b716b013b2179022352a5f7467409da5a04a1eef5b3b3d97a2dfc13e8bbe5f2ffc0afe3bc6a4a72f8254e60f5a4bd7947138643 + checksum: 73b572e863aa4a8cbef323dd911d79d193b772defd5a51aab0aca2d446655216f5002c42c5306033968193bdbf892a7a4c110b0d77954a7fdf563e653967b56a languageName: node linkType: hard @@ -24008,9 +24284,9 @@ __metadata: linkType: hard "yocto-queue@npm:^1.0.0": - version: 1.0.0 - resolution: "yocto-queue@npm:1.0.0" - checksum: 2cac84540f65c64ccc1683c267edce396b26b1e931aa429660aefac8fbe0188167b7aee815a3c22fa59a28a58d898d1a2b1825048f834d8d629f4c2a5d443801 + version: 1.2.2 + resolution: "yocto-queue@npm:1.2.2" + checksum: 92dd9880c324dbc94ff4b677b7d350ba8d835619062b7102f577add7a59ab4d87f40edc5a03d77d369dfa9d11175b1b2ec4a06a6f8a5d8ce5d1306713f66ee41 languageName: node linkType: hard @@ -24044,8 +24320,8 @@ __metadata: linkType: hard "zwitch@npm:^2.0.0": - version: 2.0.2 - resolution: "zwitch@npm:2.0.2" - checksum: 8edd7af8375f12f64d8dbef815af32cd77bd9237d0b013210ba4e3aef25fdc460fe264cd0a19deabe9f86ef0c607240ebac1a336bf4a70bf06ef53e0652de116 + version: 2.0.4 + resolution: "zwitch@npm:2.0.4" + checksum: f22ec5fc2d5f02c423c93d35cdfa83573a3a3bd98c66b927c368ea4d0e7252a500df2a90a6b45522be536a96a73404393c958e945fdba95e6832c200791702b6 languageName: node linkType: hard